Class SL4B_JavaScriptRttpProvider

Object
   |
   +--SL4B_AbstractRttpProvider
         |
         +--SL4B_JavaScriptRttpProvider

class SL4B_JavaScriptRttpProvider

extends SL4B_AbstractRttpProvider

Implementation of the SL4B_AbstractRttpProvider base class that uses pure AJAX (JavaScript and DHMTL) techniques to communicate with the Liberator.

Limitations

Field Detail

super_stop

Object super_stop

bFramesCreatedFlag

<static> boolean bFramesCreatedFlag

Flag to indicate whether the iframes have been created or not yet.

const_REQUEST_FRAME_ID

<static> String const_REQUEST_FRAME_ID

The identifier for the iframe used to establish the request channel with the Liberator.

const_REQUEST_FRAME_URL

<static> String const_REQUEST_FRAME_URL

The URL of the web page loaded from the Liberator that contains the XMLHttpRequest object that is used for the request channel.

const_RESPONSE_FRAME_ID

<static> String const_RESPONSE_FRAME_ID

The identifier for the iframe used to establish the response channel with the Liberator.

const_RESPONSE_FRAME_URL

<static> String const_RESPONSE_FRAME_URL

The URL of the web page loaded from the Liberator that contains the XMLHttpRequest object that is used for the response channel.

oObjectSubscriptionManager

<static> SL4B_ObjectSubscriptionManager oObjectSubscriptionManager

Object used to handle subscriptions to RTTP objects on a users behalf. This class proxies on certain calls to the manager for it to handle. These include the standard SL4B_AbstractRttpProvider calls such as SL4B_AbstractRttpProvider.getObjects().

SL4B_JavaScriptRttpProvider

SL4B_JavaScriptRttpProvider()

Constructs a SL4B_JavaScriptRttpProvider.

addConnectionListener

void addConnectionListener(l_oListener)

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.

checkConnected

void checkConnected()

Called on a timeout to check that a connection attempt that has been initiated has completed

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.

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.

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.

createConnection

void createConnection(l_bSessionReconnect)

Creates a connection of the correct type. If l_bSessionReconnect is set to true then the current connection type will be used. If l_bSessionReconnect is set to false and if the previous connection succeeded, then this connection will be retried. Otherwise the next configured connection type will be tried. If the new connection type is invalid, then a type 3 connection will be created instead.

Parameters:
l_bSessionReconnect - {boolean} Determines whether the current connection type should be used to make a new connection.

createConnectionLost

void createConnectionLost(<String> l_sReason, <boolean> bFullReconnect)

Notifies connection listeners that connection is lost and reconnects.

Parameters:
l_sReason - Brief description of why the connection was lost.
bFullReconnect - true if a full reconnect must be attempted, or false if a session reconnect may be attempted.

createObject

void 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.

deleteObject

void 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.

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.

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.

getFieldName

String getFieldName(<String> l_sFieldCode)

Gets the name of the field with the specified field code. If a field with that code was not defined within the field map, then the field code itself is returned.

Parameters:
l_sFieldCode - The code used to represent the field.

Returns:
The name of the field.

getManagedConnection

Object getManagedConnection()

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.

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()

This method will set the common domain for the client application so that real-time javascript streaming can be achieved. It also creates the internal frames that will be used to send requests to the Liberator and recieve responses from the same server.

loggedIn

void loggedIn()

Invokes the super class loggedIn method, then invokes the SL4B_ConnectionProxy.sendSync() method if latency is enabled.

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()

The logout message will jump over any other RTTP messages that have been queued up, since the communication with the Liberator is asynchronous and in most cases they are now redundant.

onLoad

void onLoad(<HtmlEvent> l_oEvent)

Invoked by the SL4B_WindowEventHandler singleton when the windows onload event fires. When this method is invoked it calls {SL4B_ConnectionProxy#start} to establish the initial connection to the Liberator.

Parameters:
l_oEvent - The HTML event object associated with the load event.

receiveMessage

void receiveMessage(<SL4B_RttpMessage> l_oRttpMessage, oRequest, oObjectNumberMapAccessor)

Invoked when an RTTP message is received from the Liberator.

Parameters:
l_oRttpMessage - the RTTP message that was received.

reconnect

void reconnect()

Reconnects by stopping the current connection and establishing another

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

void removeConnectionListener(l_oListener)

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 -

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(<SL4B_ContainerKey> l_oContainerKey, <int> l_nWindowStart, <int> l_nWindowEnd)

Sets the window for a container. Updates are only received for objects inside the window.

Parameters:
l_oContainerKey - The SL4B_ContainerKey returned by getContainer that represents the container.
l_nWindowStart - [optional] The start index of the container window
l_nWindowEnd - [optional] The end index of the container window

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(l_sObjectNames, <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_sThrottleLevel - The throttle level to be applied to the specified objects.
l_sObjectList - A space separated list of the names of the RTTP objects to be throttled.

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

stop

void stop()

Cleans up the JavaScript RTTP provider by invoking the SL4B_AbstractRttpProvider.stop() method, clearing the request queues and connection check timeouts, then calling the SL4B_ConnectionProxy.stop() method.

storeCapabilities

void storeCapabilities(l_sCapabilities)

checkWindowRange

<static> void checkWindowRange( l_nWindowStart, l_nWindowEnd)

createProvider

<static> Object createProvider(l_oLiberatorConfiguration, oOldProvider)