Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AccessException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the Notify* methods in MetadataProvider if the supplied User is not recognized or a functionality is not implemented for this User.
- AccessException(String) - Constructor for exception com.lightstreamer.adapters.remote.AccessException
-
Constructs an AccessException with a supplied error message text.
- ADD_COMMAND - Static variable in class com.lightstreamer.adapters.remote.DataProviderConstants
-
Constant that can be used as the "ADD" value for the "command" fields of Items to be processed in COMMAND mode.
- Apple - Static variable in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Refers to Push Notifications for Apple platforms, such as iOS, macOS and tvOS.
C
- clearSnapshot(String) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Called by a Data Adapter to signal to Lightstreamer Kernel that the current Snapshot of the Item has suddenly become empty.
- close() - Method in class com.lightstreamer.adapters.remote.Server
-
Stops the management of the Remote Adapter and destroys the threads used by this Server.
- com.lightstreamer.adapters.remote - package com.lightstreamer.adapters.remote
- com.lightstreamer.adapters.remote.metadata - package com.lightstreamer.adapters.remote.metadata
- COMMAND - Static variable in class com.lightstreamer.adapters.remote.Mode
-
The COMMAND Mode.
- COMMAND_FIELD - Static variable in class com.lightstreamer.adapters.remote.DataProviderConstants
-
Constant that can be used as field name for the "command" field in Items to be processed in COMMAND mode.
- ConflictingSessionException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the notifyNewSession method of MetadataProvider if a User is not enabled to open a new Session but he would be enabled as soon as another Session were closed.
- ConflictingSessionException(int, String, String, String) - Constructor for exception com.lightstreamer.adapters.remote.ConflictingSessionException
-
Constructs a ConflictingSessionException with supplied error code and message text that will be forwarded to the Client in case the Server can't solve the issue by closing the conflicting session.
- CreditsException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the notify* methods in MetadataProvider if some functionality cannot be allowed to the supplied User.
- CreditsException(int, String) - Constructor for exception com.lightstreamer.adapters.remote.CreditsException
-
Constructs a CreditsException with supplied error code and message text.
- CreditsException(int, String, String) - Constructor for exception com.lightstreamer.adapters.remote.CreditsException
-
Constructs a CreditsException with supplied error code and message text to be forwarded to the Client.
D
- DataException - Exception in com.lightstreamer.adapters.remote
-
Base class for all exceptions directly thrown by the Data Adapter.
- DataProvider - Interface in com.lightstreamer.adapters.remote
-
Provides an interface to be implemented by a Remote Data Adapter in order to attach a Data Provider to Lightstreamer.
- DataProviderConstants - Class in com.lightstreamer.adapters.remote
-
Contains constants for the special field names and field values recognized by the Server.
- DataProviderConstants() - Constructor for class com.lightstreamer.adapters.remote.DataProviderConstants
- DataProviderException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the init method in DataProvider if there is some problem that prevents the correct behavior of the Data Adapter.
- DataProviderException(String) - Constructor for exception com.lightstreamer.adapters.remote.DataProviderException
-
Constructs a DataProviderException with a supplied error message text.
- DataProviderServer - Class in com.lightstreamer.adapters.remote
-
A Remote Server object which can run a Remote Data Adapter and connect it to a Proxy Data Adapter running on Lightstreamer Server.
- DataProviderServer() - Constructor for class com.lightstreamer.adapters.remote.DataProviderServer
-
Creates an empty server still to be configured and started.
- declareFieldDiffOrder(String, Map<String, DiffAlgorithm[]>) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Called by a Data Adapter to send to Lightstreamer kernel Field "diff" support information in relation to a specific subscribed Item.
- DELETE_COMMAND - Static variable in class com.lightstreamer.adapters.remote.DataProviderConstants
-
Constant that can be used as the "DELETE" value for the "command" fields of Items to be processed in COMMAND mode.
- DIFF_MATCH_PATCH - Enum constant in enum class com.lightstreamer.adapters.remote.DiffAlgorithm
-
Computes the difference between two values with Google's "diff-match-patch" algorithm (the result is then serialized with the custom "TLCP-diff" format).
- DiffAlgorithm - Enum Class in com.lightstreamer.adapters.remote
-
Enumerative class that lists the available "diff" algorithms that can be specified in
ItemEventListener.declareFieldDiffOrder(java.lang.String, java.util.Map<java.lang.String, com.lightstreamer.adapters.remote.DiffAlgorithm[]>)
. - DISTINCT - Static variable in class com.lightstreamer.adapters.remote.Mode
-
The DISTINCT Mode.
E
- enableTableUnsubscription(String, TableInfo[]) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by the Remote Server to know whether the Metadata Adapter wants to have the possibility to force the unsubscription (through
MetadataControlListener.forceUnsubscription(String, TableInfo)
) of some Tables (i.e.: Subscriptions) just being subscribed. - endOfSnapshot(String) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Called by a Data Adapter to signal to Lightstreamer Kernel that no more Item Event belonging to the Snapshot are expected for an Item.
- equals(Object) - Method in class com.lightstreamer.adapters.remote.Mode
-
Method Equals.
- equals(Object) - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Indicates whether some other object is "equal to" this one.
- ExceptionHandler - Interface in com.lightstreamer.adapters.remote
-
Interface to be implemented in order to provide a Remote Server instance with a custom handler for error conditions occurring on the Remote Server.
F
- failure(Exception) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Called by a Data Adapter to notify Lightstreamer Kernel of the occurrence of a severe problem that can compromise future operation of the Data Adapter.
- failure(Exception) - Method in interface com.lightstreamer.adapters.remote.MetadataControlListener
-
Called by a Remote Metadata Adapter to notify Lightstreamer Kernel of the occurrence of a severe problem that can compromise future operation of the Metadata Adapter.
- FailureException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the subscribe and unsubscribe methods in DataProvider if the method execution has caused a severe problem that can compromise future operation of the Data Adapter.
- FailureException(String) - Constructor for exception com.lightstreamer.adapters.remote.FailureException
-
Constructs a FailureException with a supplied error message text.
- forceSessionTermination(String) - Method in interface com.lightstreamer.adapters.remote.MetadataControlListener
-
Enforces the termination of the specified session.
- forceSessionTermination(String, int, String) - Method in interface com.lightstreamer.adapters.remote.MetadataControlListener
-
Enforces the termination of the specified session.
- forceUnsubscription(String, TableInfo) - Method in interface com.lightstreamer.adapters.remote.MetadataControlListener
-
Enforces the unsubscription of a Table (i.e.: Subscription).
G
- getAdapter() - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Gets the configured Data Adapter that is running or will run.
- getAdapter() - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Gets the configured Metadata Adapter that is running or will run.
- getAdapterConfig() - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Gets the pathname of an optional configuration file for the Remote Data Adapter, to be passed to the init method.
- getAdapterConfig() - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Gets the pathname of an optional configuration file for the Remote Metadata Adapter, to be passed to the init method.
- getAdapterParams() - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Gets the Map object to be passed to the init method of the Remote Data Adapter, to supply optional parameters.
- getAdapterParams() - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Gets the Map object to be passed to the init method of the Remote Metadata Adapter, to supply optional parameters.
- getAllowedBufferSize(String, String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Returns the size of the buffer internally used to enqueue subsequent ItemUpdates for the same Item.
- getAllowedBufferSize(String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the maximum size allowed for the buffer internally used to enqueue subsequent ItemUpdates for the same Item.
- getAllowedBufferSize(String, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the maximum allowed size of the buffer internally used to enqueue subsequent ItemUpdates for the same Item.
- getAllowedMaxBandwidth(String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Returns the bandwidth level to be allowed to a User for a push Session.
- getAllowedMaxBandwidth(String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the bandwidth level to be allowed to a User for a push Session.
- getAllowedMaxBandwidth(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the bandwidth amount to be allowed to a User for a push Session.
- getAllowedMaxItemFrequency(String, String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Returns the ItemUpdate frequency to be allowed to a User for a specific Item.
- getAllowedMaxItemFrequency(String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the ItemUpdate frequency to be allowed to a User for a specific Item.
- getAllowedMaxItemFrequency(String, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the ItemUpdate frequency to be allowed to a User for a specific Item.
- getApplicationId() - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Returns the application ID, also known as the package name or bundle ID on some platforms.
- getClientErrorCode() - Method in exception com.lightstreamer.adapters.remote.CreditsException
-
Gets the error code to be forwarded to the client.
- getClientErrorMsg() - Method in exception com.lightstreamer.adapters.remote.CreditsException
-
Gets the error detail message to be forwarded to the client.
- getConflictingSessionID() - Method in exception com.lightstreamer.adapters.remote.ConflictingSessionException
-
Gets the ID of a Session that can be closed in order to eliminate the problem reported in this exception.
- getDataAdapter() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Returns the name of the Data Adapter to which the Table (i.e.: Subscription) refers.
- getDevice() - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Gets the MPN device of this subscription.
- getDeviceToken() - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Returns the token of the device, also know as the registration ID on some platforms.
- getDistinctSnapshotLength(String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Returns the maximum allowed length for a Snapshot of any Item that has been requested with publishing Mode DISTINCT.
- getDistinctSnapshotLength(String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the maximum allowed length for a Snapshot of an Item that has been requested with publishing Mode DISTINCT.
- getDistinctSnapshotLength(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the maximum allowed length for a Snapshot of an Item that has been requested with publishing Mode DISTINCT.
- getExceptionHandler() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the handler for error conditions occurring on the Remote Server.
- getId() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the name of the Item Group (or specification of the Item List) to which the subscribed Items belong.
- getIndex(String) - Method in interface com.lightstreamer.adapters.remote.IndexedItemEvent
-
Deprecated.Returns the index of a named Field.
- getItems(String, String, String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Resolves an Item List specification supplied in a Request.
- getItems(String, String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to resolve an Item Group name (or Item List specification) supplied in a Request.
- getMax() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the index of the last Item in the Group to be considered in the Table (i.e.: Subscription).
- getMaximumIndex() - Method in interface com.lightstreamer.adapters.remote.IndexedItemEvent
-
Deprecated.Returns the maximum index for the fields in the event.
- getMin() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the index of the first Item in the Group to be considered in the Table (i.e.: Subscription).
- getMinSourceFrequency(String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the minimum ItemEvent frequency from the Data Adapter at which the events for an Item are guaranteed to be delivered to the Clients without loss of information.
- getMinSourceFrequency(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the minimum ItemEvent frequency from the supplier Data Adapter at which the events for an Item are guaranteed to be delivered to the Clients without loss of information.
- getMode() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the publishing Mode for the Items in the Table (i.e.: Subscription) (it must be the same across all the Table).
- getName() - Method in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Returns the internal name of the platform type.
- getName() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the name, used for logging purposes, associated to the Server instance.
- getName(int) - Method in interface com.lightstreamer.adapters.remote.IndexedItemEvent
-
Deprecated.Returns the name of a Field whose index is supplied.
- getNames() - Method in interface com.lightstreamer.adapters.remote.ItemEvent
-
Deprecated.Returns an Iterator to browse the names of the supplied Fields, expressed as String.
- getNotificationFormat() - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Returns the descriptor of the push notifications format of this subscription.
- getNotifyStream() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the stream used by the Remote Adapter in order to send asyncronous data to the Remote Adapter.
- getRemotePassword() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the password credential to be sent to the Proxy Adapter upon connection.
The default value is null. - getRemoteUser() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the user-name credential to be sent to the Proxy Adapter upon connection.
The default value is null. - getReplyStream() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the stream used by the Remote Adapter in order to forward the answers to the Proxy Adapter.
- getRequestStream() - Method in class com.lightstreamer.adapters.remote.Server
-
Gets the stream used by the Proxy Adapter in order to forward the requests to the Remote Adapter.
- getSchema() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the name of the Field Schema (or specification of the Field List) used for the subscribed Items.
- getSchema(String, String, String, String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Resolves a Field List specification supplied in a Request.
- getSchema(String, String, String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to resolve a Field Schema name (or Field List specification) supplied in a Request.
- getSelector() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the name of the optional Selector associated to the Table (i.e.: Subscription).
- getSessionTimeToLive(String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for an optional time-to-live setting for a session just started.
- getSubscribedItems() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Returns the array of the Item names involved in this Table (i.e.: Subscription).
- getSubscriptionStatistics() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Returns an array that contains the statistics related with the activity of all items involved in this Table (i.e.: Subscription).
- getTotFiltered() - Method in class com.lightstreamer.adapters.remote.SubscriptionStatistics
-
Returns the number of updates that were not sent to the client, but filtered out according to the filtering rules, throughout the life of a subscription.
- getTotLost() - Method in class com.lightstreamer.adapters.remote.SubscriptionStatistics
-
Returns the number of updates that had to be sent the client, but weren't, throughout the life of a subscription.
- getTotRealTime() - Method in class com.lightstreamer.adapters.remote.SubscriptionStatistics
-
Returns the number of real-time updates sent to the client throughout the life of a subscription.
- getTrigger() - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Returns the optional expression that triggers the delivery of push notification.
- getType() - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Returns the platform type of the device.
- getValue(int) - Method in interface com.lightstreamer.adapters.remote.IndexedItemEvent
-
Deprecated.Returns the value of a field whose index is supplied (null is a legal value too).
- getValue(String) - Method in interface com.lightstreamer.adapters.remote.ItemEvent
-
Deprecated.Returns the value of a named Field (null is a legal value too).
- getWinIndex() - Method in class com.lightstreamer.adapters.remote.TableInfo
-
Gets the unique identifier of the client subscription request within the session.
- Google - Static variable in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Refers to Push Notifications for Google platforms, such as Android and Chrome.
H
- handleException(RemotingException) - Method in interface com.lightstreamer.adapters.remote.ExceptionHandler
-
Called by the Remote Server upon an unexpected error.
- handleIOException(IOException) - Method in interface com.lightstreamer.adapters.remote.ExceptionHandler
-
Called by the Remote Server upon a read or write operation failure.
- hashCode() - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Returns a hash code value for the object.
- hashCode() - Method in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Returns a hash code value for the object.
- hashCode() - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Returns a hash code value for the object.
I
- IndexedItemEvent - Interface in com.lightstreamer.adapters.remote
-
Deprecated.
- init(Map<String, String>, String) - Method in interface com.lightstreamer.adapters.remote.DataProvider
-
Called by the Remote Server to provide initialization information to the Data Adapter.
- init(Map<String, String>, String) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Reads configuration settings for user and resource constraints.
- init(Map<String, String>, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to provide initialization information to the Metadata Adapter.
- init(Map<String, String>, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
No-op initialization.
- isModeAllowed(String, String, Mode) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the allowance of a publishing Mode for an Item.
- isModeAllowed(String, String, Mode) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the allowance of a publishing Mode for an Item.
- isSnapshotAvailable(String) - Method in interface com.lightstreamer.adapters.remote.DataProvider
-
Called by Lightstreamer Kernel through the Remote Server to know whether the Data Adapter, after a subscription for an Item, will send some Snapshot Item Events before sending the updates.
- ItemEvent - Interface in com.lightstreamer.adapters.remote
-
Deprecated.The class is deprecated. Use a Map and
ItemEventListener.update(String, java.util.Map, boolean)
to supply field values. - ItemEventListener - Interface in com.lightstreamer.adapters.remote
-
Used by Lightstreamer to receive the update events and other kinds of events related with the Item subscription lifecycle.
- ItemsException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the getItems and getSchema methods in MetadataProvider if the supplied Item Group name (or Item List specification) is not recognized or cannot be resolved.
- ItemsException(String) - Constructor for exception com.lightstreamer.adapters.remote.ItemsException
-
Constructs an ItemsException with a supplied error message text.
J
- JSONPATCH - Enum constant in enum class com.lightstreamer.adapters.remote.DiffAlgorithm
-
Computes the difference between two values that are valid JSON string representations in JSON Patch format.
K
- KEY_FIELD - Static variable in class com.lightstreamer.adapters.remote.DataProviderConstants
-
Constant that can be used as field name for the "key" field in Items to be processed in COMMAND mode.
L
- LiteralBasedProvider - Class in com.lightstreamer.adapters.remote.metadata
-
Simple full implementation of a Metadata Adapter, made available in Lightstreamer SDK.
- LiteralBasedProvider() - Constructor for class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Void constructor required by the Remote Server.
M
- MERGE - Static variable in class com.lightstreamer.adapters.remote.Mode
-
The MERGE Mode.
- MetadataControlListener - Interface in com.lightstreamer.adapters.remote
-
Used by Lightstreamer to receive requests about sessions and any asynchronous severe error notification from the Remote Metadata Adapter.
- MetadataException - Exception in com.lightstreamer.adapters.remote
-
Base class for all exceptions directly thrown by the Metadata Adapter.
- MetadataProvider - Interface in com.lightstreamer.adapters.remote
-
Provides an interface to be implemented by a Remote Metadata Adapter in order to attach a Metadata Provider to Lightstreamer.
- MetadataProviderAdapter - Class in com.lightstreamer.adapters.remote
-
Provides a default implementation of all the MetadataProvider interface methods.
- MetadataProviderAdapter() - Constructor for class com.lightstreamer.adapters.remote.MetadataProviderAdapter
- MetadataProviderException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the init method in MetadataProvider if there is some problem that prevents the correct behavior of the Metadata Adapter.
- MetadataProviderException(String) - Constructor for exception com.lightstreamer.adapters.remote.MetadataProviderException
-
Constructs a MetadataProviderException with a supplied error message text.
- MetadataProviderServer - Class in com.lightstreamer.adapters.remote
-
A Remote Server object which can run a Remote Metadata Adapter and connect it to a Proxy Metadata Adapter running on Lightstreamer Server.
- MetadataProviderServer() - Constructor for class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Creates an empty server still to be configured and started.
- Mode - Class in com.lightstreamer.adapters.remote
-
Encapsulates a publishing Mode.
- modeMayBeAllowed(String, Mode) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to ask for the allowance of a publishing Mode for an Item (for at least one User).
- modeMayBeAllowed(String, Mode) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to ask for the allowance of a publishing Mode for an Item (for at least one User).
- MpnDeviceInfo - Class in com.lightstreamer.adapters.remote
-
Specifies a target device for Push Notifications, used with MPN-related requests for the
MetadataProvider
. - MpnDeviceInfo(MpnPlatformType, String, String) - Constructor for class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Used by Lightstreamer to provide a MpnDeviceInfo instance to the MPN-related methods.
- MpnPlatformType - Class in com.lightstreamer.adapters.remote
-
Identifies a Push Notifications platform type, used with MPN-related requests of the
MetadataProvider
. - MpnPlatformType(String) - Constructor for class com.lightstreamer.adapters.remote.MpnPlatformType
-
Used by Lightstreamer to create a MpnPlatformType instance.
- MpnSubscriptionInfo - Class in com.lightstreamer.adapters.remote
-
Specifies a Push Notifications subscription, used with MPN-related requests of the
MetadataProvider
. - MpnSubscriptionInfo(MpnDeviceInfo, String, String) - Constructor for class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Used by Lightstreamer to create a MpnSubscriptionInfo instance.
N
- NotificationException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the notify* methods in MetadataProvider if there is some inconsistency in the supplied parameters.
- NotificationException(String) - Constructor for exception com.lightstreamer.adapters.remote.NotificationException
-
Constructs a NotificationException with a supplied error message text.
- notifyMpnDeviceAccess(String, String, MpnDeviceInfo) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to access the specified MPN device.
- notifyMpnDeviceAccess(String, String, MpnDeviceInfo) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to access the specified MPN device.
- notifyMpnDeviceTokenChange(String, String, MpnDeviceInfo, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to change the token of an MPN device.
- notifyMpnDeviceTokenChange(String, String, MpnDeviceInfo, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to change the token of a MPN device.
- notifyMpnSubscriptionActivation(String, String, TableInfo, MpnSubscriptionInfo) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to activate a Push Notification subscription.
- notifyMpnSubscriptionActivation(String, String, TableInfo, MpnSubscriptionInfo) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to activate a Push Notification subscription.
- notifyNewSession(String, String, Map<String, String>) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to open a new push Session.
- notifyNewSession(String, String, Map<String, String>) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to open a new push Session.
- notifyNewTables(String, String, TableInfo[]) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to add some Tables (i.e.: Subscriptions) to a push Session.
- notifyNewTables(String, String, TableInfo[]) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to check that a User is enabled to add some Tables (i.e.: Subscriptions) to a push Session.
- notifySessionClose(String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to notify the Metadata Adapter that a push Session has been closed.
- notifySessionClose(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to notify the Metadata Adapter that a push Session has been closed.
- notifyTablesClose(String, TableInfo[]) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to notify the Metadata Adapter that some Tables (i.e.: Subscriptions) have been removed from a push Session.
- notifyTablesClose(String, TableInfo[]) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to notify the Metadata Adapter that some Tables (i.e.: Subscriptions) have been removed from a push Session.
- notifyUser(String, String, Map<String, String>) - Method in class com.lightstreamer.adapters.remote.metadata.LiteralBasedProvider
-
Checks if a user is enabled to make Requests to the related Data Providers.
- notifyUser(String, String, Map<String, String>) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server as a preliminary check that a user is enabled to make Requests to the related Data Providers.
- notifyUser(String, String, Map<String, String>) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server as a preliminary check that a user is enabled to make Requests to the related Data Providers.
- notifyUser(String, String, Map<String, String>, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel, through the Remote Server, instead of calling the 3-arguments version, in case the Server has been instructed to acquire the client principal from the client TLS/SSL certificate through the <use_client_auth> configuration flag.
- notifyUser(String, String, Map<String, String>, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Extended version of the User authentication method, invoked by the Server, through the Remote Server, in case the Server has been instructed (through the <use_client_auth> configuration flag) to acquire the client principal from the client TLS/SSL certificate, if available.
- notifyUserMessage(String, String, String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to forward a message received by a User.
- notifyUserMessage(String, String, String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to forward a message received by a User.
R
- RAW - Static variable in class com.lightstreamer.adapters.remote.Mode
-
The RAW Mode.
- RemotingException - Exception in com.lightstreamer.adapters.remote
-
Issued by the Remote Server upon an unexpected error.
- RemotingException(String) - Constructor for exception com.lightstreamer.adapters.remote.RemotingException
-
Used by the Remote Server to construct a RemotingException with a supplied error message text.
- RemotingException(String, Exception) - Constructor for exception com.lightstreamer.adapters.remote.RemotingException
-
Used by the Remote Server to construct a RemotingException with a supplied error message text and cause exception.
- ResourceUnavailableException - Exception in com.lightstreamer.adapters.remote
-
Can be thrown by the
MetadataProvider.notifyUser(String, String, Map)
methods instead of a genericAccessException
if the User credentials cannot be validated because of a temporary lack of resources. - ResourceUnavailableException(String) - Constructor for exception com.lightstreamer.adapters.remote.ResourceUnavailableException
-
Constructs a ResourceUnavailableException with a supplied error message text.
S
- SchemaException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the getSchema method in MetadataProvider if the supplied Field Schema name (or Field List specification) is not recognized or cannot be resolved.
- SchemaException(String) - Constructor for exception com.lightstreamer.adapters.remote.SchemaException
-
Constructs a SchemaException with a supplied error message text.
- Server - Class in com.lightstreamer.adapters.remote
-
A generic Remote Server object, which can run a Remote Data or Metadata Adapter and connect it to the Proxy Adapter running on Lightstreamer Server.
- Server() - Constructor for class com.lightstreamer.adapters.remote.Server
- setAdapter(DataProvider) - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Sets the Remote Data Adapter instance to be run.
- setAdapter(MetadataProvider) - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Sets the Remote Metadata Adapter instance to be run.
- setAdapterConfig(String) - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Sets the pathname of an optional configuration file for the Remote Data Adapter, to be passed to the init method.
- setAdapterConfig(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Sets the pathname of an optional configuration file for the Remote Metadata Adapter, to be passed to the init method.
- setAdapterParams(Map<String, String>) - Method in class com.lightstreamer.adapters.remote.DataProviderServer
-
Sets a Map object to be passed to the init method of the Remote Data Adapter, to supply optional parameters.
- setAdapterParams(Map<String, String>) - Method in class com.lightstreamer.adapters.remote.MetadataProviderServer
-
Sets a Map object to be passed to the init method of the Remote Metadata Adapter, to supply optional parameters.
- setExceptionHandler(ExceptionHandler) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the handler for error conditions occurring on the Remote Server.
- setListener(ItemEventListener) - Method in interface com.lightstreamer.adapters.remote.DataProvider
-
Called by the Remote Server to provide a listener to receive the Item Events carrying data and asynchronous error notifications for Lightstreamer Kernel.
- setListener(MetadataControlListener) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by the Remote Server to provide a listener to receive requests about sessions and any asynchronous severe error notification.
- setLoggerProvider(LoggerProvider) - Static method in class com.lightstreamer.adapters.remote.Server
-
Static method that permits to configure the logging system used by the library.
- setName(String) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets a name for the Server instance; used for logging purposes.
- setNotifyStream(OutputStream) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the stream used by the Remote Adapter in order to send asyncronous data to the Remote Adapter.
- setRemotePassword(String) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the password credential to be sent to the Proxy Adapter upon connection.
- setRemoteUser(String) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the user-name credential to be sent to the Proxy Adapter upon connection.
- setReplyStream(OutputStream) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the stream used by the Remote Adapter in order to forward the answers to the Proxy Adapter.
- setRequestStream(InputStream) - Method in class com.lightstreamer.adapters.remote.Server
-
Sets the stream used by the Proxy Adapter in order to forward the requests to the Remote Adapter.
- start() - Method in class com.lightstreamer.adapters.remote.Server
-
Starts the communication between the Remote Adapter and the Proxy Adapter through the supplied streams.
- subscribe(String) - Method in interface com.lightstreamer.adapters.remote.DataProvider
-
Called by Lightstreamer Remote Server to request data for an Item.
- SubscriptionException - Exception in com.lightstreamer.adapters.remote
-
Thrown by the subscribe and unsubscribe methods in DataProvider if the request cannot be satisfied.
- SubscriptionException(String) - Constructor for exception com.lightstreamer.adapters.remote.SubscriptionException
-
Constructs a SubscriptionException with a supplied error message text.
- SubscriptionStatistics - Class in com.lightstreamer.adapters.remote
-
Used by Lightstreamer to provide to method
TableInfo.getSubscriptionStatistics()
value objects to report activity statistics for single subscribed items involved in a Table (i.e.: Subscription). - SubscriptionStatistics(long, long, long) - Constructor for class com.lightstreamer.adapters.remote.SubscriptionStatistics
-
Used by Lightstreamer to create a SubscriptionStatistics instance, collecting various activity statistics for a single Item.
T
- TableInfo - Class in com.lightstreamer.adapters.remote
-
Used by MetadataProvider to provide value objects to the calls to methods NotifyNewTables, NotifyTablesClose, and notifyMpnSubscriptionActivation.
- TableInfo(int, Mode, String, String, String, int, int, String, String[], SubscriptionStatistics[]) - Constructor for class com.lightstreamer.adapters.remote.TableInfo
-
Used by Lightstreamer to create a TableInfo instance, collecting the various attributes of a Table (i.e.: Subscription).
- toString() - Method in class com.lightstreamer.adapters.remote.Mode
-
Method ToString.
- toString() - Method in class com.lightstreamer.adapters.remote.MpnDeviceInfo
-
Returns a string representation of the MpnDeviceInfo.
- toString() - Method in class com.lightstreamer.adapters.remote.MpnPlatformType
-
Returns a string representation of the MpnPlatformType.
- toString() - Method in class com.lightstreamer.adapters.remote.MpnSubscriptionInfo
-
Returns a string representation of the MpnSubscriptionInfo.
U
- unsubscribe(String) - Method in interface com.lightstreamer.adapters.remote.DataProvider
-
Called by Lightstreamer Kernel through the Remote Server to end a previous request of data for an Item.
- update(String, IndexedItemEvent, boolean) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Deprecated.The method is deprecated. Use the Map version to supply field values.
- update(String, ItemEvent, boolean) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Deprecated.The method is deprecated. Use the Map version to supply field values.
- update(String, Map<String, ?>, boolean) - Method in interface com.lightstreamer.adapters.remote.ItemEventListener
-
Called by a Data Adapter to send an Item Event to Lightstreamer Kernel when the Item Event is implemented as a Map<String,?> instance.
- UPDATE_COMMAND - Static variable in class com.lightstreamer.adapters.remote.DataProviderConstants
-
Constant that can be used as the "UPDATE" value for the "command" fields of Items to be processed in COMMAND mode.
V
- valueOf(String) - Static method in enum class com.lightstreamer.adapters.remote.DiffAlgorithm
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.lightstreamer.adapters.remote.DiffAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VersionException - Exception in com.lightstreamer.adapters.remote
-
Thrown internally to refuse the ARI protocol version specified by the Proxy Adapter.
- VersionException(String) - Constructor for exception com.lightstreamer.adapters.remote.VersionException
-
Constructs a VersionException with a supplied error message text.
W
- wantsFinalTableStatistics(String, TableInfo[]) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by the Remote Server to know whether the Metadata Adapter wants to receive (in
MetadataProvider.notifyTablesClose(String, TableInfo[])
) final traffic statistics on the Items of some Tables (i.e.: Subscriptions) just being subscribed. - wantsTablesNotification(String) - Method in interface com.lightstreamer.adapters.remote.MetadataProvider
-
Called by Lightstreamer Kernel through the Remote Server to know whether the Metadata Adapter must or must not be notified any time a Table (i.e.: Subscription) is added or removed from a push Session owned by a supplied User.
- wantsTablesNotification(String) - Method in class com.lightstreamer.adapters.remote.MetadataProviderAdapter
-
Called by Lightstreamer Kernel through the Remote Server to know whether the Metadata Adapter must or must not be notified any time a Table (i.e.: Subscription) is added or removed from a push Session owned by a supplied User.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ItemEventListener.update(String, java.util.Map, boolean)
to supply field values.