Class SL4B_SlaveFrameRttpProvider

Object
   |
   +--SL4B_AbstractRttpProvider
         |
         +--SL4B_SlaveFrameRttpProvider

class SL4B_SlaveFrameRttpProvider

extends SL4B_AbstractRttpProvider

An RTTP provider for use within slave frames, that proxies all client requests to the RTTP provider within the master frame. This class is also responsible for queuing up any clients requests until the master becomes available.

Constructor Detail

SL4B_SlaveFrameRttpProvider

SL4B_SlaveFrameRttpProvider()

Constructs a new SL4B_SlaveFrameRttpProvider.

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.

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.

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.

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.

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.

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.

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.

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.

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.

masterClosing

void masterClosing()

Called when the master frame is closing. This method is called by the SL4B_FrameRegistrarAccessor. This method should null down the reference to the master and handle all future client requests until the master comes back.

masterRegistered

void masterRegistered(l_oMasterFrameRttpProvider)

Called by the SL4B_FrameRegistrarAccessor when the master frame loads or as a consequence of the slave calling SL4B_FrameRegistrarAccessor.registerSlaveFrame().

Parameters:
l_oMasterFrameRttpProvider - {SL4B_AbstractRttpProvider} A reference to the RTTP provider defined within the master frame.

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.

register

void register()

Registers this frame as a slave frame with the SL4B_FrameRegistrarAccessor.

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.

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

Invoked when this frame is closing. It deregisters the frame with the SL4B_FrameRegistrarAccessor. And removes any subscribers in this specific frame.

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.