UM Java API  6.16.1
com.latencybusters.lbm.LBMEventQueueAttributes Class Reference
Inheritance diagram for com.latencybusters.lbm.LBMEventQueueAttributes:

Public Member Functions

 LBMEventQueueAttributes (String eventQueueName) throws LBMException
 
void setFromXml (String eventQueueName) throws LBMException
 
 LBMEventQueueAttributes () 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)
 

Protected Member Functions

void finalize ()
 

Detailed Description

Encapsulates the set of default LBM event queue attributes.

Constructor & Destructor Documentation

com.latencybusters.lbm.LBMEventQueueAttributes.LBMEventQueueAttributes ( String  eventQueueName) throws LBMException

Create and fill an LBMEventQueueAttributes object with the current default values for the given event queue name.

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

Create an LBMEventQueueAttributes object with the current default values

Exceptions
LBMExceptionfor operational failure.

Member Function Documentation

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

Free memory associated with this set of attributes.

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

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

Returns an array of LBMConfigOptions.

Returns
Array of LBMConfigOption
void com.latencybusters.lbm.LBMEventQueueAttributes.finalize ( )
protected

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

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

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

Returns the current value of an attribute from this set of event queue 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.LBMEventQueueAttributes.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.LBMEventQueueAttributes.setProperty().

void com.latencybusters.lbm.LBMEventQueueAttributes.setFromXml ( String  eventQueueName) throws LBMException

Fill an LBMEventQueueAttributes object with the default values for the given event queue name specified by the XML configuration.

Parameters
eventQueueNameEvent queue name string. Is written into the attributes object.
Exceptions
LBMExceptionif the eventQueueName is not permitted by the configuration or other operational failure.
void com.latencybusters.lbm.LBMEventQueueAttributes.setObjectRecycler ( LBMObjectRecyclerBase  objRec,
Object  objRecCbArg 
)

Set the LBM object recycler that can be used by the event queue to reuse 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.LBMEventQueueAttributes.setProperty ( String  attributeName,
String  attributeValue 
)

Set the current value of an attribute in this set of event queue 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.LBMEventQueueAttributes.setValue().

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

void com.latencybusters.lbm.LBMEventQueueAttributes.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 event queue 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.LBMEventQueueAttributes.setProperty().


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