Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AccessException - Exception in com.lightstreamer.interfaces.metadata
-
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.interfaces.metadata.AccessException
-
Constructs an AccessException with a supplied error message text.
- ADD_COMMAND - Static variable in interface com.lightstreamer.interfaces.data.DataProvider
-
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.interfaces.metadata.MpnPlatformType
-
Refers to Push Notifications for Apple platforms, such as iOS, macOS and tvOS.
C
- clearSnapshot(String) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to signal to Lightstreamer Kernel that the current Snapshot of an Item has suddenly become empty.
- com.lightstreamer.adapters.metadata - package com.lightstreamer.adapters.metadata
- com.lightstreamer.interfaces.data - package com.lightstreamer.interfaces.data
- com.lightstreamer.interfaces.metadata - package com.lightstreamer.interfaces.metadata
- COMMAND - Static variable in class com.lightstreamer.interfaces.metadata.Mode
-
The COMMAND Mode.
- COMMAND_FIELD - Static variable in interface com.lightstreamer.interfaces.data.DataProvider
-
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.interfaces.metadata
-
Thrown by the
MetadataProvider.notifyNewSession(String, String, Map)
method 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.interfaces.metadata.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.interfaces.metadata
-
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.interfaces.metadata.CreditsException
-
Constructs a CreditsException with supplied error code and message text.
- CreditsException(int, String, String) - Constructor for exception com.lightstreamer.interfaces.metadata.CreditsException
-
Constructs a CreditsException with supplied error code and message text to be forwarded to the Client.
- CustomizableItemEvent - Interface in com.lightstreamer.interfaces.metadata
-
Used to provide update information to the calls to the customizeUpdate method of MetadataProvider.
- customizeUpdate(String, String, CustomizableItemEvent) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Customizer implementation method.
- customizeUpdate(String, String, String, CustomizableItemEvent) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel in order to customize events pertaining to an ItemEventBuffer, if such customization has been requested through the enableUpdateCustomization method.
- customizeUpdate(String, String, String, CustomizableItemEvent) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel in order to customize events pertaining to an ItemEventBuffer, if such customization has been requested through the enableUpdateCustomization method.
D
- DataProvider - Interface in com.lightstreamer.interfaces.data
-
Provides an interface to be implemented by a Data Adapter in order to attach a Data Provider to Lightstreamer Kernel.
- DataProviderException - Exception in com.lightstreamer.interfaces.data
-
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.interfaces.data.DataProviderException
-
Constructs a DataProviderException with a supplied error message text.
- declareFieldDiffOrder(String, Map<String, DiffAlgorithm[]>) - Method in interface com.lightstreamer.interfaces.data.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 interface com.lightstreamer.interfaces.data.DataProvider
-
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.interfaces.data.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.interfaces.data
-
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.interfaces.data.DiffAlgorithm[]>)
andItemEventListener.smartDeclareFieldDiffOrder(java.lang.Object, java.util.Map<java.lang.String, com.lightstreamer.interfaces.data.DiffAlgorithm[]>)
. - DISTINCT - Static variable in class com.lightstreamer.interfaces.metadata.Mode
-
The DISTINCT Mode.
E
- enableUpdateCustomization(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Customizer authorization method.
- enableUpdateCustomization(String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to know whether the Metadata Adapter must or must not be given a chance to modify the values carried by the updates for a supplied Item in a push Session owned by a supplied User.
- enableUpdateCustomization(String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to know whether the Metadata Adapter must or must not be given a chance to modify the values carried by the updates for a supplied Item in a push Session owned by a supplied User.
- endOfSnapshot(String) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to signal to Lightstreamer Kernel that no more ItemEvent belonging to the Snapshot are expected for an Item.
- equals(Object) - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.lightstreamer.interfaces.metadata.MpnPlatformType
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Indicates whether some other object is "equal to" this one.
F
- failure(Throwable) - Method in interface com.lightstreamer.interfaces.data.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(Throwable) - Method in interface com.lightstreamer.interfaces.metadata.MetadataControlListener
-
Called by a 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.interfaces.data
-
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.interfaces.data.FailureException
-
Constructs a FailureException with a supplied error message text.
- forceSessionTermination(String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataControlListener
-
Enforces the termination of the specified session.
- forceSessionTermination(String, int, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataControlListener
-
Enforces the termination of the specified session.
- forceUnsubscription() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Enforces the unsubscription of this Table (i.e.: Subscription).
G
- getAllowedBufferSize(String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the buffer size authorization method.
- getAllowedBufferSize(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the buffer size authorization method.
- getAllowedBufferSize(String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Returns the size of the buffer internally used to enqueue subsequent ItemUpdates for the same Item.
- getAllowedBufferSize(String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the maximum size allowed for the buffer internally used to enqueue subsequent ItemUpdates for the same Item.
- getAllowedBufferSize(String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel 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.metadata.LiteralBasedProvider
-
Returns the bandwidth level to be allowed to a User for a push Session.
- getAllowedMaxBandwidth(String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the bandwidth level to be allowed to a User for a push Session.
- getAllowedMaxBandwidth(String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel 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.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the ItemUpdate frequency authorization method.
- getAllowedMaxItemFrequency(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the ItemUpdate frequency authorization method.
- getAllowedMaxItemFrequency(String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Returns the ItemUpdate frequency to be allowed to a User for a specific Item.
- getAllowedMaxItemFrequency(String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the ItemUpdate frequency to be allowed to a User for a specific Item.
- getAllowedMaxItemFrequency(String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the ItemUpdate frequency to be allowed to a User for a specific Item.
- getApplicationId() - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Returns the application ID, also known as the package name or bundle ID on some platforms.
- getClientErrorCode() - Method in exception com.lightstreamer.interfaces.metadata.CreditsException
-
Returns the error code to be forwarded to the client.
- getClientErrorMsg() - Method in exception com.lightstreamer.interfaces.metadata.CreditsException
-
Returns the error detail message to be forwarded to the client.
- getConflictingSessionID() - Method in exception com.lightstreamer.interfaces.metadata.ConflictingSessionException
-
Returns 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.interfaces.metadata.TableInfo
-
Returns the name of the Data Adapter to which the Table (i.e.: Subscription) refers.
- getDevice() - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Returns the MPN device of this subscription.
- getDeviceToken() - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Returns the token of the device, also know as the registration ID on some platforms.
- getDistinctSnapshotLength(String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Snapshot length configuration method.
- getDistinctSnapshotLength(String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Snapshot length configuration method.
- getDistinctSnapshotLength(String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Returns the maximum allowed length for a Snapshot of any Item that has been requested with publishing Mode DISTINCT.
- getDistinctSnapshotLength(String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the maximum allowed length for a Snapshot of an Item that has been requested with publishing Mode DISTINCT.
- getDistinctSnapshotLength(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the maximum allowed length for a Snapshot of an Item that has been requested with publishing Mode DISTINCT.
- getId() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns 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.interfaces.data.IndexedItemEvent
-
Returns the index of a named Field.
- getItems(String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Item List determination method.
- getItems(String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Item List determination method.
- getItems(String, String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Resolves an Item List specification supplied in a Request.
- getItems(String, String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to resolve an Item Group name (or Item List specification) supplied in a Request.
- getMax() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns the index of the last Item in the Group to be considered in the Table (i.e.: Subscription).
- getMaximumIndex() - Method in interface com.lightstreamer.interfaces.data.IndexedItemEvent
-
Returns the maximum index for the fields in the event.
- getMin() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns the index of the first Item in the Group to be considered in the Table (i.e.: Subscription).
- getMinSourceFrequency(String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Prefilter frequency configuration method.
- getMinSourceFrequency(String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Prefilter frequency configuration method.
- getMinSourceFrequency(String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Returns 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.
- getMinSourceFrequency(String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the minimum ItemEvent frequency that ensures that all subscribers of an Item can be fed with an adequate amount of information.
- getMinSourceFrequency(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the minimum ItemEvent frequency that ensures that all subscribers of an Item can be fed with an adequate amount of information.
- getMode() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns 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.interfaces.metadata.MpnPlatformType
-
Returns the internal name of the platform type.
- getName(int) - Method in interface com.lightstreamer.interfaces.data.IndexedItemEvent
-
Returns the name of a Field whose index is supplied.
- getNames() - Method in interface com.lightstreamer.interfaces.data.ItemEvent
-
Returns an iterator to browse the names of the supplied Fields, expressed as String.
- getNames() - Method in interface com.lightstreamer.interfaces.data.OldItemEvent
-
Returns an iterator to browse the names of the supplied Fields, expressed as String.
- getNotificationFormat() - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Returns the descriptor of the push notifications format of this subscription.
- getSchema() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns the name of the Field Schema (or specification of the Field List) used for the subscribed Items.
- getSchema(String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Field List determination method.
- getSchema(String, String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the Field List determination method.
- getSchema(String, String, String, String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Resolves a Field List specification supplied in a Request.
- getSchema(String, String, String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to resolve a Field Schema name (or Field List specification) supplied in a Request.
- getSelector() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns the name of the optional Selector associated to the Table (i.e.: Subscription).
- getSessionTimeToLive(String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for an optional time-to-live setting for a session just started.
- getSubscribedItems() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns the array of the Item names involved in this Table (i.e.: Subscription).
- getSubscriptionStatistics() - Method in class com.lightstreamer.interfaces.metadata.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.interfaces.metadata.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.interfaces.metadata.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.interfaces.metadata.SubscriptionStatistics
-
Returns the number of real-time updates sent to the client throughout the life of a subscription.
- getTrigger() - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Returns the optional expression that triggers the delivery of push notification.
- getType() - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Returns the platform type of the device.
- getValue(int) - Method in interface com.lightstreamer.interfaces.data.IndexedItemEvent
-
Returns the value of a field whose index is supplied (null is a legal value too).
- getValue(String) - Method in interface com.lightstreamer.interfaces.data.ItemEvent
-
Returns the value of a named Field (null is a legal value too).
- getValue(String) - Method in interface com.lightstreamer.interfaces.data.OldItemEvent
-
Returns the value of a named Field (null is a legal value too).
- getValueAsByteArray(String) - Method in interface com.lightstreamer.interfaces.metadata.ItemEvent
-
Returns the value of a named Field as a byte array (null is a legal value too).
- getValueAsString(String) - Method in interface com.lightstreamer.interfaces.metadata.ItemEvent
-
Returns the value of a named Field as a String object (null is a legal value too).
- getWinIndex() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
-
Returns a unique identifier of the client subscription request within the session.
- Google - Static variable in class com.lightstreamer.interfaces.metadata.MpnPlatformType
-
Refers to Push Notifications for Google platforms, such as Android and Chrome.
H
- hashCode() - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Returns a hash code value for the object.
- hashCode() - Method in class com.lightstreamer.interfaces.metadata.MpnPlatformType
-
Returns a hash code value for the object.
- hashCode() - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Returns a hash code value for the object.
I
- IndexedItemEvent - Interface in com.lightstreamer.interfaces.data
-
Provides to the Data Adapter an alternative interface for creating ItemEvents in order to send updates to Lightstreamer Kernel.
- init(Map, File) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reads configuration settings for user and resource constraints.
- init(Map, File) - Method in interface com.lightstreamer.interfaces.data.DataProvider
-
Called by Lightstreamer Kernel to provide initialization information to the Data Adapter.
- init(Map, File) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to provide initialization information to the Metadata Adapter.
- init(Map, File) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
No-op initialization.
- isModeAllowed(String, String, Mode) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the publishing Mode authorization method.
- isModeAllowed(String, String, String, Mode) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the allowance of a publishing Mode for an Item.
- isModeAllowed(String, String, String, Mode) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the allowance of a publishing Mode for an Item.
- isSelected(String, String, String, ItemEvent) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Selector implementation method.
- isSelected(String, String, String, String, ItemEvent) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel in order to filter events pertaining to an ItemEventBuffer, if the related Item was requested within a Table (i.e.: Subscription) with an associated Selector.
- isSelected(String, String, String, String, ItemEvent) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel in order to filter events pertaining to an ItemEventBuffer, if the related Item was requested within a Table (i.e.: Subscription) with an associated Selector.
- isSelectorAllowed(String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Selector authorization method.
- isSelectorAllowed(String, String, String, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the allowance of a Selector for an Item.
- isSelectorAllowed(String, String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the allowance of a Selector for an Item.
- isSnapshot() - Method in interface com.lightstreamer.interfaces.metadata.ItemEvent
-
Allows to distinguish between events that carry the Item initial state (the Snapshot) and events that carry state Updates.
- isSnapshotAvailable(String) - Method in interface com.lightstreamer.interfaces.data.DataProvider
-
Called by Lightstreamer Kernel to know whether the Data Adapter, after a subscription for an Item, will send some Snapshot ItemEvents before sending the updates.
- ItemEvent - Interface in com.lightstreamer.interfaces.data
-
Provides to the Data Adapter a base interface for creating ItemEvents in order to send updates to Lightstreamer Kernel.
- ItemEvent - Interface in com.lightstreamer.interfaces.metadata
-
Used to provide update information to the calls to the isSelected method of MetadataProvider.
- ItemEventListener - Interface in com.lightstreamer.interfaces.data
-
Used by Lightstreamer Kernel to receive the ItemEvents and other kinds of events related with the Item subscription lifecycle.
- ItemsException - Exception in com.lightstreamer.interfaces.metadata
-
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.interfaces.metadata.ItemsException
-
Constructs an ItemsException with a supplied error message text.
J
- JSONPATCH - Enum constant in enum class com.lightstreamer.interfaces.data.DiffAlgorithm
-
Computes the difference between two values that are valid JSON string representations in JSON Patch format.
K
- KEY_FIELD - Static variable in interface com.lightstreamer.interfaces.data.DataProvider
-
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.metadata
-
Simple full implementation of a Metadata Adapter, made available in Lightstreamer SDK.
- LiteralBasedProvider() - Constructor for class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Void constructor required by Lightstreamer Kernel.
M
- MERGE - Static variable in class com.lightstreamer.interfaces.metadata.Mode
-
The MERGE Mode.
- MetadataControlListener - Interface in com.lightstreamer.interfaces.metadata
-
Used by Lightstreamer Kernel to receive requests about sessions and any asynchronous severe error notification from the Metadata Adapter.
- MetadataProvider - Interface in com.lightstreamer.interfaces.metadata
-
Provides an interface to be implemented by a Metadata Adapter in order to attach a Metadata Provider to Lightstreamer Kernel.
- MetadataProviderAdapter - Class in com.lightstreamer.interfaces.metadata
-
Provides a default implementation of all the MetadataProvider interface methods, except for getItems and getSchema.
- MetadataProviderAdapter() - Constructor for class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
- MetadataProviderException - Exception in com.lightstreamer.interfaces.metadata
-
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.interfaces.metadata.MetadataProviderException
-
Constructs a MetadataProviderException with a supplied error message text.
- Mode - Class in com.lightstreamer.interfaces.metadata
-
Used by Lightstreamer to identify a publishing Mode.
- modeMayBeAllowed(String, Mode) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the publishing mode allowance method.
- modeMayBeAllowed(String, Mode) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the publishing Mode allowance method.
- modeMayBeAllowed(String, String, Mode) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Called by Lightstreamer Kernel to ask for the allowance of a publishing Mode for an Item.
- modeMayBeAllowed(String, String, Mode) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to ask for the allowance of a publishing Mode for an Item (for at least one User).
- modeMayBeAllowed(String, String, Mode) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to ask for the allowance of a publishing Mode for an Item (for at least one User).
- MpnDeviceInfo - Class in com.lightstreamer.interfaces.metadata
-
Specifies a target device for Push Notifications, used with MPN-related requests for the
MetadataProvider
. - MpnDeviceInfo(MpnPlatformType, String, String) - Constructor for class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Used by Lightstreamer Kernel to create an MpnDeviceInfo instance.
- MpnPlatformType - Class in com.lightstreamer.interfaces.metadata
-
Identifies a Push Notifications platform type, used with MPN-related requests of the
MetadataProvider
. - MpnPlatformType(String) - Constructor for class com.lightstreamer.interfaces.metadata.MpnPlatformType
-
Used by Lightstreamer to create an MpnPlatformType instance.
- MpnSubscriptionInfo - Class in com.lightstreamer.interfaces.metadata
-
Specifies a Push Notifications subscription, used with MPN-related requests of the
MetadataProvider
. - MpnSubscriptionInfo(MpnDeviceInfo, String, String) - Constructor for class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Used by Lightstreamer to create a MpnSubscriptionInfo instance.
N
- NotificationException - Exception in com.lightstreamer.interfaces.metadata
-
Thrown by the notify* methods in MetadataProvider if there is some inconsistency in the supplied parameters.
- NotificationException(String) - Constructor for exception com.lightstreamer.interfaces.metadata.NotificationException
-
Constructs a NotificationException with a supplied error message text.
- notifyMpnDeviceAccess(String, String, MpnDeviceInfo) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to check that a User is enabled to access the specified MPN device.
- notifyMpnDeviceAccess(String, String, MpnDeviceInfo) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to check that a User is enabled to access the specified MPN device.
- notifyMpnDeviceTokenChange(String, String, MpnDeviceInfo, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to check that a User is enabled to activate a Push Notification subscription.
- notifyMpnSubscriptionActivation(String, String, TableInfo, MpnSubscriptionInfo) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to check that a User is enabled to activate a Push Notification subscription.
- notifyNewSession(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the Session authorization method.
- notifyNewSession(String, String, Map) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to check that a User is enabled to open a new push Session.
- notifyNewSession(String, String, Map) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to check that a User is enabled to open a new push Session.
- notifyNewTables(String, String, TableInfo[]) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to notify the Metadata Adapter that a push Session has been closed.
- notifySessionClose(String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to notify the Metadata Adapter that a push Session has been closed.
- notifyTablesClose(String, TableInfo[]) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to notify the Metadata Adapter that some Tables (i.e.: Subscriptions) have been removed from a push Session.
- notifyUser(String, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Reduced, backward-compatibility version of the User authentication method.
- notifyUser(String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Reduced, backward-compatibility version of the User authentication method.
- notifyUser(String, String, Map) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Checks if a user is enabled to make Requests to the related Data Providers.
- notifyUser(String, String, Map) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel as a preliminary check that a user is enabled to make Requests to any of the related Data Providers.
- notifyUser(String, String, Map) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel as a preliminary check that a user is enabled to make Requests to the related Data Providers.
- notifyUser(String, String, Map, String) - Method in class com.lightstreamer.adapters.metadata.LiteralBasedProvider
-
Extended version of the User authentication method, invoked by the Server instead of the standard 3-argument one in case it has been instructed (through the <use_client_auth> configuration flag) to acquire the client principal from the client TLS/SSL certificate, if available.
- notifyUser(String, String, Map, String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel, 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) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Extended version of the User authentication method, invoked by the Server instead of the standard 3-argument one in case it 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.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to forward a message received by a User.
- notifyUserMessage(String, String, String) - Method in class com.lightstreamer.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel to forward a message received by a User.
O
- OldItemEvent - Interface in com.lightstreamer.interfaces.data
-
Provides to the Data Adapter a special interface for creating ItemEvents in order to send updates to Lightstreamer Kernel.
R
- RAW - Static variable in class com.lightstreamer.interfaces.metadata.Mode
-
The RAW Mode.
- ResourceUnavailableException - Exception in com.lightstreamer.interfaces.metadata
-
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
When receiving this exception, the Server will instruct the client to retry in short time. - ResourceUnavailableException(String) - Constructor for exception com.lightstreamer.interfaces.metadata.ResourceUnavailableException
-
Constructs a ResourceUnavailableException with a supplied error message text.
S
- SchemaException - Exception in com.lightstreamer.interfaces.metadata
-
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.interfaces.metadata.SchemaException
-
Constructs a SchemaException with a supplied error message text.
- setListener(ItemEventListener) - Method in interface com.lightstreamer.interfaces.data.DataProvider
-
Called by Lightstreamer Kernel to provide a listener to receive the ItemEvents carrying data and asynchronous error notifications.
- setListener(MetadataControlListener) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel to provide a listener to receive requests about sessions and any asynchronous severe error notification.
- setValueAsByteArray(String, byte[]) - Method in interface com.lightstreamer.interfaces.metadata.CustomizableItemEvent
-
Sets the value of a named Field as a byte array (null is a legal value too).
- setValueAsString(String, String) - Method in interface com.lightstreamer.interfaces.metadata.CustomizableItemEvent
-
Sets the value of a named Field as a String object (null is a legal value too).
- smartClearSnapshot(Object) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called, instead of clearSnapshot, by a Data Adapter that implements the extended interface SmartDataProvider, in all cases in which clearSnapshot can be called.
- SmartDataProvider - Interface in com.lightstreamer.interfaces.data
-
Provides an extended interface to be implemented by a Data Adapter in order to attach a Data Provider to Lightstreamer Kernel.
- smartDeclareFieldDiffOrder(Object, Map<String, DiffAlgorithm[]>) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called, instead of declareFieldDiffOrder, by a Data Adapter that implements the extended interface SmartDataProvider, in all cases in which declareFieldDiffOrder can be called.
- smartEndOfSnapshot(Object) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called, instead of endOfSnapshot, by a Data Adapter that implements the extended interface SmartDataProvider, in all cases in which endOfSnapshot can be called.
- smartUpdate(Object, IndexedItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called by a Data Adapter that implements the extended interface SmartDataProvider to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an IndexedItemEvent instance.
- smartUpdate(Object, ItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called by a Data Adapter that implements the extended interface SmartDataProvider to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an ItemEvent instance.
- smartUpdate(Object, OldItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called by a Data Adapter that implements the extended interface SmartDataProvider to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an OldItemEvent instance.
- smartUpdate(Object, Map, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Can be called by a Data Adapter that implements the extended interface SmartDataProvider to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as a java.util.Map instance.
- subscribe(String, boolean) - Method in interface com.lightstreamer.interfaces.data.DataProvider
-
Called by Lightstreamer Kernel to request data for an Item.
- subscribe(String, boolean) - Method in interface com.lightstreamer.interfaces.data.SmartDataProvider
-
Inherited by the base interface DataProvider but never called in this case, because the extended version will always be called in its place.
- subscribe(String, Object, boolean) - Method in interface com.lightstreamer.interfaces.data.SmartDataProvider
-
Called by Lightstreamer Kernel to request data for an Item.
- SubscriptionException - Exception in com.lightstreamer.interfaces.data
-
Thrown by the subscribe and unsubscribe methods in DataProvider if the request cannot be satisfied.
- SubscriptionException(String) - Constructor for exception com.lightstreamer.interfaces.data.SubscriptionException
-
Constructs a SubscriptionException with a supplied error message text.
- SubscriptionStatistics - Class in com.lightstreamer.interfaces.metadata
-
Used by Lightstreamer to provide to method
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.interfaces.metadata.SubscriptionStatistics
-
Used by Lightstreamer to create a SubscriptionStatistics instance, collecting various activity statistics for a single Item.
T
- TableInfo - Class in com.lightstreamer.interfaces.metadata
-
Used by Lightstreamer to provide value objects to the calls to methods
MetadataProvider.notifyNewTables(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
,MetadataProvider.notifyTablesClose(java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo[])
, andMetadataProvider.notifyMpnSubscriptionActivation(java.lang.String, java.lang.String, com.lightstreamer.interfaces.metadata.TableInfo, com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo)
. - TableInfo(int, Mode, String, String, String, int, int, String, String[], SubscriptionStatistics[]) - Constructor for class com.lightstreamer.interfaces.metadata.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.interfaces.metadata.Mode
-
Gets the internal name of the publishing Mode.
- toString() - Method in class com.lightstreamer.interfaces.metadata.MpnDeviceInfo
-
Returns a string representation of the MpnDeviceInfo.
- toString() - Method in class com.lightstreamer.interfaces.metadata.MpnPlatformType
-
Returns a string representation of the MpnPlatformType.
- toString() - Method in class com.lightstreamer.interfaces.metadata.MpnSubscriptionInfo
-
Returns a string representation of the MpnSubscriptionInfo.
- toString() - Method in class com.lightstreamer.interfaces.metadata.TableInfo
U
- unsubscribe(String) - Method in interface com.lightstreamer.interfaces.data.DataProvider
-
Called by Lightstreamer Kernel to end a previous request of data for an Item.
- update(String, IndexedItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an IndexedItemEvent instance.
- update(String, ItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an ItemEvent instance.
- update(String, OldItemEvent, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as an OldItemEvent instance.
- update(String, Map, boolean) - Method in interface com.lightstreamer.interfaces.data.ItemEventListener
-
Called by a Data Adapter to send an ItemEvent to Lightstreamer Kernel when the ItemEvent is implemented as a java.util.Map instance.
- UPDATE_COMMAND - Static variable in interface com.lightstreamer.interfaces.data.DataProvider
-
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.interfaces.data.DiffAlgorithm
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.lightstreamer.interfaces.data.DiffAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- wantsTablesNotification(String) - Method in interface com.lightstreamer.interfaces.metadata.MetadataProvider
-
Called by Lightstreamer Kernel 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.interfaces.metadata.MetadataProviderAdapter
-
Called by Lightstreamer Kernel 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