Caplin Systems - Index (StreamLink Java 8.0.3-1239-180a512 API Documentation)

A B C D E F G H I J K L M N O P R S T U V W X Y
All Classes and Interfaces|All Packages

A

ACCT_EXPIRED - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator because the user's account has expired.
ACTIVE - Enum constant in enum class com.caplin.streamlink.alerts.TriggerState: the trigger is active and waiting for the condition to be met
addConnectionListener(ConnectionListener) - Method in interface com.caplin.streamlink.StreamLink: Adds a connection listener with this StreamLink instance.
addCustomAttribute(String, String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets custom attributes.
addHeader(String, String) - Method in interface com.caplin.streamlink.CommandParameters: For REST operations this adds a HTTP header to be used by the resulting REST request.
addHeader(String, String) - Method in interface com.caplin.streamlink.JsonSubscriptionParameters: For REST operations this adds a HTTP header to be used by the resulting REST request.
addLiberatorUrlGroup(String...) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Adds a group of URLs that define possible Liberator connections.
addListener(NotificationListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Adds a notification listener that will be called back when notifications are triggered or dismissed.
addListener(TriggerListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Adds a trigger listener that will be called back when triggers are added and removed.
addListener(LogListener, LogLevel) - Method in interface com.caplin.streamlink.Logger: Adds a LogListener to this Logger.
addTrigger(String, String, Map<String, String>, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Add a new trigger for the current user.
ALREADY_LOGGED_IN - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator because the user is already logged in
AND - Enum constant in enum class com.caplin.streamlink.FilterExpressionLogicalOperator: Represents that a logical AND will be performed.

B

BaseConnectionListener - Class in com.caplin.streamlink: Adapter class implementing the ConnectionListener methods
BaseConnectionListener() - Constructor for class com.caplin.streamlink.BaseConnectionListener
BaseSubscriptionListener - Class in com.caplin.streamlink: Adapter class implementing the SubscriptionListener methods
BaseSubscriptionListener() - Constructor for class com.caplin.streamlink.BaseSubscriptionListener

C

cancel() - Method in interface com.caplin.streamlink.CredentialsProvider: This method is called by the StreamLink library when it needs to cancel a request to get credentials.
CANCELLED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: Disconnect occurred and a command set as cancellable has been cancelled.
CASE_INSENSITIVE_REGULAR_EXPRESSION - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a string field matches a particular regular expression where an exact case match is not necessary.
Channel - Interface in com.caplin.streamlink: Represents a channel to a subject on the Liberator.
ChannelListener - Interface in com.caplin.streamlink: Interface for receiving updates on the channel from the Liberator.
CHAT - Enum constant in enum class com.caplin.streamlink.SubjectType: Chat subject type.
ChatEvent - Interface in com.caplin.streamlink: Provides information about updates to a chat subject.
ChatEventType - Enum Class in com.caplin.streamlink: Enumeration that defines the type of the ChatEvent.
clear() - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should clear your model of the container.
close() - Method in interface com.caplin.streamlink.Publisher: Closes this subscription
closeChannel() - Method in interface com.caplin.streamlink.Channel: Closes the channel to the Liberator.
closeChannel() - Method in interface com.caplin.streamlink.JsonChannel: Closes the channel to the Liberator.
com.caplin.streamlink - package com.caplin.streamlink: The interfaces within this package provide the functionality of StreamLink.
com.caplin.streamlink.alerts - package com.caplin.streamlink.alerts: The interfaces within this package provide the functionality of Triggers and Notifications.
CommandErrorEvent - Interface in com.caplin.streamlink: Provides error information for commands.
CommandErrorType - Enum Class in com.caplin.streamlink: Enumeration defining the errors that can occur for a command.
CommandListener - Interface in com.caplin.streamlink: Defines the interface that you should implement to receive information on the result of a command.
CommandParameters - Interface in com.caplin.streamlink: Interface that defines parameters for a CommandSubscription.
CommandResultEvent - Interface in com.caplin.streamlink: Provides result information for commands.
CommandResultListener - Interface in com.caplin.streamlink: Defines the interface that you should implement to receive information on the result of a command.
CommandSubscription - Interface in com.caplin.streamlink: Stored information on the subscription and lets you unpersist the command.
CONFIG - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for messages about StreamLink's configuration.
connect() - Method in interface com.caplin.streamlink.StreamLink: Instructs this StreamLink instance to attempt to connect to the Liberator.
CONNECTED - Enum constant in enum class com.caplin.streamlink.ConnectionState: A network connection has been established to the Liberator.
CONNECTING - Enum constant in enum class com.caplin.streamlink.ConnectionState: A connection attempt is in progress.
ConnectionCurrentState - Interface in com.caplin.streamlink
ConnectionListener - Interface in com.caplin.streamlink: Defines the interface for receiving information about changes in the state of the StreamLink connection, the data services available from the Liberator, and the DataSources that are normally connected to the Liberator.
ConnectionState - Enum Class in com.caplin.streamlink: Enumeration that defines the state of a StreamLink connection to a Liberator.
ConnectionStatusEvent - Interface in com.caplin.streamlink: Provides information about a change in status of the connection to the Liberator.
ConsoleLogListener - Class in com.caplin.streamlink: Utility class to aid debugging.
ConsoleLogListener() - Constructor for class com.caplin.streamlink.ConsoleLogListener
CONTAINER - Enum constant in enum class com.caplin.streamlink.SubjectType: Container subject type.
ContainerElement - Interface in com.caplin.streamlink: Representation of a subject that is within a container.
ContainerEvent - Interface in com.caplin.streamlink: Represents an update to a container subject.
ContainerFilterFactory - Class in com.caplin.streamlink: A factory for creating FilterExpressions for use in the ContainerSubscriptionParameters select method.
ContainerFilterFactory() - Constructor for class com.caplin.streamlink.ContainerFilterFactory
ContainerModel - Interface in com.caplin.streamlink: This interface defines a model that represents a container.
ContainerSubscriptionParameters - Interface in com.caplin.streamlink: Defines the parameters used for Container subscriptions.
create(StreamLinkConfiguration) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance with the supplied StreamLinkConfiguration object.
create(StreamLinkConfiguration, CredentialsProvider) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance with the supplied StreamLinkConfiguration object and CredentialsProvider.
create(String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied JSON configuration.
create(String, CommandParameters, CommandResultListener) - Method in interface com.caplin.streamlink.StreamLink: Creates a subject.
create(String, CredentialsProvider) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied configuration and CredentialsProvider.
create(String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new field filter expression.
create(String, KeymasterPollResponseListener) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied JSON configuration.
create(String, String, String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLink instance from the supplied configuration and username/password credentials.
createChannel(String, ChannelListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Creates a Channel for the specified subject on the Liberator.
createCommandParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a set of CommandParameters which can be used to set a command to be persistent.
createConfiguration() - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLinkConfiguration object that can be used to configure StreamLink.
createConfiguration(String) - Static method in class com.caplin.streamlink.StreamLinkFactory: Creates a new StreamLinkConfiguration object that can be used to configure StreamLink.
createContainerSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for a container subscription.
createCustom(String, String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new custom field filter expression.
createFreeFormSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for subscriptions.
createJsonChannel(String, JsonChannelListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Creates a JsonChannel for the specified subject on the Liberator.
createJsonSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for a Json subscription.
createLogical(FilterExpressionLogicalOperator, FilterExpression...) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new logical filter expression.
createNumeric(String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new numeric field filter expression.
createRecordSubscriptionParameters() - Method in interface com.caplin.streamlink.StreamLink: Creates a parameters object for a record subscription.
createSubject(String, SubjectType, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Creates a subject on the Liberator.
createSubject(String, SubjectType, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Creates a subject on the Liberator.
createText(String, FilterExpressionOperator, String) - Static method in class com.caplin.streamlink.ContainerFilterFactory: Creates a new text field filter expression.
createWebRequestParameters(String, Map<String, String>) - Method in interface com.caplin.streamlink.StreamLink: Creates a WebRequestParameters object for the specified Liberator web module.
Credentials - Interface in com.caplin.streamlink: Encapsulates authentication information used to log in to a Liberator server.
CREDENTIALSERROR - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: An error occurred whilst retrieving the credentials that are used to log in to the Liberator
CredentialsProvider - Interface in com.caplin.streamlink: This interface defines how to provide the user credentials that StreamLink uses to log into a Liberator server.
CredentialsReceiver - Interface in com.caplin.streamlink: Interface that your custom implementation of CredentialsProvider must call to provide credential information to StreamLink.
CREDENTIALSRETRIEVALFAILED - Enum constant in enum class com.caplin.streamlink.ConnectionState: StreamLink has failed to retrieve the credentials.
CREDENTIALSRETRIEVED - Enum constant in enum class com.caplin.streamlink.ConnectionState: StreamLink has successfully retrieved the credentials.
credentialsUnavailable(String) - Method in interface com.caplin.streamlink.CredentialsReceiver: Call this method to indicate that an error occurred when retrieving a set of credentials.
CRITICAL - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for messages indicating a serious failure.

D

DataEvent - Interface in com.caplin.streamlink: Provides access to fundamental information about subscription events relating to changes in data, such as the subject and the type of event that has occurred.
DEF - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Set the throttle level to the default level.
delete(String, CommandParameters, CommandResultListener) - Method in interface com.caplin.streamlink.StreamLink: Deletes a subject.
deleteAllEntries() - Method in interface com.caplin.streamlink.RecordType3Event: Indicates whether all type 3 entries should be deleted.
deleteAllKeys() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the boolean that indicates whether all permission keys for this subject have been deleted.
deleteAllRows() - Method in interface com.caplin.streamlink.RecordType2Event: Returns whether all rows should be deleted.
DELETED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The subject has been deleted.
DELETED - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The subject has been deleted.
deleteKey() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the boolean that indicates whether the permission key within this update has been deleted.
deleteRow() - Method in interface com.caplin.streamlink.RecordType2Event: Returns whether the row should be deleted.
deleteSubject(String, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Deletes a subject on the Liberator.
DIRECTORY - Enum constant in enum class com.caplin.streamlink.SubjectType: Directory subject type.
DirectoryChangeElement - Interface in com.caplin.streamlink: Provides information about a change to a directory element.
DirectoryEvent - Interface in com.caplin.streamlink: Provides information about a change to a directory.
disableTrigger(Trigger, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Disables a trigger in the system.
DiscardHandler - Interface in com.caplin.streamlink
disconnect() - Method in interface com.caplin.streamlink.StreamLink: Instructs this StreamLink instance to disconnect from the Liberator.
DISCONNECT_OCCURRED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The command may have been sent to server, but disconnect occurred.
DISCONNECTED - Enum constant in enum class com.caplin.streamlink.ConnectionState: Disconnected from the Liberator.
dismissNotification(Notification, ResultListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Dismiss a notification for the current user.
DOWN - Enum constant in enum class com.caplin.streamlink.ServiceStatus: Indicates that a service is down, which means that at least one of the required sources defined for the service are down.
DOWN - Enum constant in enum class com.caplin.streamlink.SourceStatus: A source has gone up.
DOWN - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Decrease the throttle level.

E

EJECTED - Enum constant in enum class com.caplin.streamlink.ConnectionState: The client has been ejected from the Liberator.
enableTrigger(Trigger, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Enables a trigger in the system.
EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check for an exact match between a field and a value.
ERROR - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for messages which indicate a problem.
ErrorReason - Enum Class in com.caplin.streamlink: Enumeration that defines the reasons for an error being raised in a SubscriptionErrorEvent or a CommandErrorEvent.

F

FAILED - Enum constant in enum class com.caplin.streamlink.ConnectionState: A connection attempt has failed.
FilterExpression - Interface in com.caplin.streamlink: Interface that represents a filter expression.
FilterExpressionLogicalOperator - Enum Class in com.caplin.streamlink: Enumeration that represents a particular logical operation.
FilterExpressionOperator - Enum Class in com.caplin.streamlink: Enumeration that represents the operators that are available for a FieldFilterExpression.
FINE - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for tracing messages.
FINER - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for fairly detailed tracing messages.
FINEST - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for the most finely detailed tracing messages.
format(Object) - Method in interface com.caplin.streamlink.JsonHandler: Serializes a plain language object to its JSON string representation.
FreeFormSubscriptionParameters - Interface in com.caplin.streamlink: A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers.

G

getAverageLatency() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the average latency of heartbeat messages sent from Liberator to StreamLink.
getChangedElements() - Method in interface com.caplin.streamlink.DirectoryEvent: Returns a list of changes to the Directory.
getClockOffset() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the clock offset between Liberator and StreamLink (Liberator time minus StreamLink time).
getColumn() - Method in interface com.caplin.streamlink.PageElement
getCommandListener() - Method in interface com.caplin.streamlink.CommandSubscription: Returns the CommandResultListener that is informed of success or failure of this command.
getCondition() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the condition that must be met for this trigger to fire a notification.
getConnectionCurrentState() - Method in interface com.caplin.streamlink.StreamLink: Returns information about the state of the current connection.
getConnectionState() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the new state of a connection the the Liberator.
getConnectionStatus() - Method in interface com.caplin.streamlink.ConnectionCurrentState
getCookies() - Method in interface com.caplin.streamlink.KeymasterCookieProvider: Provide HTTP cookies as a map of cookie name to values
getCustomAttributes() - Method in interface com.caplin.streamlink.StreamLink
getCustomAttributes() - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Gets a map of the customer attributes set on this StreamLink instance to.
getDate() - Method in interface com.caplin.streamlink.LogInfo: Returns the date for this log entry.
getDateTime() - Method in interface com.caplin.streamlink.NewsEvent: Returns the date/time associated with this headline update.
getElements() - Method in interface com.caplin.streamlink.PageEvent: Returns array of com.caplin.streamlink.PageElementss.
getError() - Method in interface com.caplin.streamlink.CommandErrorEvent: Returns the CommandErrorType of the event.
getError() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the type of subscription error.
getErrorReason() - Method in interface com.caplin.streamlink.CommandErrorEvent: Returns the ErrorReason of the event.
getErrorReason() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the ErrorReason of the event.
getFields() - Method in interface com.caplin.streamlink.NewsEvent: Returns all field/value pairs that were updated in this update.
getFields() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the collection of fields relating to this PermissionEvent.
getFields() - Method in interface com.caplin.streamlink.RecordType1Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.RecordType2Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.RecordType3Event: Returns the record fields relating to the event, as a collection of key-value pairs.
getFields() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns any fields associated with the status event.
getHeaders() - Method in interface com.caplin.streamlink.HttpHeaderProvider
getHeaders(String) - Method in interface com.caplin.streamlink.KeymasterHttpHeaderProvider: Provide HTTP headers as a map of header name to value.
getHeadline() - Method in interface com.caplin.streamlink.NewsEvent: Returns the headline for this update.
getId() - Method in interface com.caplin.streamlink.alerts.Notification: Gets the unique id of the notification, can be used to dismiss the notification from the NotificationProvider.
getJson() - Method in interface com.caplin.streamlink.JsonEvent: Returns the complete JSON object (patches applied) as created by the user defined JsonHandler (specified in the configuration).
getJsonString() - Method in interface com.caplin.streamlink.JsonEvent: Returns the JSON string (initial image or patch) relating to the event.
getKey() - Method in interface com.caplin.streamlink.PermissionEvent: Returns the permission key relating to this event.
getLastLog() - Method in interface com.caplin.streamlink.StreamLink: Returns a List containing the last "log_buffer_size" log lines written by the current StreamLink instance.
getLatency() - Method in interface com.caplin.streamlink.StatisticsEvent: Gets the latency of the latest heartbeat message sent from Liberator to StreamLink.
getLatency(String) - Method in interface com.caplin.streamlink.RecordType1Event: Gets the latency of the record in milliseconds.
getLevel() - Method in interface com.caplin.streamlink.LogInfo: Returns the log level for this log entry.
getLiberatorUrl() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the URL of the Liberator connection that this status event has been raised for.
getLogger() - Method in interface com.caplin.streamlink.StreamLink: Returns the StreamLink logger object.
getLoginFailReason() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the reason for the login attempt failing.
getMaxColumn() - Method in interface com.caplin.streamlink.PageEvent
getMaxRow() - Method in interface com.caplin.streamlink.PageEvent
getMessage() - Method in interface com.caplin.streamlink.ChatEvent: Returns the chat message.
getMessage() - Method in interface com.caplin.streamlink.LogInfo: Returns the message text for this log entry.
getNextLiberatorUrl() - Method in interface com.caplin.streamlink.LiberatorUrlProvider
getPaddedName() - Method in enum class com.caplin.streamlink.LogLevel
getParameters() - Method in interface com.caplin.streamlink.alerts.Notification: Gets a map that contains the notification data fields.
getParameters() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets a map containing the trigger parameters.
getPassword() - Method in interface com.caplin.streamlink.Credentials: Returns the password.
getPattern() - Method in interface com.caplin.streamlink.JsonProviderHandle: The subject glob pattern registered
getPattern() - Method in interface com.caplin.streamlink.RecordProviderHandle: The subject glob pattern registered
getPayload() - Method in interface com.caplin.streamlink.CommandParameters: Gets the payload
getPayload() - Method in interface com.caplin.streamlink.CommandResultEvent: Returns the payload of the event.
getPayloadType() - Method in interface com.caplin.streamlink.CommandParameters: Gets the payload type
getPostBody() - Method in interface com.caplin.streamlink.WebRequestParameters: Returns the contents of the HTTP post body that should be used (to specify parameters) with the web module URL.
getProvider() - Method in interface com.caplin.streamlink.JsonProviderHandle: The provider registered
getProvider() - Method in interface com.caplin.streamlink.RecordProviderHandle: The provider registered
getRow() - Method in interface com.caplin.streamlink.PageElement
getServiceName() - Method in interface com.caplin.streamlink.ServiceStatusEvent: Returns the name of the service that has changed state.
getServiceStatus() - Method in interface com.caplin.streamlink.ServiceStatusEvent: Returns the new ServiceStatus of a service.
getServiceStatusArray() - Method in interface com.caplin.streamlink.ConnectionCurrentState
getSize() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the size of the container.
getSourceName() - Method in interface com.caplin.streamlink.SourceStatusEvent: Returns the name of the Integration Adapter that has changed state.
getSourceStatus() - Method in interface com.caplin.streamlink.SourceStatusEvent: Returns the new status of an Integration Adapter.
getSourceStatusArray() - Method in interface com.caplin.streamlink.ConnectionCurrentState
getState() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the current state of the trigger.
getStatistics() - Method in interface com.caplin.streamlink.ConnectionCurrentState
getStatus() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns the new status of the subject of the subscription.
getStatusMessage() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns the new status message of the subject of the subscription.
getStoryCode() - Method in interface com.caplin.streamlink.NewsEvent: Returns the story code associated with this update.
getSubject() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the rttp subject associated with this trigger.
getSubject() - Method in interface com.caplin.streamlink.Channel: Returns the subject name to which the channel relates.
getSubject() - Method in interface com.caplin.streamlink.CommandSubscription: Returns the subject the command was executed on.
getSubject() - Method in interface com.caplin.streamlink.ContainerElement: Returns the subject of the element.
getSubject() - Method in interface com.caplin.streamlink.DataEvent: Returns the subject to which the event relates.
getSubject() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Returns the subject of the directory element that has changed.
getSubject() - Method in interface com.caplin.streamlink.JsonChannel: Returns the subject name to which the channel relates.
getSubject() - Method in interface com.caplin.streamlink.Publisher: The subject that was requested
getSubject() - Method in interface com.caplin.streamlink.Subscription: Returns the subject name to which the subscription relates (for example, /FX/EURUSD).
getSubject() - Method in interface com.caplin.streamlink.SubscriptionErrorEvent: Returns the subject of subscription to which the event relates.
getSubject() - Method in interface com.caplin.streamlink.SubscriptionStatusEvent: Returns the subject of the subscription to which the event relates.
getSubscriptionListener() - Method in interface com.caplin.streamlink.Subscription: Returns the SubscriptionListener that is informed of all subscription events relating to this subscription.
getText() - Method in interface com.caplin.streamlink.PageElement: Returns the page text at the given row and column.
getText() - Method in interface com.caplin.streamlink.StoryEvent: Returns the story text relating to the event.
getTime() - Method in interface com.caplin.streamlink.ChatEvent: Returns the time when the chat event was raised.
getTimeReceived() - Method in interface com.caplin.streamlink.RecordType1Event: Returns the time that the record data in the event was received at the client.
getTriggerId() - Method in interface com.caplin.streamlink.alerts.Trigger: Gets the unique id of the trigger.
getType() - Method in interface com.caplin.streamlink.ContainerElement: Returns the SubjectType of the element.
getType() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Returns the subject type of the Directoruy element that has changed.
getType2IndexField() - Method in interface com.caplin.streamlink.RecordType2Event: Gets the type 2 index field relating to the event.
getUpdateType() - Method in interface com.caplin.streamlink.ChatEvent: Returns the type of chat event that this event represents.
getUrl() - Method in interface com.caplin.streamlink.WebRequestParameters: Returns the URL that must be used to invoke the required web module
getUser() - Method in interface com.caplin.streamlink.ChatEvent: Returns the username of the user who generated this chat event.
getUsername() - Method in interface com.caplin.streamlink.ConnectionStatusEvent: Returns the username that will be used to log in to the Liberator.
getUsername() - Method in interface com.caplin.streamlink.Credentials: Returns the user-name.
getValue() - Method in enum class com.caplin.streamlink.LogLevel
getVersion() - Method in interface com.caplin.streamlink.StreamLink: Gets the version of StreamLink.
getWindowEnd() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the index of the end of the container window.
getWindowStart() - Method in interface com.caplin.streamlink.ContainerEvent: Gets the index of the start of the window.
getX() - Method in class com.caplin.streamlink.STuple
getY() - Method in class com.caplin.streamlink.STuple
GREATER_THAN - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field is greater than a particular value.
GREATER_THAN_OR_EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field is greater than or equal to a particular value.

H

HttpHeaderProvider - Interface in com.caplin.streamlink

I

INACTIVE - Enum constant in enum class com.caplin.streamlink.alerts.TriggerState: the trigger is disabled/paused and will not trigger if the condition is met
INFO - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for information messages.
insert(int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should insert the ContainerElement at the specified position.
INVALID_IP - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator because the connection attempts is made from an invalid IP address.
INVALID_PARAMETERS - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The supplied command parameters are invalid for the command.
INVALID_PARAMETERS - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: Supplied parameters are invalid for this subject type.
INVALID_PASS - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator because the user's password is incorrect.
INVALID_USER - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator because the user's username is incorrect.
isAdded() - Method in interface com.caplin.streamlink.DirectoryChangeElement: Indicates whether this directory element has been added or removed from the directory.
isClosed() - Method in interface com.caplin.streamlink.Publisher: Indicates whether this publisher has been closed
isDiscarded() - Method in interface com.caplin.streamlink.Publisher: Indicates whether this subjet has been discard by the liberator
isImage() - Method in interface com.caplin.streamlink.DataEvent: Returns whether this was an image event or an update event.

J

JOINED - Enum constant in enum class com.caplin.streamlink.ChatEventType: The event represents the event raised when this StreamLink client joins a chat channel.
JSON - Enum constant in enum class com.caplin.streamlink.PayloadType: The payload should be an object that can be serialized to JSON.
JSON - Enum constant in enum class com.caplin.streamlink.SubjectType: JSON subject type.
JsonChannel - Interface in com.caplin.streamlink: Represents a JSON channel to a subject on the Liberator.
JsonChannelListener - Interface in com.caplin.streamlink: Interface for receiving updates on the JSON channel from the Liberator.
JsonDiscardHandler - Interface in com.caplin.streamlink: Object registered to receive discard callbacks.
JsonEvent - Interface in com.caplin.streamlink: Provides information about a JSON message.
JsonHandler - Interface in com.caplin.streamlink: Handler for parsing and patching JSON objects
JsonProvider - Interface in com.caplin.streamlink: Definition of the interface that Streamlink calls back when the liberator requests json objects that match the pattern registered via the StreamLink.registerJsonProvider(...) method
JsonProviderHandle - Interface in com.caplin.streamlink: Object returned from the StreamLink.register...Provider methods.
JsonPublisher - Interface in com.caplin.streamlink: An object that can send JSON messages for a subject that StreamLink is providing
JsonSubscriptionParameters - Interface in com.caplin.streamlink: Defines the parameters used for Json subscriptions.

K

KeymasterCookieProvider - Interface in com.caplin.streamlink: The set of cookies provided by this interface will be sent with KeyMaster connections.
KeymasterHttpHeaderProvider - Interface in com.caplin.streamlink: The set of headers provided by this interface will be sent with KeyMaster connections.
KeymasterPollResponseListener - Interface in com.caplin.streamlink: Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses.

L

LESS_THAN - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field is less than a particular value.
LESS_THAN_OR_EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field is less than or equal to a particular value.
LiberatorUrlProvider - Interface in com.caplin.streamlink: The Liberators provided by this interface will be tried in sequence until a connection is established, return null when there are no more Liberators to try.
LICENSE - Enum constant in enum class com.caplin.streamlink.ErrorReason: Licence failure
LICENSE_SITE - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator due to licensing limitations.
LICENSE_USER - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: StreamLink can not log in to the Liberator due to licensing limitations.
LIMITED - Enum constant in enum class com.caplin.streamlink.ServiceStatus: Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).
log(LogLevel, String, Object...) - Method in interface com.caplin.streamlink.Logger: Sends a log message to all LogListener's that have been registered for this log level or above.
LOGGEDIN - Enum constant in enum class com.caplin.streamlink.ConnectionState: The client is now logged into the Liberator.
Logger - Interface in com.caplin.streamlink: Allows StreamLink log messages to be written to the destination of your choice.
LOGINFAILED - Enum constant in enum class com.caplin.streamlink.ConnectionState: The client could not login to the Liberator.
LoginFailedReason - Enum Class in com.caplin.streamlink: Enumeration that defines the reason for a failed login.
LogInfo - Interface in com.caplin.streamlink: Stores log information including message and level of a log entry.
LogLevel - Enum Class in com.caplin.streamlink: Enumeration that represents the available logging levels.
LogListener - Interface in com.caplin.streamlink: Interface for receiving log messages from the StreamLink application.
LOST - Enum constant in enum class com.caplin.streamlink.ConnectionState: The connection to the Liberator has been lost.

M

MAX - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Set the throttle level to the maximum amount of throttling.
MESSAGE - Enum constant in enum class com.caplin.streamlink.ChatEventType: The event contains a chat message
MIN - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Set the throttle level to the minimum amount of throttling.
move(int, int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should move the specified ContainerElement.

N

networkAvailable() - Method in interface com.caplin.streamlink.StreamLink: Informs StreamLink the network is available.
networkUnavailable() - Method in interface com.caplin.streamlink.StreamLink: Informs StreamLink the network is unavailable.
NEWS_HEADLINE - Enum constant in enum class com.caplin.streamlink.SubjectType: News headline subject type.
NEWS_STORY - Enum constant in enum class com.caplin.streamlink.SubjectType: News story subject type.
NewsEvent - Interface in com.caplin.streamlink: Provides information about a news headline update.
NONE - Enum constant in enum class com.caplin.streamlink.ErrorReason: No Reason
NOT_EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field does not match a particular value.
NOT_FOUND - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The command subject could not be found.
NOT_FOUND - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The subject could not be found.
Notification - Interface in com.caplin.streamlink.alerts: A Notification is an object that can be sent to notify a user of a particular event.
NotificationListener - Interface in com.caplin.streamlink.alerts: Interface that should be implemented to receive notification change callbacks from the NotificationProvider
NotificationService - Class in com.caplin.streamlink.alerts: A NotificationService subscribes to a Notifications container of the StreamLink user and allows the user to register a listener to be called when notifications are triggered or dismissed.
NotificationService(StreamLink) - Constructor for class com.caplin.streamlink.alerts.NotificationService: Creates a new NotificationService for the given StreamLink instance.
NOTIFY - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for messages of more importance than INFO but may not indicate problems.
NUMERIC_EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check for an exact match between a numeric field and value.
NUMERIC_NOT_EQUAL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a numeric field does not match a particular value.

O

OK - Enum constant in enum class com.caplin.streamlink.ServiceStatus: Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.
onChannelData(Channel, RecordType1Event) - Method in interface com.caplin.streamlink.ChannelListener: Called when an update is received.
onChannelData(JsonChannel, JsonEvent) - Method in interface com.caplin.streamlink.JsonChannelListener: Called when an update is received.
onChannelError(Channel, SubscriptionErrorEvent) - Method in interface com.caplin.streamlink.ChannelListener: Called when there is an error on the channel.
onChannelError(JsonChannel, SubscriptionErrorEvent) - Method in interface com.caplin.streamlink.JsonChannelListener: Called when there is an error on the channel.
onChannelStatus(Channel, SubscriptionStatusEvent) - Method in interface com.caplin.streamlink.ChannelListener: Called when there is a change in the status for the channel.
onChannelStatus(JsonChannel, SubscriptionStatusEvent) - Method in interface com.caplin.streamlink.JsonChannelListener: Called when there is a change in the status for the channel.
onChatUpdate(Subscription, ChatEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onChatUpdate(Subscription, ChatEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a chat update is received.
onCommandError(String, CommandErrorEvent) - Method in interface com.caplin.streamlink.CommandListener: Callback invoked when a command failed or is an unknown state.
onCommandOk(String) - Method in interface com.caplin.streamlink.CommandListener: Callback invoked when a command was successful.
onCommandResult(String, CommandResultEvent) - Method in interface com.caplin.streamlink.CommandResultListener: For a command that returns a result, this method will be called in addition to the onCommandOk callback
onConnectionStatusChange(ConnectionStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onConnectionStatusChange(ConnectionStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of the StreamLink connection changes.
onContainerUpdate(Subscription, ContainerEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onContainerUpdate(Subscription, ContainerEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a container update is received.
onCredentialsRequired(CredentialsReceiver) - Method in interface com.caplin.streamlink.CredentialsProvider: Gets the credentials used to log in to the Liberator.
onDirectoryUpdate(Subscription, DirectoryEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onDirectoryUpdate(Subscription, DirectoryEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a directory update is received.
onDiscard(JsonPublisher) - Method in interface com.caplin.streamlink.JsonDiscardHandler: Called when a discard is received for a currently provided subject
onDiscard(Publisher) - Method in interface com.caplin.streamlink.DiscardHandler
onDiscard(RecordPublisher) - Method in interface com.caplin.streamlink.RecordDiscardHandler: Called when a discard is received for a currently provided subject
onFailure(String) - Method in interface com.caplin.streamlink.alerts.ResultListener: Called when the associated operation failed.
onJsonUpdate(Subscription, JsonEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onJsonUpdate(Subscription, JsonEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a json update is received.
onKeymasterError(String) - Method in interface com.caplin.streamlink.KeymasterPollResponseListener: Returns an unsuccessful KeyMaster keep alive Response.
onKeymasterResponse(String) - Method in interface com.caplin.streamlink.KeymasterPollResponseListener: Returns a successful KeyMaster keep alive Response.
onLog(LogInfo) - Method in class com.caplin.streamlink.ConsoleLogListener
onLog(LogInfo) - Method in interface com.caplin.streamlink.LogListener: Called when a StreamLink log message is to be logged.
onNewsUpdate(Subscription, NewsEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onNewsUpdate(Subscription, NewsEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a news headline update is received.
onNotification(Notification) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when notification gets added to the container.
onNotificationRemoved(Notification) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when notification is removed from the container.
onPageUpdate(Subscription, PageEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onPageUpdate(Subscription, PageEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a page update is received.
onPermissionUpdate(Subscription, PermissionEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onPermissionUpdate(Subscription, PermissionEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a permission update is received.
onRecordType2Update(Subscription, RecordType2Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordType2Update(Subscription, RecordType2Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 2 data in a record is received.
onRecordType3Update(Subscription, RecordType3Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordType3Update(Subscription, RecordType3Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 3 data in a record is received.
onRecordUpdate(Subscription, RecordType1Event) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onRecordUpdate(Subscription, RecordType1Event) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when an update to type 1 data in a record is received.
onRequest(JsonPublisher) - Method in interface com.caplin.streamlink.JsonProvider: Method called when a subject is requested by the Liberator that matches the pattern registered via StreamLink.registerJsonProvider(...)
onRequest(RecordPublisher) - Method in interface com.caplin.streamlink.RecordProvider: Method called when a subject is requested by the Liberator that matches the pattern registered via StreamLink.registerRecordProvider(...)
onServiceStatus(ServiceStatus) - Method in interface com.caplin.streamlink.alerts.NotificationListener: Received when the notification service availability changes.
onServiceStatus(ServiceStatus) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when the trigger service availability changes.
onServiceStatusChange(ServiceStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onServiceStatusChange(ServiceStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of a data service available from the Liberator changes.
onSourceStatusChange(SourceStatusEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onSourceStatusChange(SourceStatusEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when the state of one of the Integration Adapters connected to Liberator changes.
onStatisticsChange(StatisticsEvent) - Method in class com.caplin.streamlink.BaseConnectionListener
onStatisticsChange(StatisticsEvent) - Method in interface com.caplin.streamlink.ConnectionListener: Invoked when new connection statistics are available.
onStoryUpdate(Subscription, StoryEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onStoryUpdate(Subscription, StoryEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when a news story update is received.
onSubscriptionError(Subscription, SubscriptionErrorEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onSubscriptionError(Subscription, SubscriptionErrorEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when there is an error in a subscription.
onSubscriptionStatus(Subscription, SubscriptionStatusEvent) - Method in class com.caplin.streamlink.BaseSubscriptionListener
onSubscriptionStatus(Subscription, SubscriptionStatusEvent) - Method in interface com.caplin.streamlink.SubscriptionListener: Called when there is a change in the status of a subscription.
onSuccess() - Method in interface com.caplin.streamlink.alerts.ResultListener: Called when the associated operation was successful.
onTriggerAdded(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger gets added to container.
onTriggerRemoved(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger gets removed from container.
onTriggerUpdated(Trigger) - Method in interface com.caplin.streamlink.alerts.TriggerListener: Received when a trigger is updated.
OR - Enum constant in enum class com.caplin.streamlink.FilterExpressionLogicalOperator: Represents that a logical OR will be performed.

P

PAGE - Enum constant in enum class com.caplin.streamlink.SubjectType: Page subject type.
PageElement - Interface in com.caplin.streamlink: Provides information about a single text change for the given row and column in a Page.
PageEvent - Interface in com.caplin.streamlink: Provides information about a change to data in a Page.
parse(String) - Method in interface com.caplin.streamlink.JsonHandler: Parses a JSON string into a platform specific representation.
patch(Object, String) - Method in interface com.caplin.streamlink.JsonHandler: Patches a platform specific JSON representation with an RFC 6902 JSON patch string.
pause() - Method in interface com.caplin.streamlink.StreamLink: Pauses StreamLink so it does not receive new updates from the Liberator.
PAUSED - Enum constant in enum class com.caplin.streamlink.ConnectionState: The connection has been paused by the application.
PayloadType - Enum Class in com.caplin.streamlink: Enumeration defining the types of payload used on commands
PERMISSION - Enum constant in enum class com.caplin.streamlink.SubjectType: Permission subject type.
PermissionEvent - Interface in com.caplin.streamlink: Provides information about a change to permission data.
provideCredentials(Credentials) - Method in interface com.caplin.streamlink.CredentialsReceiver: Call this method to provide a set of Credentials to StreamLink.
publish(String, CommandParameters, CommandResultListener) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.
Publisher - Interface in com.caplin.streamlink: An object that can send messages for a subject that StreamLink is providing
publishToJsonSubject(String, Object, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Publishes JSON data to a subject.
publishToSubject(String, List<STuple>, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.
publishToSubject(String, List<STuple>, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.
publishToSubject(String, Map<String, String>, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.
publishToSubject(String, Map<String, String>, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Publishes data to a subject.

R

READ_DENIED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The client does not have permission to read the subject.
READ_DENIED - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The client does not have permission to read the subject.
RECONNECTED - Enum constant in enum class com.caplin.streamlink.ConnectionState: The Liberator session has been reconnected.
RECORD - Enum constant in enum class com.caplin.streamlink.PayloadType: The payload should be a map of field names to values or a list of name, value tuples.
RECORD - Enum constant in enum class com.caplin.streamlink.SubjectType: Record subject type.
RecordDiscardHandler - Interface in com.caplin.streamlink: Object registered to receive discard callbacks.
RecordProvider - Interface in com.caplin.streamlink: Definition of the interface that Streamlink calls back when the liberator requests record objects that match the pattern registered via the StreamLink.registerRecordProvider(...) method
RecordProviderHandle - Interface in com.caplin.streamlink: Object returned from the StreamLink.register...Provider methods.
RecordPublisher - Interface in com.caplin.streamlink: An object that can send record messages for a subject that StreamLink is providing
RecordSubscriptionParameters - Interface in com.caplin.streamlink: Defines the parameters used for Record subscriptions.
RecordType1Event - Interface in com.caplin.streamlink: Provides information about a change to type 1 data (fieldname and data pairs) in a record.
RecordType2Event - Interface in com.caplin.streamlink: Provides information about a change to type 2 data in a record.
RecordType3Event - Interface in com.caplin.streamlink: Provides information about a change to type 3 data in a record.
registerJsonProvider(String, JsonProvider, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Registers a provider of data for the given subject pattern
registerRecordProvider(String, RecordProvider, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Registers a provider of data for the given subject pattern
REGULAR_EXPRESSION - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a string field matches a particular regular expression.
remove(int, ContainerElement) - Method in interface com.caplin.streamlink.ContainerModel: Called to indicate that you should remove the ContainerElement from the specified position.
removeConnectionListener(ConnectionListener) - Method in interface com.caplin.streamlink.StreamLink: Removes a previously added ConnectionListener from this StreamLink instance.
removeListener(NotificationListener) - Method in class com.caplin.streamlink.alerts.NotificationService: Removes a previously added notification listener, callbacks to this listener will be stopped.
removeListener(TriggerListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Removes a previously added trigger listener, callbacks to this listener will be stopped.
removeListener(LogListener) - Method in interface com.caplin.streamlink.Logger: Removes a LogListener that you previously added (see addListener).
removeTrigger(Trigger, ResultListener) - Method in class com.caplin.streamlink.alerts.TriggerService: Removes a trigger from the system.
ResultListener - Interface in com.caplin.streamlink.alerts: An interface that can be registered to be called back when an operation completes.
resume() - Method in interface com.caplin.streamlink.StreamLink: Re-establishes the connection to the Liberator to receive updates.
RETRIEVINGCREDENTIALS - Enum constant in enum class com.caplin.streamlink.ConnectionState: StreamLink is attempting to obtain a set of credentials to log in to the server.

S

select(String, String, String) - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Allow selection, sorting and grouping of containers.
send(Object, CommandListener) - Method in interface com.caplin.streamlink.JsonChannel: Sends object as JSON to the channel subject
send(Object, CommandListener) - Method in interface com.caplin.streamlink.JsonPublisher: Sends a Message to Liberator for the current subject
send(Map<String, String>, boolean, CommandListener) - Method in interface com.caplin.streamlink.RecordPublisher: Sends a Message to Liberator for the current subject
send(Map<String, String>, CommandListener) - Method in interface com.caplin.streamlink.Channel: Sends fields to the channel subject
sendWithFieldList(List<STuple>, CommandListener) - Method in interface com.caplin.streamlink.Channel: Sends fields to the channel subject allowing for a field to be repeatedly specified in the same message.
ServiceStatus - Enum Class in com.caplin.streamlink: Enumeration that defines the status of a Service.
ServiceStatusEvent - Interface in com.caplin.streamlink: Provides information about the change in status of a data service to which StreamLink is connected via the Liberator.
setAcceptAllCertificates(boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: StreamLink Java Only Set this option in StreamLink Java to accept all certificates when using secure websockets (wss)
setApplicationId(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the application identifier.
setCancellable() - Method in interface com.caplin.streamlink.CommandParameters: Sets the command associated with a CommandSubscription to be cancelled in the event that the connection goes down before it is sent.
setClockOffsetInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the interval between successive calculations of clock offset value(default 10000 milliseconds).
setClockOffsetWindow(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time a calculated clock offset is valid for use in producing statistics (default 120000 milliseconds).
setContainerWindow(int, int) - Method in interface com.caplin.streamlink.Subscription: Sets the container window for this subscription.
setDisablePolling(Boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Set to true if you don't want to use polling connection when the rttp(s) protocol is specified.
setDisableSseConnection(Boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Set to true if you don't want to use server side events connection when the rttp(s) protocol is specified.
setDiscardHandler(JsonDiscardHandler) - Method in interface com.caplin.streamlink.JsonPublisher: Sets an object to be called back when a discard is received for the current subject
setDiscardHandler(RecordDiscardHandler) - Method in interface com.caplin.streamlink.RecordPublisher: Sets an object to be called back when a discard is received for the current subject
setFields(List<String>) - Method in interface com.caplin.streamlink.RecordSubscriptionParameters: Sets the record fields that will be requested when a subscription is made using these parameters.
setFilter(String) - Method in interface com.caplin.streamlink.JsonSubscriptionParameters: Sets the filter that restricts the the information returned by the subscription.
setFilter(String, boolean) - Method in interface com.caplin.streamlink.RecordSubscriptionParameters: Sets the filter that restricts the the information returned by the subscription.
setForeverFrameReconnectCount(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setHttpPadLength(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the http pad length to be used for http and Forever Frame connections.
setHttpTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time allowed for an HTTP Request to finish successfully before StreamLink times out (default 3000 milliseconds).
setInactivityTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Maximum time in milliseconds that Liberator waits to receive messages from this StreamLink client.
setJsonHandler(JsonHandler) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a JsonHandler that will be used to parse and patch JSON objects.
setKeepInaccessible() - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Sets the subscription to keep elements in the container that are inaccessible.
setKeymasterCookieProvider(KeymasterCookieProvider) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a KeymasterCookieProvider that will provide the cookies used when making KeyMaster connections.
setKeymasterCrossDomainAuthentication(boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets whether Cross Domain Authentication is enabled for KeyMaster sessions.
setKeymasterHttpHeaderProvider(KeymasterHttpHeaderProvider) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a KeymasterHttpHeaderProvider that will provide the http headers used when making KeyMaster connections.
setKeymasterHttpPass(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the password used for HTTP KeyMaster sessions.
setKeymasterHttpUser(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the username used for HTTP KeyMaster sessions.
setKeymasterPollInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Interval in milliseconds at which StreamLink will poll KeyMaster (on the KeyMaster poll URL) to keep the KeyMaster session open.
setKeymasterPollResponseListener(KeymasterPollResponseListener) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a KeymasterPollResponseListener to receive information about responses to keep-alive requests made to KeyMaster.
setKeymasterPollUrl(String...) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the URL that StreamLink uses to check the connection to KeyMaster every KeyMaster poll interval milliseconds.
setKeymasterUrl(String...) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the URL of KeyMaster for secure authentication of Liberator login requests.<//p>
setLatencyInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time between successive calculations of average latency (default 10000 milliseconds).
setLatencyWindow(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time for which a calculated latency value is valid for use in producing statistics (default 120000 milliseconds).
setLiberatorUrlProvider(LiberatorUrlProvider) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets a LiberatorUrlProvider that will be used to get the next Liberator URL to connect to.
setLogBufferSize(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the size of the log buffer to be used in Streamlink.
setLogWindowLogLevel(LogLevel) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setLogWindowVisible(boolean) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Not used in this version of StreamLink.
setParameters(String) - Method in interface com.caplin.streamlink.FreeFormSubscriptionParameters: Sets the parameters using a free-form string.
setPassword(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the Liberator login password to use if logins are not being managed by KeyMaster or a custom CredentialsProvider.
setPayload(Object) - Method in interface com.caplin.streamlink.CommandParameters: Sets the payload object, this should be of the type specified in the payload type.
setPayloadType(PayloadType) - Method in interface com.caplin.streamlink.CommandParameters: Sets the type of the payload
setPersistent() - Method in interface com.caplin.streamlink.CommandParameters: Sets the command associated with a CommandSubscription to be persistent.
setPollInterval(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the time interval in milliseconds between polls of the Liberator.
setProxy(Proxy) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the proxy to be used for ws(s), http(s), poll(s) and tcp(s) connection protocols.
setReconnectAttempts(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the number of times that Streamlink should retry a connection attempt for each connection type (eg.
setReconnectCycleDelays(Integer...) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Delay in milliseconds before retrying, after failing to connect with all available connection options.
setReconnectDelay(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Delay in milliseconds before retrying, after failing to connect (default 1000 milliseconds).
setRequestTimeout(int) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Time in milliseconds allowed for the response to each command before StreamLink reconnects to the Liberator.
setStructureOnly() - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Sets the subscription to provide only the container structure (no constituent images or updates).
setUsername(String) - Method in interface com.caplin.streamlink.StreamLinkConfiguration: Sets the Liberator login user-name to use if logins are not being managed by KeyMaster or a custom CredentialsProvider.
setWindow(int, int) - Method in interface com.caplin.streamlink.ContainerSubscriptionParameters: Sets the size of the container window.
snapshot(String, SubscriptionListener) - Method in interface com.caplin.streamlink.StreamLink: Requests a single update from a subject.
snapshot(String, SubscriptionListener, SubscriptionParameters) - Method in interface com.caplin.streamlink.StreamLink: Requests a single update from a subject.
SourceStatus - Enum Class in com.caplin.streamlink: Enumeration that defines the status of a source.
SourceStatusEvent - Interface in com.caplin.streamlink: Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator.
START - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Start sending updates to the client again.
StatisticsEvent - Interface in com.caplin.streamlink: Provides access to the statistics relating to an instance of StreamLink.
STATUS_INFO - Enum constant in enum class com.caplin.streamlink.SubscriptionStatusType: An informational message about the subject (usually sent by the DataSource).
STATUS_LIMITED - Enum constant in enum class com.caplin.streamlink.SubscriptionStatusType: One of the sources of data for the subject is not available.
STATUS_OK - Enum constant in enum class com.caplin.streamlink.SubscriptionStatusType: The data associated with the subject is correct and up-to-date.
STATUS_STALE - Enum constant in enum class com.caplin.streamlink.SubscriptionStatusType: The subject's data may not be correct and up-to-date.
STOP - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Stop sending updates to the client.
StoryEvent - Interface in com.caplin.streamlink: Provides information about a change to story data in a Story.
StreamLink - Interface in com.caplin.streamlink: Defines the StreamLink interface.
StreamLinkConfiguration - Interface in com.caplin.streamlink: Interface that allows the configuration of StreamLink to be defined programmatically.
StreamLinkFactory - Class in com.caplin.streamlink: Factory that creates StreamLink instances.
STuple - Class in com.caplin.streamlink
STuple(Object, Object) - Constructor for class com.caplin.streamlink.STuple
SUBJECT_TYPE - Enum constant in enum class com.caplin.streamlink.PayloadType: The payload should be of type SubjectType.
SubjectType - Enum Class in com.caplin.streamlink: Enumeration that represents the available subject types.
subscribe(String, SubscriptionListener) - Method in interface com.caplin.streamlink.StreamLink: Subscribes to a subject to receive updates.
subscribe(String, SubscriptionListener, SubscriptionParameters) - Method in interface com.caplin.streamlink.StreamLink: Subscribes to a subject to receive updates.
Subscription - Interface in com.caplin.streamlink: Represents a subscription to a subject on the Liberator.
SubscriptionErrorEvent - Interface in com.caplin.streamlink: Provides information about a subscription error.
SubscriptionErrorType - Enum Class in com.caplin.streamlink: Enumeration which represents the errors that can occur for a subject.
SubscriptionListener - Interface in com.caplin.streamlink: Interface for receiving updates to subscribed data from the Liberator.
SubscriptionParameters - Interface in com.caplin.streamlink: The base interface for defining parameters that apply to Subscriptions.
SubscriptionStatusEvent - Interface in com.caplin.streamlink: Provides information about a change in the state of a subscription.
SubscriptionStatusType - Enum Class in com.caplin.streamlink: Enumeration that defines the status of a subject.

T

THROTTLE_FAILED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The throttle command failed.
ThrottleCommand - Enum Class in com.caplin.streamlink: Enumeration that defines the available throttle levels and throttle commands.
throttleEverything(ThrottleCommand, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Throttles all the currently subscribed subjects, reducing the number of updates that are sent every second.
throttleEverything(ThrottleCommand, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Throttles all the currently subscribed subjects, reducing the number of updates that are sent every second.
throttleSubject(String, ThrottleCommand, CommandListener) - Method in interface com.caplin.streamlink.StreamLink: Throttles the specified subject, reducing the number of updates that are sent every second.
throttleSubject(String, ThrottleCommand, CommandListener, CommandParameters) - Method in interface com.caplin.streamlink.StreamLink: Throttles the specified subject, reducing the number of updates that are sent every second.
toFilterString() - Method in interface com.caplin.streamlink.FilterExpression
toString() - Method in enum class com.caplin.streamlink.LogLevel
toString() - Method in class com.caplin.streamlink.STuple
Trigger - Interface in com.caplin.streamlink.alerts: A Trigger is an object associated with a particular RTTP subject that contains a condition (on the given subjects fields) that when met will trigger a notification message.
TRIGGERED - Enum constant in enum class com.caplin.streamlink.alerts.TriggerState: the condition was met and a notification was triggered
TriggerListener - Interface in com.caplin.streamlink.alerts: Interface that should be implemented to receive trigger change callbacks from the TriggerProvider
TriggerService - Class in com.caplin.streamlink.alerts: A TriggerService subscribes to the Triggers of a StreamLink user and allows the user to register a listener to be called back when triggers are added, removed or modified.
TriggerService(StreamLink) - Constructor for class com.caplin.streamlink.alerts.TriggerService: Creates a new TriggerService for the given StreamLink instance.
TriggerState - Enum Class in com.caplin.streamlink.alerts: Enumeration that defines the different states a Trigger can be in

U

UNAVAILABLE - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The subject is not available.
UNAVAILABLE - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The subject was not available.
UNDEFINED - Enum constant in enum class com.caplin.streamlink.LoginFailedReason: This value is undefined
UNKNOWN - Enum constant in enum class com.caplin.streamlink.alerts.TriggerState: Invalid state that only happens if the backend sends an unsupported state
UNKNOWN - Enum constant in enum class com.caplin.streamlink.SubjectType: The subject type is unknown.
unPersist() - Method in interface com.caplin.streamlink.CommandSubscription: For commands that have been set as persistent this method will turn off that persistence.
UNREACHABLE - Enum constant in enum class com.caplin.streamlink.ConnectionState: A connection to the Liberator is not possible due to no network being available.
unsubscribe() - Method in interface com.caplin.streamlink.Subscription: Unsubscribes to the subject on the Liberator.
UP - Enum constant in enum class com.caplin.streamlink.SourceStatus: A source has gone down.
UP - Enum constant in enum class com.caplin.streamlink.ThrottleCommand: Increase the throttle level.
updateModel(ContainerModel) - Method in interface com.caplin.streamlink.ContainerEvent: Update your implementation of ContainerModel with the contents of this ContainerEvent.
USER - Enum constant in enum class com.caplin.streamlink.SubjectType: User subject type.
USER_ADDED - Enum constant in enum class com.caplin.streamlink.ChatEventType: The event represents the event raised when a user joins a chat channel.
USER_CODE_1 - Enum constant in enum class com.caplin.streamlink.ErrorReason: Liberator auth module user reason 1
USER_CODE_2 - Enum constant in enum class com.caplin.streamlink.ErrorReason: Liberator auth module user reason 2
USER_CODE_3 - Enum constant in enum class com.caplin.streamlink.ErrorReason: Liberator auth module user reason 3
USER_CODE_4 - Enum constant in enum class com.caplin.streamlink.ErrorReason: Liberator auth module user reason 4
USER_CODE_5 - Enum constant in enum class com.caplin.streamlink.ErrorReason: Liberator auth module user reason 5
USER_REMOVED - Enum constant in enum class com.caplin.streamlink.ChatEventType: The event represents the event raised when a user leaves a chat channel.

V

VALUE_IS_NULL - Enum constant in enum class com.caplin.streamlink.FilterExpressionOperator: Operator used to check that a field matches a null value.
valueOf(String) - Static method in enum class com.caplin.streamlink.alerts.TriggerState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.ChatEventType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.CommandErrorType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.ConnectionState: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.ErrorReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.FilterExpressionLogicalOperator: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.FilterExpressionOperator: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.LoginFailedReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.LogLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.PayloadType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.ServiceStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.SourceStatus: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.SubjectType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.SubscriptionErrorType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.SubscriptionStatusType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.caplin.streamlink.ThrottleCommand: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.caplin.streamlink.alerts.TriggerState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.ChatEventType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.CommandErrorType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.ConnectionState: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.ErrorReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.FilterExpressionLogicalOperator: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.FilterExpressionOperator: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.LoginFailedReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.LogLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.PayloadType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.ServiceStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.SourceStatus: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.SubjectType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.SubscriptionErrorType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.SubscriptionStatusType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.caplin.streamlink.ThrottleCommand: Returns an array containing the constants of this enum class, in the order they are declared.

W

WARN - Enum constant in enum class com.caplin.streamlink.LogLevel: Used for messages which indicate a potential problem.
WebRequestParameters - Interface in com.caplin.streamlink: Contains the parameters needed to call a specific Liberator web module.
WRITE_DENIED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The client does not have permission to write to the subject.
WRITE_DENIED - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The client does not have permission to write to the subject.
WRITE_DENIED_DUE_TO_LICENSE - Enum constant in enum class com.caplin.streamlink.SubscriptionErrorType: The client cannot contribute due to the Liberator's licensing limits being exceeded.
WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED - Enum constant in enum class com.caplin.streamlink.CommandErrorType: The Liberator has detected a breach of license conditions and has rejected the attempted trade.

X

x - Variable in class com.caplin.streamlink.STuple

Y

y - Variable in class com.caplin.streamlink.STuple

A B C D E F G H I J K L M N O P R S T U V W X Y
All Classes and Interfaces|All Packages