Package Caplin.StreamLink

The interfaces, classes and enumerators within this package provide the functionality of StreamLink. More...

Namespaces
package	Alerts
	The classes within this package provide the functionality of StreamLink alerts

Classes
class	BaseConnectionListener
	Adapter class implementing the IConnectionListener methods More...
class	BaseSubscriptionListener
	Adapter class implementing the ISubscriptionListener methods More...
class	ConsoleLogListener
	Utility class to aid debugging. More...
class	ContainerFilterFactory
	A factory for creating FilterExpressions for use in the IContainerSubscriptionParameters select method. More...
interface	IAdvancedConfiguration
	This interface provides access to advanced features of the StreamLink library. More...
interface	IChannel
	Represents a channel to a subject on the Liberator. More...
interface	IChannelListener
	Interface for receiving updates on the channel from the Liberator. More...
interface	IChatEvent
	Provides information about updates to a chat subject. More...
interface	ICommandErrorEvent
	Provides error information for commands. More...
interface	ICommandListener
	Defines the interface that you should implement to receive information on the result of a command. More...
interface	ICommandParameters
	Interface that defines parameters for a ICommandSubscription. More...
interface	ICommandSubscription
	Stored information on the subscription and lets you unpersist the command. More...
interface	IConnectionListener
	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. More...
interface	IConnectionStatusEvent
	Provides information about a change in status of the connection to the Liberator. More...
interface	IContainerElement
	Representation of a subject that is within a container. More...
interface	IContainerEvent
	Represents an update to a container subject. More...
interface	IContainerModel
	This interface defines a model that represents a container. You need to implement it to process the updateModel callback in IContainerEvents. More...
interface	IContainerSubscriptionParameters
	Defines the parameters used for Container subscriptions. To create an instance of ContainerSubscriptionParameters call the IStreamLink.CreateContainerSubscriptionParameters method. More...
interface	ICredentials
	Encapsulates authentication information used to log in to a Liberator server. More...
interface	ICredentialsProvider
	This interface defines how to provide the user credentials that StreamLink uses to log into a Liberator server. More...
interface	ICredentialsReceiver
	Interface that your custom implementation of ICredentialsProvider must call to provide credential information to StreamLink. More...
interface	IDataEvent
	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. More...
interface	IDirectoryChangeElement
	Provides information about a change to a directory element. More...
interface	IDirectoryEvent
	Provides information about a change to a directory. More...
interface	IFilterExpression
	Interface that represents a filter expression. More...
interface	IFreeFormSubscriptionParameters
	A FreeFormSubscriptionParameters instance allows you to pass parameters to subscriptions for subject types that are not records or containers. More...
interface	IKeymasterPollResponseListener
	Defines the interface that should be implemented by the application to receive KeyMaster keep alive Responses. More...
interface	ILiberatorUrlProvider
interface	ILogger
	Allows StreamLink log messages to be written to the destination of your choice. More...
interface	ILogInfo
	Stores log information including message and level of a log entry. More...
interface	ILogListener
	Interface for receiving log messages from the StreamLink application. More...
interface	INewsEvent
	Provides information about a news headline update. More...
interface	IPageElement
	Provides information about a single text change for the given row and column in a Page. More...
interface	IPageEvent
	Provides information about a change to data in a Page. More...
interface	IPermissionEvent
	Provides information about a change to permission data. More...
interface	IRawSocketFactory
	This interface allows a user application to specify a connection strategy to use when creating Type 1 (direct socket) connections. For example, to negotiate a SOCKS proxy or other custom tunneling requirements. More...
interface	IRecordSubscriptionParameters
	Defines the parameters used for Record subscriptions. More...
interface	IRecordType1Event
	Provides information about a change to type 1 data (fieldname and data pairs) in a record. More...
interface	IRecordType2Event
	Provides information about a change to type 2 data in a record. More...
interface	IRecordType3Event
	Provides information about a change to type 3 data in a record. More...
interface	IServiceStatusEvent
	Provides information about the change in status of a data service to which StreamLink is connected via the Liberator. More...
interface	ISourceStatusEvent
	Provides information about the change in status of an Integration Adapter to which StreamLink is connected via the Liberator. More...
interface	IStatisticsEvent
	Provides access to the statistics relating to an instance of StreamLink. More...
interface	IStoryEvent
	Provides information about a change to story data in a Story. More...
interface	IStreamLink
	Defines the StreamLink interface. More...
interface	IStreamLinkConfiguration
	Interface that allows the configuration of StreamLink to be defined programmatically. More...
interface	ISubscription
	Represents a subscription to a subject on the Liberator. More...
interface	ISubscriptionErrorEvent
	Provides information about a subscription error. More...
interface	ISubscriptionListener
	Interface for receiving updates to subscribed data from the Liberator. More...
interface	ISubscriptionParameters
	The base interface for defining parameters that apply to Subscriptions. More...
interface	ISubscriptionStatusEvent
	Provides information about a change in the state of a subscription. More...
interface	IWebRequestParameters
	Contains the parameters needed to call a specific Liberator web module. More...
class	LogLevel
	Enumeration that represents the available logging levels. More...
class	StreamLinkFactory
	Factory that creates StreamLink instances. More...
class	STuple

Enumerations
enum	ChatEventType { ChatEventType.MESSAGE, ChatEventType.USER_ADDED, ChatEventType.USER_REMOVED, ChatEventType.JOINED }
	Enumeration that defines the type of the IChatEvent. More...
enum	CommandErrorType {   CommandErrorType.DELETED, CommandErrorType.DISCONNECT_OCCURRED, CommandErrorType.INVALID_PARAMETERS, CommandErrorType.NOT_FOUND,   CommandErrorType.READ_DENIED, CommandErrorType.THROTTLE_FAILED, CommandErrorType.UNAVAILABLE, CommandErrorType.WRITE_DENIED,   CommandErrorType.WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED, CommandErrorType.CANCELLED }
	Enumeration defining the errors that can occur for a command. More...
enum	ConnectionState {   ConnectionState.DISCONNECTED, ConnectionState.CONNECTING, ConnectionState.FAILED, ConnectionState.CONNECTED,   ConnectionState.RETRIEVINGCREDENTIALS, ConnectionState.CREDENTIALSRETRIEVED, ConnectionState.CREDENTIALSRETRIEVALFAILED, ConnectionState.LOGGEDIN,   ConnectionState.LOGINFAILED, ConnectionState.EJECTED, ConnectionState.LOST, ConnectionState.RECONNECTED,   ConnectionState.UNREACHABLE, ConnectionState.PAUSED }
	Enumeration that defines the state of a StreamLink connection to a Liberator. More...
enum	ErrorReason {   ErrorReason.USER_CODE_1, ErrorReason.USER_CODE_2, ErrorReason.USER_CODE_3, ErrorReason.USER_CODE_4,   ErrorReason.USER_CODE_5, ErrorReason.LICENSE, ErrorReason.NONE }
	Enumeration that defines the reasons for an error being raised in a ISubscriptionErrorEvent or a ICommandErrorEvent. More...
enum	FilterExpressionLogicalOperator { FilterExpressionLogicalOperator.AND, FilterExpressionLogicalOperator.OR }
	Enumeration that represents a particular logical operation. More...
enum	FilterExpressionOperator {   FilterExpressionOperator.EQUAL, FilterExpressionOperator.NOT_EQUAL, FilterExpressionOperator.GREATER_THAN, FilterExpressionOperator.GREATER_THAN_OR_EQUAL,   FilterExpressionOperator.LESS_THAN, FilterExpressionOperator.LESS_THAN_OR_EQUAL, FilterExpressionOperator.REGULAR_EXPRESSION, FilterExpressionOperator.CASE_INSENSITIVE_REGULAR_EXPRESSION,   FilterExpressionOperator.NUMERIC_EQUAL, FilterExpressionOperator.NUMERIC_NOT_EQUAL }
	Enumeration that represents the operators that are available for a FieldFilterExpression. More...
enum	LoginFailedReason {   LoginFailedReason.INVALID_USER, LoginFailedReason.INVALID_PASS, LoginFailedReason.INVALID_IP, LoginFailedReason.ACCT_EXPIRED,   LoginFailedReason.ALREADY_LOGGED_IN, LoginFailedReason.LICENSE_SITE, LoginFailedReason.LICENSE_USER, LoginFailedReason.CREDENTIALSERROR,   LoginFailedReason.UNDEFINED }
	Enumeration that defines the reason for a failed login. More...
enum	ServiceStatus { ServiceStatus.DOWN, ServiceStatus.LIMITED, ServiceStatus.OK }
	Enumeration that defines the status of a Service. More...
enum	SourceStatus { SourceStatus.DOWN, SourceStatus.UP }
	Enumeration that defines the status of a source. More...
enum	SubjectType {   SubjectType.CHAT, SubjectType.CONTAINER, SubjectType.DIRECTORY, SubjectType.NEWS_HEADLINE,   SubjectType.NEWS_STORY, SubjectType.PAGE, SubjectType.PERMISSION, SubjectType.RECORD,   SubjectType.USER, SubjectType.UNKNOWN }
	Enumeration that represents the available subject types. More...
enum	SubscriptionErrorType {   SubscriptionErrorType.NOT_FOUND, SubscriptionErrorType.UNAVAILABLE, SubscriptionErrorType.DELETED, SubscriptionErrorType.READ_DENIED,   SubscriptionErrorType.WRITE_DENIED, SubscriptionErrorType.WRITE_DENIED_DUE_TO_LICENSE, SubscriptionErrorType.INVALID_PARAMETERS }
	Enumeration which represents the errors that can occur for a subject. More...
enum	SubscriptionStatusType { SubscriptionStatusType.STATUS_OK, SubscriptionStatusType.STATUS_LIMITED, SubscriptionStatusType.STATUS_STALE, SubscriptionStatusType.STATUS_INFO }
	Enumeration that defines the status of a subject. More...
enum	ThrottleCommand {   ThrottleCommand.UP, ThrottleCommand.DOWN, ThrottleCommand.MIN, ThrottleCommand.MAX,   ThrottleCommand.STOP, ThrottleCommand.START, ThrottleCommand.DEF }
	Enumeration that defines the available throttle levels and throttle commands. More...

Detailed Description

The interfaces, classes and enumerators within this package provide the functionality of StreamLink.

Enumeration Type Documentation

enum Caplin.StreamLink.ChatEventType

Enumeration that defines the type of the IChatEvent.

The ChatEventType can be obtained by calling getUpdateType() on a IChatEvent.

Enumerator
MESSAGE	The event contains a chat message
USER_ADDED	The event represents the event raised when a user joins a chat channel.
USER_REMOVED	The event represents the event raised when a user leaves a chat channel.
JOINED	The event represents the event raised when this StreamLink client joins a chat channel.

enum Caplin.StreamLink.CommandErrorType

Enumeration defining the errors that can occur for a command.

You can obtain the CommandErrorType by calling getError() on a ICommandErrorEvent.

Enumerator
DELETED	The subject has been deleted.
DISCONNECT_OCCURRED	The command may have been sent to server, but disconnect occurred. The command may not have been executed.
INVALID_PARAMETERS	The supplied command parameters are invalid for the command.
NOT_FOUND	The command subject could not be found.
READ_DENIED	The client does not have permission to read the subject.
THROTTLE_FAILED	The throttle command failed.
UNAVAILABLE	The subject is not available.
WRITE_DENIED	The client does not have permission to write to the subject.
WRITE_DENIED_TRADE_GROUP_LICENSE_EXCEEDED	The Liberator has detected a breach of license conditions and has rejected the attempted trade.
CANCELLED	Disconnect occurred and a command set as cancellable has been cancelled.

enum Caplin.StreamLink.ConnectionState

Enumeration that defines the state of a StreamLink connection to a Liberator.

You can obtain the ConnectionState by calling getConnectionState on a IConnectionStatusEvent.

Although hints regarding possible transitions between ConnectionStates are given, you should not imply that this is a strict contract because network conditions may cause undocumented transitions.

The generalised sequence after calling streamlink.connect() is as follows: CONNECTING -> CONNECTED -> LOGGEDIN. At any point in time the connection could be lost which would raise the LOST, at this point StreamLink would attempt to connect again to a Liberator server, starting the sequence once more.

With this in mind, it is possible to map these onto a "traffic light" component indicating connection health using the following mappings:

• RED DISCONNECTED
• GREEN LOGGEDIN
• AMBER All other ConnectionStates.

Enumerator
DISCONNECTED	Disconnected from the Liberator. When this state is raised by the StreamLink library ** all subscriptions have removed. StreamLink will not perform any activity until you call connect() on the IStreamLink object.
CONNECTING	A connection attempt is in progress. If the connection attempt is successful, a ** CONNECTED state will be raised, if the connection fails, the FAILED event will be raised.
FAILED	A connection attempt has failed. StreamLink will attempt to connect to a Liberator on ** the configured server list.
CONNECTED	A network connection has been established to the Liberator. StreamLink will now attempt ** to log in to the Liberator session.
RETRIEVINGCREDENTIALS	StreamLink is attempting to obtain a set of credentials to log in to the server.
CREDENTIALSRETRIEVED	StreamLink has successfully retrieved the credentials.
CREDENTIALSRETRIEVALFAILED	StreamLink has failed to retrieve the credentials.
LOGGEDIN	The client is now logged into the Liberator. In this state it is possible for ** StreamLink applications to receive subscription updates and receive responses to commands.
LOGINFAILED	The client could not login to the Liberator. StreamLink will not perform any ** more connection attempts and will switch to the DISCONNECTED state.
EJECTED	The client has been ejected from the Liberator. StreamLink will not perform any ** more connection attempts and will switch to the DISCONNECTED state.
LOST	The connection to the Liberator has been lost. StreamLink will attempt to connect and ** establish a new session with a configured Liberator.
RECONNECTED	The Liberator session has been reconnected. This should be treated as an informational ** event, StreamLink will switch to the LOGGEDIN state to simplify implementation of your application (see the traffic light example above).
UNREACHABLE	A connection to the Liberator is not possible due to no network being available.
PAUSED	The connection has been paused by the application. This state is a direct result of ** the application causing IStreamLink.Pause. StreamLink is held in a "frozen" state pending a call to IStreamLink.Resume.

enum Caplin.StreamLink.ErrorReason

Enumeration that defines the reasons for an error being raised in a ISubscriptionErrorEvent or a ICommandErrorEvent.

Enumerator
USER_CODE_1	Liberator auth module user reason 1
USER_CODE_2	Liberator auth module user reason 2
USER_CODE_3	Liberator auth module user reason 3
USER_CODE_4	Liberator auth module user reason 4
USER_CODE_5	Liberator auth module user reason 5
LICENSE	Licence failure
NONE	No Reason

enum Caplin.StreamLink.FilterExpressionLogicalOperator

Enumeration that represents a particular logical operation.

Enumerator
AND	Represents that a logical AND will be performed. A record will only be returned if it matches all of the FilterExpressions that have been added to the LogicalFilterExpression.
OR	Represents that a logical OR will be performed. A record will be returned if it matches any of the FilterExpressions that have been added to the LogicialFilterExpression.

enum Caplin.StreamLink.FilterExpressionOperator

Enumeration that represents the operators that are available for a FieldFilterExpression.

Enumerator
EQUAL	Operator used to check for an exact match between a field and a value.
NOT_EQUAL	Operator used to check that a field does not match a particular value.
GREATER_THAN	Operator used to check that a numeric field is greater than a particular value.
GREATER_THAN_OR_EQUAL	Operator used to check that a numeric field is greater than or equal to a particular value.
LESS_THAN	Operator used to check that a numeric field is less than a particular value.
LESS_THAN_OR_EQUAL	Operator used to check that a numeric field is less than or equal to a particular value.
REGULAR_EXPRESSION	Operator used to check that a string field matches a particular regular expression.
CASE_INSENSITIVE_REGULAR_EXPRESSION	Operator used to check that a string field matches a particular regular expression where an exact case match is not necessary.
NUMERIC_EQUAL	Operator used to check for an exact match between a numeric field and value.
NUMERIC_NOT_EQUAL	Operator used to check that a numeric field does not match a particular value.

enum Caplin.StreamLink.LoginFailedReason

Enumeration that defines the reason for a failed login.

The LoginFailedReason will be provided by calling getLoginFailReason on a IConnectionStatusEvent.

Enumerator
INVALID_USER	StreamLink can not log in to the Liberator because the user's username is incorrect.
INVALID_PASS	StreamLink can not log in to the Liberator because the user's password is incorrect.
INVALID_IP	StreamLink can not log in to the Liberator because the connection attempts is made from an invalid IP address. *
ACCT_EXPIRED	StreamLink can not log in to the Liberator because the user's account has expired.
ALREADY_LOGGED_IN	StreamLink can not log in to the Liberator because the user is already logged in
LICENSE_SITE	StreamLink can not log in to the Liberator due to licensing limitations.
LICENSE_USER	StreamLink can not log in to the Liberator due to licensing limitations.
CREDENTIALSERROR	An error occurred whilst retrieving the credentials that are used to log in to the Liberator
UNDEFINED	This value is undefined

enum Caplin.StreamLink.ServiceStatus

Enumeration that defines the status of a Service.

The ServiceStatus will be provided by calling getServiceStatus on a IServiceStatusEvent.

The three states that are possible for a Liberator data service are:

• OK - All of the data sources that make up the service are up.
• Down - One or more required data sources for the service are down.
• Limited - One or more non-required data sources for the service are down.

See Also

IServiceStatusEvent

Enumerator
DOWN	Indicates that a service is down, which means that at least one of the required sources ** defined for the service are down.
LIMITED	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).
OK	Indicates that the service is OK, which means that all the required and non required ** sources defined for the service are up.

enum Caplin.StreamLink.SourceStatus

Enumeration that defines the status of a source.

The SourceStatus will be provided by calling getSourceStatus on a ISourceStatusEvent.

Enumerator
DOWN	A source has gone up.
UP	A source has gone down.

enum Caplin.StreamLink.SubjectType

Enumeration that represents the available subject types.

The SubjectType can be obtained by calling getType() on a IContainerElement or IDirectoryChangeElement.

It is also a parameter to createSubject() in IStreamLink.

Enumerator
CHAT	Chat subject type.
CONTAINER	Container subject type.
DIRECTORY	Directory subject type.
NEWS_HEADLINE	News headline subject type.
NEWS_STORY	News story subject type.
PAGE	Page subject type.
PERMISSION	Permission subject type.
RECORD	Record subject type.
USER	User subject type.
UNKNOWN	The subject type is unknown.

enum Caplin.StreamLink.SubscriptionErrorType

Enumeration which represents the errors that can occur for a subject.

The SubscriptionErrorType will be provided on a onSubscriptionError callback to a ISubscriptionListener.

Enumerator
NOT_FOUND	The subject could not be found.
UNAVAILABLE	The subject was not available.
DELETED	The subject has been deleted.
READ_DENIED	The client does not have permission to read the subject.
WRITE_DENIED	The client does not have permission to write to the subject.
WRITE_DENIED_DUE_TO_LICENSE	The client cannot contribute due to the Liberator's licensing limits being exceeded.
INVALID_PARAMETERS	Supplied parameters are invalid for this subject type.

enum Caplin.StreamLink.SubscriptionStatusType

Enumeration that defines the status of a subject.

The SubscriptionStatusType will be provided by calling getStatus() on a ISubscriptionStatusEvent.

Enumerator
STATUS_OK	The data associated with the subject is correct and up-to-date.
STATUS_LIMITED	One of the sources of data for the subject is not available. This may affect the subject's data.
STATUS_STALE	The subject's data may not be correct and up-to-date.
STATUS_INFO	An informational message about the subject (usually sent by the DataSource).

enum Caplin.StreamLink.ThrottleCommand

Enumeration that defines the available throttle levels and throttle commands.

A ThrottleCommand is passed as a parameter to the throttleSubject() and throttleEverything() methods of IStreamLink.

For an explanation of throttling, refer the Throttling section of the document StreamLink Overview.

Enumerator
UP	Increase the throttle level.
DOWN	Decrease the throttle level.
MIN	Set the throttle level to the minimum amount of throttling.
MAX	Set the throttle level to the maximum amount of throttling.
STOP	Stop sending updates to the client.
START	Start sending updates to the client again.
DEF	Set the throttle level to the default level.