UM Java API  6.16
com.latencybusters.lbm.LBMContextAttributes Class Reference
Inheritance diagram for com.latencybusters.lbm.LBMContextAttributes:

Public Member Functions

 LBMContextAttributes (String contextName) throws LBMException
 
 LBMContextAttributes () throws LBMException
 
void setFromXml (String contextName) throws LBMException
 
void dispose ()
 
LBMConfigOption[] dumpAttributeList ()
 
String getValue (String attributeName) throws LBMException
 
void setValue (String attributeName, String attributeValue) throws LBMException
 
Object setProperty (String attributeName, String attributeValue)
 
void load (InputStream inStream) throws IOException
 
void setObjectRecycler (LBMObjectRecyclerBase objRec, Object objRecCbArg)
 
void setSourceNotification (LBMSourceNotification cb, Object cbarg)
 
void clearSourceNotification ()
 
void enableSourceNotification ()
 
void disableSourceNotification ()
 
void setContextSourceEventCallback (LBMContextSourceEventCallback cb)
 
void setContextSourceEventCallback (LBMContextSourceEventCallback cb, Object cbArg)
 
void setContextSourceEventCallback (LBMContextSourceEventCallback cb, LBMEventQueue evq)
 
void setContextSourceEventCallback (LBMContextSourceEventCallback cb, Object cbArg, LBMEventQueue evq)
 
void setContextEventCallback (LBMContextEventCallback cb)
 
void setContextEventCallback (LBMContextEventCallback cb, Object cbArg)
 
void setContextEventCallback (LBMContextEventCallback cb, LBMEventQueue evq)
 
void setContextEventCallback (LBMContextEventCallback cb, Object cbArg, LBMEventQueue evq)
 
void setImmediateMessageCallback (LBMImmediateMessageCallback cb)
 
void setImmediateMessageCallback (LBMImmediateMessageCallback cb, LBMEventQueue evq)
 
void setImmediateMessageCallback (LBMImmediateMessageCallback cb, Object cbArg)
 
void setImmediateMessageCallback (LBMImmediateMessageCallback cb, Object cbArg, LBMEventQueue evq)
 
void setSourceCostCallback (LBMSourceCostCallback cb)
 
void setSourceCostCallback (LBMSourceCostCallback cb, Object cbArg)
 
void setTransportMappingCallback (LBMTransportMappingCallback cb)
 
void setTransportMappingCallback (LBMTransportMappingCallback cb, Object cbArg)
 
void setResolverEventCallback (LBMResolverEventCallback cb, Object cbArg)
 
void setResolverEventCallback (LBMResolverEventCallback cb)
 
void setReceiverLivenessNotificationCallbacks (UMEReceiverLivenessCreationCallback creationCb, UMEReceiverLivenessDeletionCallback deletionCb, Object cbArg) throws LBMException
 
UMEReceiverLivenessCreationCallback getRcvLivenessCreateCB ()
 
UMEReceiverLivenessDeletionCallback getRcvLivenessDeleteCB ()
 
Object getRcvLivenessClientd ()
 
Object getResolverEventCallbackObject ()
 

Protected Member Functions

void finalize ()
 

Detailed Description

Encapsulates the set of default LBM context attributes.

Constructor & Destructor Documentation

com.latencybusters.lbm.LBMContextAttributes.LBMContextAttributes ( String  contextName) throws LBMException

Create and fill an LBMContextAttributes object with the current default values for the given context name.

Parameters
contextNameContext name string. Is written into the attributes object.
Exceptions
LBMExceptionif the contextName is not permitted by the configuration or other operational failure.
com.latencybusters.lbm.LBMContextAttributes.LBMContextAttributes ( ) throws LBMException

Create and fill an LBMContextAttributes object with the current default values

Exceptions
LBMException

Member Function Documentation

void com.latencybusters.lbm.LBMContextAttributes.clearSourceNotification ( )

Clear the currently stored source notification callback and token

void com.latencybusters.lbm.LBMContextAttributes.disableSourceNotification ( )

Disable new source notifications.

void com.latencybusters.lbm.LBMContextAttributes.dispose ( )

Free memory associated with this set of attributes.

Referenced by com.latencybusters.lbm.LBMContextAttributes.finalize().

LBMConfigOption [] com.latencybusters.lbm.LBMContextAttributes.dumpAttributeList ( )

Returns an array of LBMConfigOptions.

Returns
Array of LBMConfigOption
void com.latencybusters.lbm.LBMContextAttributes.enableSourceNotification ( )

Enable new source notifications. New source notifications are delivered via the source notification callback set by LBMContext#addSourceNotifyCallback.

See also
LBMContext::addSourceNotifyCallback
disableSourceNotification
void com.latencybusters.lbm.LBMContextAttributes.finalize ( )
protected

This method is for internal use only, and is not supported for customer applications.

References com.latencybusters.lbm.LBMContextAttributes.dispose().

String com.latencybusters.lbm.LBMContextAttributes.getValue ( String  attributeName) throws LBMException

Returns the current value of an attribute from this set of context attributes.

Parameters
attributeNameName of the attribute to retrieve
Returns
Value corresponding to the specified attribute name
Exceptions
LBMExceptionif attributeName is not a valid attribute.
void com.latencybusters.lbm.LBMContextAttributes.load ( InputStream  inStream) throws IOException

Reads a property (attribute) list (key and element pairs) from the input stream.

Parameters
inStreamInput stream of bytes
Exceptions
IOExceptionif any I/O error occurs.
LBMRuntimeExceptionif any invalid attribute is detected in inStream.

References com.latencybusters.lbm.LBMContextAttributes.setProperty().

void com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback ( LBMContextEventCallback  cb)

Set the context event callback for an LBMContext.

Parameters
cbAn object implementing the LBMContextEventCallback interface.

Referenced by com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback ( LBMContextEventCallback  cb,
Object  cbArg 
)

Set the context event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextEventCallback interface.
cbArgA user-supplied callback object to be passed back in context event callbacks.

References com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback ( LBMContextEventCallback  cb,
LBMEventQueue  evq 
)

Set the context event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextEventCallback interface.
evqAn LBMEventQueue on which to place context events.

References com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextEventCallback ( LBMContextEventCallback  cb,
Object  cbArg,
LBMEventQueue  evq 
)

Set the context event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextEventCallback interface.
cbArgA user-supplied callback object to be passed back in context event callbacks.
evqAn LBMEventQueue on which to place context events.
void com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback ( LBMContextSourceEventCallback  cb)

Set the context-level source event callback for an LBMContext.

Parameters
cbAn object implementing the LBMContextSourceEventCallback interface.

Referenced by com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback ( LBMContextSourceEventCallback  cb,
Object  cbArg 
)

Set the context-level source event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextSourceEventCallback interface.
cbArgA user-supplied callback object to be passed back in context source event callbacks.

References com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback ( LBMContextSourceEventCallback  cb,
LBMEventQueue  evq 
)

Set the context-level source event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextSourceEventCallback interface.
evqAn LBMEventQueue on which to place context source events.

References com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback().

void com.latencybusters.lbm.LBMContextAttributes.setContextSourceEventCallback ( LBMContextSourceEventCallback  cb,
Object  cbArg,
LBMEventQueue  evq 
)

Set the context-level source event callback for an LBMContext and associated callback object.

Parameters
cbAn object implementing the LBMContextSourceEventCallback interface.
cbArgA user-supplied callback object to be passed back in context source event callbacks.
evqAn LBMEventQueue on which to place context source events.
void com.latencybusters.lbm.LBMContextAttributes.setFromXml ( String  contextName) throws LBMException

Fill an LBMContextAttributes object with the default values for the given context name specified by the XML configuration.

Parameters
contextNameContext name string. Is written into the attributes object.
Exceptions
LBMExceptionif the contextName is not permitted by the configuration or other operational failure.
void com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback ( LBMImmediateMessageCallback  cb)

Set (and enable) the context callback for topic-less immediate mode messages.

Parameters
cbAn object implementing the LBMImmediateMessageCallback interface.

Referenced by com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback().

void com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback ( LBMImmediateMessageCallback  cb,
LBMEventQueue  evq 
)

Set (and enable) the context callback for topic-less immediate mode messages.

Parameters
cbAn object implementing the LBMImmediateMessageCallback interface.
evqLBMEventQueue on which to place received topic-less immediate-mode messages (can be null).

References com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback().

void com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback ( LBMImmediateMessageCallback  cb,
Object  cbArg 
)

Set (and enable) the context callback for topic-less immediate mode messages.

Parameters
cbAn object implementing the LBMImmediateMessageCallback interface.
cbArgA user-supplied callback object to be passed back in to the immediate message receiver callback.

References com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback().

void com.latencybusters.lbm.LBMContextAttributes.setImmediateMessageCallback ( LBMImmediateMessageCallback  cb,
Object  cbArg,
LBMEventQueue  evq 
)

Set (and enable) the context callback for topic-less immediate mode messages.

Parameters
cbAn object implementing the LBMImmediateMessageCallback interface.
cbArgA user-supplied callback object to be passed back in to the immediate message receiver callback.
evqLBMEventQueue on which to place received topic-less immediate-mode messages (can be null).
void com.latencybusters.lbm.LBMContextAttributes.setObjectRecycler ( LBMObjectRecyclerBase  objRec,
Object  objRecCbArg 
)

Set the LBM object recycler that can be used by the context to reuse LBMMessage objects as well as LBM Context/Receiver/Source Statistics objects.

Parameters
objRecan LBM object recycler that will be called when objects need to be retrieved
objRecCbArga callback object token that will be passed in the retrieve method
Object com.latencybusters.lbm.LBMContextAttributes.setProperty ( String  attributeName,
String  attributeValue 
)

Set the current value of an attribute in this set of context attributes.

Parameters
attributeNameName of the attribute to set
attributeValueNew attribute value
Exceptions
LBMRuntimeExceptionif attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

References com.latencybusters.lbm.LBMContextAttributes.setValue().

Referenced by com.latencybusters.lbm.LBMContextAttributes.load().

void com.latencybusters.lbm.LBMContextAttributes.setReceiverLivenessNotificationCallbacks ( UMEReceiverLivenessCreationCallback  creationCb,
UMEReceiverLivenessDeletionCallback  deletionCb,
Object  cbArg 
) throws LBMException

Register callbacks for new receiver liveness notifications and receiver deletion notifications.

void com.latencybusters.lbm.LBMContextAttributes.setSourceCostCallback ( LBMSourceCostCallback  cb)

Set the source cost callback function for an LBMContext, which is an application callback to evaluate the cost of a newly discovered source

Parameters
cbLBMSourceCostCallback callback implementation
void com.latencybusters.lbm.LBMContextAttributes.setSourceCostCallback ( LBMSourceCostCallback  cb,
Object  cbArg 
)

Set the source cost callback function for an LBMContext, which is an application callback to evaluate the cost of a newly discovered source

Parameters
cbLBMSourceCostCallback callback implementation
cbArgCallback object token
void com.latencybusters.lbm.LBMContextAttributes.setSourceNotification ( LBMSourceNotification  cb,
Object  cbarg 
)

Set the callback and token to be used for source notifications.

void com.latencybusters.lbm.LBMContextAttributes.setTransportMappingCallback ( LBMTransportMappingCallback  cb)

Set the transport mapping callback function for an LBMContext, which is an application callback to provide the user an opportunity to map a new transport session to an XSP

Parameters
cbLBMTransportMappingCallback callback implementation
void com.latencybusters.lbm.LBMContextAttributes.setTransportMappingCallback ( LBMTransportMappingCallback  cb,
Object  cbArg 
)

Set the transport mapping callback function for an LBMContext, which is an application callback to provide the user an opportunity to map a new transport session to an XSP

Parameters
cbLBMTransportMappingCallback callback implementation
cbArgCallback object token
void com.latencybusters.lbm.LBMContextAttributes.setValue ( String  attributeName,
String  attributeValue 
) throws LBMException

FOR INTERNAL INFORMATICA USE ONLY - NOT FOR DIRECT APPLICATION USEAGE. Applications should use setProperty() instead. Set the current value of an attribute in this set of context attributes. Note that this method bypasses the property list. As such no attributes configured using this method will appear in the property list.

Parameters
attributeNameName of the attribute to set
attributeValueNew attribute value
Exceptions
LBMExceptionif attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.
See also
setProperty

Referenced by com.latencybusters.lbm.LBMContextAttributes.setProperty().


The documentation for this class was generated from the following file: