Class SL4B_AbstractRttpProvider

Object
   |
   +--SL4B_AbstractRttpProvider

Direct Known Subclasses:

SL4B_FailoverRttpProvider, SL4B_AbstractObjectRttpProvider, SL4B_JavaScriptRttpProvider, SL4B_TestRttpProvider, SL4B_AbstractJavaRttpProvider, SL4B_SlaveFrameRttpProvider

class SL4B_AbstractRttpProvider

Base class that should be extended by any class that provides access to a Liberator. An implementation will ususally wrap another object, such as an applet, or an XmlHttpRequest which is responsible for actually connecting to, and communicating with, the Liberator.

This class provides a standard interface for communicating with a Liberator, regardless of how the underlying object actually handles it.

The implementation of the SL4B_AbstractRttpProvider that is used is automatically created according to the librarys configuration. To get access to this object, the SL4B_Accessor.getRttpProvider() method should be used.

The SL4B_ContributionFieldData class should be used to define the field name/value pairs that are to be contributed for a specific RTTP object using the SL4B_AbstractRttpProvider.contribObject() method.

The SL4B_ObjectType, SL4B_ThrottleLevel and SL4B_DebugLevel singleton classes define the possible values for the object type, throttle level and debug level respectively.

The SL4B_ConnectionListener interface should be implemented by any classes that are interested in receiving notifications about the RTTP providers connection to the Liberator.

Field Detail

const_OBJECT_NAME_DELIMITER

<static> String const_OBJECT_NAME_DELIMITER

The delimiter character that is used to separate object names in requests for multiple objects.

SL4B_AbstractRttpProvider

SL4B_AbstractRttpProvider()

Constructs an SL4B_AbstractRttpProvider.

addConnectionListener

void addConnectionListener(<SL4B_ConnectionListener> l_oConnectionListener)

Adds the specified SL4B_ConnectionListener to the collection of connection listeners that will be notified when a connection event occurs. It is possible to add the same listener multiple times, in which case it will be notified of a single connection event multiple times (equal to the number of times it has been registered).

Parameters:
l_oConnectionListener - The connection listener to be registered with this SL4B_AbstractRttpProvider.

blockObjectListeners

void blockObjectListeners(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList)

Stops the specified SL4B_AbstractSubscriber from receiving updates for the specified objects. The Liberator will continue to send the updates, however they are not passed onto the subscriber.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will have updates to its requested objects blocked.
l_sObjectList - [optional] A space separated list of the names of the RTTP objects to be have their updates blocked. If omitted, all the objects that the SL4B_AbstractSubscriber has subscribed to will have their updates blocked.

clearContainerWindow

void clearContainerWindow(<Object> l_oContainerKey)

Clears the container window. This method changes the container to return all data rather than only the requested window

Parameters:
l_oContainerKey - The unique token identifying the container, returned by the original getContainer() call.

clearObjectListeners

void clearObjectListeners(<SL4B_AbstractSubscriber> l_oSubscriber, <int> l_nDiscardTime)

Removes all the subscriptions for the specified SL4B_AbstractSubscriber.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will have all its object requests discarded.
l_nDiscardTime - [optional] The length of time (in milliseconds) to wait before discarding the subscriptions from the Liberator. If this is omitted, a value of 10000 is used.

connect

void connect()

Invoked when a connection to the Liberator needs to be established. It is the responsibility of the SL4B_AbstractRttpProvider subclass to know when it can safely invoke this method.

Any concrete class that extends SL4B_AbstractRttpProvider must have an implementation for this method.

connected

void connected()

This method must be invoked when a connection to the Liberator has been established. It invokes the SL4B_AbstractCredentialsProvider.getCredentials() method, passing in a reference to this object. The credentials provider is responsible for gettings the login details, then passing them to this RTTP provider by invoking its SL4B_AbstractRttpProvider.login() method.

contribObject

void contribObject(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <SL4B_ContributionFieldData> l_oFieldData)

Contributes the specified field name/value data to the RTTP object with the specified name. The specified SL4B_AbstractSubscriber will be informed if the contribution is successful or not.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed whether the contribution was successful or not.
l_sObjectName - The name of the RTTP object the specified data will be contributed to.
l_oFieldData - The field name/value pair data to be contributed.

Throws:
- SL4B_Exception If the specified contribution field data object is null or empty.

createFieldListForAutoDirectory

Object createFieldListForAutoDirectory(<String> l_sFilter, <boolean> l_bIsUpdateFilter, <String> l_sFieldList)

Creates a field list that contains the automatic subscription fields, a filter (if specified) and the specified field list.

Parameters:
l_sFilter - The filter to be added to the field list. This can be null or undefined.
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true.
l_sFieldList - [optional] A comma separated list of fields.

createFieldListForContainer

Object createFieldListForContainer(l_sUniqueId, l_sFieldList, l_nWindowStart, l_nWindowEnd)

createObject

boolean createObject(<String> l_sObjectName, <String> l_sRttpType)

Attempts to create an RTTP object with the specified name and type on the Liberator.

Parameters:
l_sObjectName - The name of the RTTP object to be created on the Liberator.
l_sRttpType - The type of object to be created. The SL4B_ObjectType singleton defines the possible values.

Returns:
true if the object was successfully created, otherwise false.

credentialsRetrieved

void credentialsRetrieved()

This method must be invoked once the credentials that will be used to log into the Liberator have been retrieved, but before the login message is sent. It will ensure that all the registered SL4B_ConnectionListeners are notified of the event.

debug

void debug(<String> l_sLevelName, <String> l_sMessage)

Adds the specified debug message to the debug log provided the specified level is of equal or higher priority to the current debug level of the RTTP provider (see SL4B_AbstractRttpProvider.setDebugLevel()).

SL4B_DebugLevel defines all the available debug levels.

Parameters:
l_sLevelName - The name of the debug level at which the message should be output to the debug log.
l_sMessage - The message to be output to the debug log.

deleteObject

boolean deleteObject(<String> l_sObjectName)

Attempts to delete the RTTP object with the specified name from the Liberator.

Parameters:
l_sObjectName - The name of the RTTP object to be deleted.

Returns:
true if the object was successfully deleted, otherwise false.

deregisterSlave

void deregisterSlave(<String> l_sSlaveFrameId, <SL4B_SlaveFrameRttpProvider> l_oSlaveFrameRttpProvider, <SL4B_SubscriptionManager> l_oSlaveFrameSubscriptionManager)

Invoked when a SL4B_SlaveFrameRttpProvider wants to deregister itself with the master frames RTTP provider.

Parameters:
l_sSlaveFrameId - The identifier for the slave frame.
l_oSlaveFrameRttpProvider - The RTTP provider for the slave frame.
l_oSlaveFrameSubscriptionManager - The subscription manager for the slave frame.

disableWTStatsTimeout

void disableWTStatsTimeout(<int> l_nTime)

Disables the WTStats timeout for the specfied period of time. This timeout is one of the mechanisms used to detect connection problems over RTTP. It may be necessary to disable it for a brief period of time if lots of objects are requested simultaneously, since the images for these requests may prevent the WTStats NOOP from being processed until after the timeout period has expired, resulting in an unnecessary reconnection.

Parameters:
l_nTime - The number of milliseconds the WTStats timeout will be disabled for.

getAutoDirectory

void getAutoDirectory(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sDirectoryName, <String> l_sFieldList, <String> l_sFilter, <boolean> l_bIsUpdateFilter)

Requests the specified directory from the Liberator.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified object.
l_sDirectoryName - The name of the RTTP object to be requested from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified objects. If this argument is omitted, all the fields will be requested.
l_sFilter - [optional] The filter to apply to the directory listing (see SL4B_AbstractRttpProvider.getFilteredObject() for syntax information).
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true (see SL4B_AbstractRttpProvider.getFilteredObject() for more information).

getContainer

Object getContainer(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sContainerName, <String> l_sFieldList, <int> l_nWindowStart, <int> l_nWindowEnd)

Requests the specified container from the Liberator. Please see the Container Object section of the documentation for more information.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified object.
l_sContainerName - The name of the RTTP object to be requested from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified objects. If this argument is omitted, all the fields will be requested.
l_nWindowStart - [optional] The start index of the container window.
l_nWindowEnd - [optional] The end index of the container window.

Returns:
a unique token identifying the container request, used for setting the container window and removing the container.

getFieldNames

String getFieldNames()

Gets a comma separated list of the names of all the fields that are available from the Liberator.

Returns:
A comma separated list of all the fields availalble from the Liberator.

getFilteredNewsHeadline

void getFilteredNewsHeadline(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFilter)

Requests the specified RTTP news headline object, with the specified filter, from the Liberator. Updates for these objects will be received by the specified SL4B_AbstractSubscriber.



Character	Meaning
[space]	or
|	or
+	and
&	and
-	and
=	equals
!	not
~	contains
'	start or end of free text search string
"	start or end of free text search string
()	parenthesis—perform these filters first

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified object.
l_sObjectName - The name of the RTTP news headline object to be requested from the Liberator.
l_sFilter - The filter that will be applied to the headlines (see method documentation above for syntax information).

getFilteredNewsHeadlines

void getFilteredNewsHeadlines(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFilter)

Requests the specified RTTP news headline objects, with the specified filter, from the Liberator. Updates for these objects will be received by the specified SL4B_AbstractSubscriber.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP news headline objects to be requested from the Liberator.
l_sFilter - The filter that will be applied to the headlines (see SL4B_AbstractRttpProvider.getFilteredNewsHeadline() for syntax information).

getFilteredObject

void getFilteredObject(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFilter, <boolean> l_bIsUpdateFilter, <String> l_sFieldList)

Requests the specified list of fields for the specified RTTP object, using the specified filter, from the Liberator. Updates for that object will be received by the specified SL4B_AbstractSubscriber.

Note: Please use the SL4B_AbstractRttpProvider.getFilteredNewsHeadline() method to request a news headline object with a filter.



Filter syntax

The filter allows one or more of the object fields to be restricted, reducing the number of field updates that will be received. For example getFilteredObject(this, "DEMO/MSFT", "(dLast > 50) & (dVolumeAcc > 1000)", true, "dLast, dVolumeAcc") will only receive updates where dLast is greater than 50, and/or dVolumeAcc is greater than 1000. The following tables list the valid filter syntax:



Character	Meaning
¦	or
&	and
=	equals
!	not
<	less than
>	greater than
()	parenthesis—perform these filters first




Image Filters Versus Update Filters

There are two ways in which a filter can be applied, which is controlled by the l_bIsUpdateFilter argument. If the l_bIsUpdateFilter argument is omitted, an update filter will be applied.

Image Filter

An image filter is applied after the data within a particular object update has been applied to the image of that object. If the filter is dependent on a field that is not present within an update, then the cached value for that field will be used to determine whether the update matches the filter.



Update Filter

An update filter is applied to the data within a particular object update only. If the filter is dependent on a field that is not present within an update, the filter will fail, and the client will not be sent the update.



Example Data

The following table provides an example of difference in behaviour between these two types of filter (in both cases the filter (BidSize > 1000) & (AskSize > 1000) is used):



Bid	BidSize	AskSize	Ask	Matches Image Filter?	Matches Update Filter?
54.25	1500	2000	55.00	Yes	Yes
54.00	2000	{none}	{none}	Yes	No
54.50	500	{none}	{none}	No	No
54.25	1500	54.75	500	No	No
54.00	2000	54.75	1500	Yes	Yes

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified object.
l_sObjectName - The name of the RTTP object to be requested from the Liberator.
l_sFilter - A set of conditions for limiting the updates that will be returned for the server.
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true.
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified object. If this argument is omitted, all the fields will be requested.

getFilteredObjects

void getFilteredObjects(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFilter, <boolean> l_bIsUpdateFilter, <String> l_sFieldList)

Requests the specified list of fields for the specified RTTP objects, using the specified filter, from the Liberator. Updates for these objects will be received by the specified SL4B_AbstractSubscriber.

Note: Please use the SL4B_AbstractRttpProvider.getFilteredNewsHeadlines() method to request multiple news headline objects with a filter.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP objects to be requested from the Liberator.
l_sFilter - A set of conditions for limiting the updates that will be returned for the server (see SL4B_AbstractRttpProvider.getFilteredObject() for syntax information).
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true (see SL4B_AbstractRttpProvider.getFilteredObject() for more information).
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified objects. If this argument is omitted, all the fields will be requested.

getLiberatorConfiguration

Object getLiberatorConfiguration()

getListener

String getListener(<SL4B_AbstractSubscriber> l_oSubscriber)

Gets the listener string that will be used by the RTTP provider to uniquely indentify the SL4B_AbstractSubscriber that will be notified of updates. This string can be evaluated by the RTTP provider to get a reference the actual subscriber object that an update will be sent to, and must include the location of the subscriber within the DOM. This identifier is obtained by invoking the SL4B_AbstractSubscriber.getIdentifier() method.

For backwards compatibility, it is possible for a string to be used as a subscriber instead, in which case this method will return the specified string as the listener.

Parameters:
l_oSubscriber - - The subscriber that needs to be registered with the RTTP provider.

Returns:
The DOM identifier that will be evaluated by the RTTP provider to send updates to the specified subscriber.

Throws:
- SL4B_Exception If the specified subscriber is not an instance of SL4B_AbstractSubscriber, and is not a String.

getObject

void getObject(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFieldList)

Requests the specified list of fields for the specified RTTP object from the Liberator. Updates for that object will be received by the specified SL4B_AbstractSubscriber.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified object.
l_sObjectName - The name of the RTTP object to be requested from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified object. If this argument is omitted, all the fields will be requested.

getObjects

void getObjects(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFieldList)

Requests the specified list of fields for the specified RTTP objects from the Liberator. Updates for these objects will be received by the specified SL4B_AbstractSubscriber.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP objects to be requested from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be requested for the specified objects. If this argument is omitted, all the fields will be requested.

getObjectType

void getObjectType(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName)

Requests the specified type of the RTTP object from the Liberator. The specified SL4B_AbstractSubscriber will be notified of the objects type.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will be informed of the specified objects type.
l_sObjectName - The name of the RTTP object to be requested from the Liberator.

getVersion

String getVersion()

Gets the version number of the RTTP provider.

Returns:
The version number for the RTTP provider that is being used.

getVersionInfo

String getVersionInfo()

Gets the full version details of the RTTP provider. This will include its version number and build date and time.

Returns:
The full version information for the RTTP provider that is being used.

initialise

void initialise()

Invoked immediately after the concrete SL4B_AbstractRttpProvider has been set. This method should be invoked whilst the web page is still loading (i.e. it is still safe to add elements to the DOM using document.write). It should be used to initialise the RTTP communication mechanism that is going to be used (e.g. download the RTTP applet).

Any concrete class that extends SL4B_AbstractRttpProvider must have an implementation for this method.

loggedIn

void loggedIn()

This method must be invoked when the RTTP provider has successfully logged into a Liberator. It will invoke the SL4B_SubscriptionManagerAccessor.ready() method to ensure that all the subscribers are informed that they can now request data.

login

void login(<String> l_sUsername, <String> l_sPassword)

This method must be invoked by the SL4B_AbstractCredentialsProvider that was responsible for getting the username and password to login to the Liberator. Once the credentials have been validated, the SL4B_SubscriptionManager.ready() method should be invoked.

Parameters:
l_sUsername - The username to use to login to the Liberator.
l_sPassword - The password (or token) to use to login to the Liberator.

logout

void logout()

Logs out of the Liberator. No more updates will be received.

This method is not intended for direct use by end users since it does not handle any other necessary cleanup operations. End users are advised to use the SL4B_AbstractRttpProvider.stop() method instead.

reconnect

void reconnect()

Invoked when a connection to the Liberator is lost and the user wants to attempt a reconnect. It is the responsibility of the SL4B_AbstractRttpProvider subclass to know when it can safely invoke this method.

Any concrete class that extends SL4B_AbstractRttpProvider must have an implementation for this method.

registerSlave

void registerSlave(<String> l_sSlaveFrameId, <SL4B_SlaveFrameRttpProvider> l_oSlaveFrameRttpProvider, <SL4B_SubscriptionManager> l_oSlaveFrameSubscriptionManager)

Invoked when a SL4B_SlaveFrameRttpProvider wants to register itself with the master frames RTTP provider.

Parameters:
l_sSlaveFrameId - The identifier for the slave frame.
l_oSlaveFrameRttpProvider - The RTTP provider for the slave frame.
l_oSlaveFrameSubscriptionManager - The subscription manager for the slave frame.

removeAutoDirectory

void removeAutoDirectory(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sDirectoryName, <String> l_sFieldList, <String> l_sFilter, <boolean> l_bIsUpdateFilter)

Cancels the specified SL4B_AbstractSubscribers subscription for the given directory

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified object.
l_sDirectoryName - The name of the RTTP object to be discarded from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be discarded for the specified object. If this argument is omitted, all the fields will be discarded.
l_sFilter - [optional] The filter that was applied to the directory listing (see SL4B_AbstractRttpProvider.getFilteredObject() for syntax information).
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true (see SL4B_AbstractRttpProvider.getFilteredObject() for more information).

removeConnectionListener

boolean removeConnectionListener(<SL4B_ConnectionListener> l_oConnectionListener)

Removes the specified SL4B_ConnectionListener from the collection of connection listeners that will be notified when a connection event occurs. If the connection listener has been registered multiple times, only the first occurrance will be removed.

Parameters:
l_oConnectionListener - The connection listener to be deregistered with this SL4B_AbstractRttpProvider.

Returns:
true if the connection listener had previously been registered, otherwise false.

removeContainer

void removeContainer(<SL4B_AbstractSubscriber> l_oSubscriber, <Object> l_oContainerKey)

Cancels the specified SL4B_AbstractSubscribers subscription for the given container.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified object.
l_oContainerKey - The unique token identifying the container, returned by the original getContainer() call.

removeFilteredNewsHeadline

void removeFilteredNewsHeadline(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFilter)

Cancels the specified SL4B_AbstractSubscribers subscription for the specified RTTP news headline object with the specified filter from the Liberator.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified object.
l_sObjectName - The name of the RTTP news headline object to be discarded from the Liberator.
l_sFilter - The filter that was applied to the headlines when the subscription was made (see SL4B_AbstractRttpProvider.getFilteredNewsHeadline() for syntax information).

removeFilteredNewsHeadlines

void removeFilteredNewsHeadlines(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFilter)

Cancels the specified SL4B_AbstractSubscribers subscription for the specified RTTP news headline objects with the specified filter from the Liberator.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP news headline objects to be discarded from the Liberator.
l_sFilter - The filter that was applied to the headlines when the subscription was made (see SL4B_AbstractRttpProvider.getFilteredNewsHeadline() for syntax information).

removeFilteredObject

void removeFilteredObject(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFilter, <boolean> l_bIsUpdateFilter, <String> l_sFieldList)

Cancels the specified SL4B_AbstractSubscribers subscription for the specified RTTP object, using the specified filter, from the Liberator.

Note: Please use the SL4B_AbstractRttpProvider.removeFilteredNewsHeadline() method to discard a news headline object with a filter.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified object.
l_sObjectName - The name of the RTTP object to be discarded from the Liberator.
l_sFilter - A set of conditions for limiting the updates that will be returned for the server (see SL4B_AbstractRttpProvider.getFilteredObject() for syntax information).
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true (see SL4B_AbstractRttpProvider.getFilteredObject() for more information).
l_sFieldList - [optional] A comma separated list of the fields to be discarded for the specified object. If this argument is omitted, all the fields will be discarded.

removeFilteredObjects

void removeFilteredObjects(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFilter, <boolean> l_bIsUpdateFilter, <String> l_sFieldList)

Cancels the specified SL4B_AbstractSubscribers subscription for the specified RTTP objects, using the specified filter, from the Liberator.

Note: Please use the SL4B_AbstractRttpProvider.removeFilteredNewsHeadlines() method to discard multiple news headline objects with a filter.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP objects to be discarded from the Liberator.
l_sFilter - A set of conditions for limiting the updates that will be returned for the server (see SL4B_AbstractRttpProvider.getFilteredObject() for syntax information).
l_bIsUpdateFilter - [optional] true if an update only filter must be used, otherwise false. If this argument is omitted, it will default to true (see SL4B_AbstractRttpProvider.getFilteredObject() for more information).
l_sFieldList - [optional] A comma separated list of the fields to be discarded for the specified objects. If this argument is omitted, all the fields will be discarded.

removeObject

void removeObject(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectName, <String> l_sFieldList)

Cancels the specified SL4B_AbstractSubscribers subscription for the list of fields for the specified RTTP object. This can be used to discard a subset of the fields that have previously been requested for the object.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified object.
l_sObjectName - The name of the RTTP object to be discarded from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be discarded for the specified object. If this argument is omitted, all the fields will be discarded.

removeObjects

void removeObjects(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList, <String> l_sFieldList)

Cancels the specified SL4B_AbstractSubscribers subscription for the list of fields for the specified RTTP objects. This can be used to discard a subset of the fields that have previously been requested for these objects.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of updates to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP objects to be discarded from the Liberator.
l_sFieldList - [optional] A comma separated list of the fields to be discarded for the specified objects. If this argument is omitted, all the fields will be discarded.

removeSubscriber

void removeSubscriber(<SL4B_AbstractSubscriber> l_oSubscriber)

Cancels the specified SL4B_AbstractSubscribers subscription for all RTTP objects and fields and removed.

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will cease to be informed of all updates and be removed.

setContainerWindow

void setContainerWindow(<Object> l_oContainerKey, <int> l_nWindowStart, <int> l_nWindowEnd)

Changes the container window (ie the page of the container that is subscribed to).

Parameters:
l_oContainerKey - The unique token identifying the container, returned by the original getContainer() call.
l_nWindowStart - The start index of the container window.
l_nWindowEnd - The end index of the container window.

setDebugLevel

boolean setDebugLevel(<String> l_sLevelName)

Sets the level that is used to determine whether or not a debug message is added to the debug log or not.

SL4B_DebugLevel defines all the available debug levels.

Parameters:
l_sLevelName - The name of the debug level to be set.

Returns:
true if the specified level was successfully set, false otherwise.

setGlobalThrottle

void setGlobalThrottle(<String> l_sThrottleLevel)

Sets the throttle level that will be applied to all the objects that the client subscribes to. This level will not be used for objects that have not had their throttle level set specifically, using either SL4B_AbstractRttpProvider.setThrottleObject() or SL4B_AbstractRttpProvider.setThrottleObjects(). To call any of those methods on the AbstractRttpProvider get an instance of it from SL4B_Accessor.getRttpProvider().

SL4B_ThrottleLevel defines all the available throttle levels.

Parameters:
l_sThrottleLevel - The throttle level to be applied to for all requested objects.

Throws:
- SL4B_Exception if l_sThrottleLevel is not a valid throttle level.

setThrottleObject

void setThrottleObject(<String> l_sObjectName, <String> l_sThrottleLevel)

Sets the throttle level for the specified RTTP object.

SL4B_ThrottleLevel defines all the available throttle levels. Call this methods on an instance of AbstractRttpProvider, which you can get from SL4B_Accessor.getRttpProvider().

Parameters:
l_sObjectName - The name of the RTTP object to be throttled.
l_sThrottleLevel - The throttle level to be applied to the specified object.

Throws:
- SL4B_Exception if l_sThrottleLevel is not a valid throttle level.

setThrottleObjects

void setThrottleObjects(<String> l_sObjectList, <String> l_sThrottleLevel)

Sets the throttle level for all of the specified RTTP objects.

SL4B_ThrottleLevel defines all the available throttle levels. Call this methods on an instance of AbstractRttpProvider, which you can get from SL4B_Accessor.getRttpProvider().

Parameters:
l_sObjectList - A space separated list of the names of the RTTP objects to be throttled.
l_sThrottleLevel - The throttle level to be applied to the specified objects.

Throws:
- SL4B_Exception if l_sThrottleLevel is not a valid throttle level.

stop

void stop()

Invoking this method causes the connection to the Liberator to be closed, and any necessary clean up to occur. This method is suitable for use by end users.

This method is also invoked by the SL4B_AbstractRttpProvider.internalStop() method when the web page is being unloaded. This method invokes the SL4B_AbstractRttpProvider.logout() method to ensure the RTTP connection is cleaned up properly, then deregisters from the SL4B_FrameRegistrarAccessor.

unblockObjectListeners

void unblockObjectListeners(<SL4B_AbstractSubscriber> l_oSubscriber, <String> l_sObjectList)

Allows the specified SL4B_AbstractSubscriber to start receiving updates for the specified objects which had previously been blocked (see SL4B_AbstractRttpProvider.blockObjectListeners()).

Parameters:
l_oSubscriber - The SL4B_AbstractSubscriber that will have updates to its requested objects unblocked.
l_sObjectList - [optional] A space separated list of the names of the RTTP objects to be have their updates unblocked. If omitted, all the objects that the SL4B_AbstractSubscriber has subscribed to will have their updates unblocked.