com.latencybusters.lbm
Class LBMSourceAttributes

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<java.lang.Object,java.lang.Object>
          java.util.Properties
              com.latencybusters.lbm.LBMSourceAttributes

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class LBMSourceAttributes
extends java.util.Properties

Encapsulates the set of default LBM source attributes.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

LBMSourceAttributes()
Create and fill an LBMSourceAttributes object with the current default values

LBMSourceAttributes(java.lang.String contextName, java.lang.String topic)
Create and fill an LBMSourceAttributes object with the current default values for the given context name and source topic name.

Method Summary

void	dispose() Free memory associated with this set of attributes.
LBMConfigOption[]	dumpAttributeList() Returns an array of LBMConfigOptions
protected void	finalize()
UMEStoreGroupEntry[]	getStoreGroups() Gets an array of the UME store groups this source has configured.
UMEStoreEntry[]	getStores() Gets an array of the UME stores this source has configuration entries for.
java.lang.String	getValue(java.lang.String attributeName) Returns the current value of an attribute from this set of source-related attributes.
void	load(java.io.InputStream inStream) Reads a property (attribute) list (key and element pairs) from the input stream.
void	setFromXml(java.lang.String contextName, java.lang.String topic) Fill an LBMSourceAttributes object with the default values specified by the XML configuration for the given context name and source topic name.
void	setMessageReclamationCallback(LBMMessageReclamationCallback cb, java.lang.Object cbArg) Register a callback interface (and a callback handle argument) to be called when a message is forcibly reclaimed from the collection of retained messages on a UME source (UME only).
void	setObjectRecycler(LBMObjectRecyclerBase objRec, java.lang.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.
java.lang.Object	setProperty(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of source-related attributes.
void	setValue(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of source-related attributes.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LBMSourceAttributes

public LBMSourceAttributes()
                    throws LBMException

Create and fill an LBMSourceAttributes object with the current default values

Throws:

LBMException

LBMSourceAttributes

public LBMSourceAttributes(java.lang.String contextName,
                           java.lang.String topic)
                    throws LBMException

Create and fill an LBMSourceAttributes object with the current default values for the given context name and source topic name.

Parameters:

contextName - Context name string.

topic - Source topic name string.

Throws:

LBMException - if the context name and / or source topic name is not permitted by the configuration or other operational failure.

Method Detail

setFromXml

public void setFromXml(java.lang.String contextName,
                       java.lang.String topic)
                throws LBMException

Fill an LBMSourceAttributes object with the default values specified by the XML configuration for the given context name and source topic name.

Parameters:

contextName - Context name string.

topic - Source topic name string.

Throws:

LBMException - if the context name and / or source topic name is not permitted by the configuration or other operational failure.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

dispose

public void dispose()

Free memory associated with this set of attributes.

dumpAttributeList

public LBMConfigOption[] dumpAttributeList()

Returns an array of LBMConfigOptions

Returns:

Array of LBMConfigOption

getValue

public java.lang.String getValue(java.lang.String attributeName)
                          throws LBMException

Returns the current value of an attribute from this set of source-related attributes.

Parameters:

attributeName - Name of the attribute to retrieve

Returns:

Value corresponding to the specified attribute name

Throws:

LBMException - if attributeName is not a valid attribute.

setValue

public void setValue(java.lang.String attributeName,
                     java.lang.String attributeValue)
              throws LBMException

Set the current value of an attribute in this set of source-related attributes. Note that this method bypasses the property list. As such no attributes configured using this method will appear in the property list.

Parameters:

attributeName - Name of the attribute to set

attributeValue - New attribute value

Throws:

LBMException - if attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

See Also:

setProperty(java.lang.String, java.lang.String)

setProperty

public java.lang.Object setProperty(java.lang.String attributeName,
                                    java.lang.String attributeValue)

Set the current value of an attribute in this set of source-related attributes.

Overrides:

setProperty in class java.util.Properties

Parameters:

attributeName - Name of the attribute to set

attributeValue - New attribute value

Throws:

LBMRuntimeException - if attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

load

public void load(java.io.InputStream inStream)
          throws java.io.IOException

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

Overrides:

load in class java.util.Properties

Parameters:

inStream - Input stream of bytes

Throws:

java.io.IOException - if any I/O error occurs.

LBMRuntimeException - if any invalid attribute is detected in inStream.

setObjectRecycler

public void setObjectRecycler(LBMObjectRecyclerBase objRec,
                              java.lang.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:

objRec - an LBM object recycler that will be called when objects need to be retrieved

objRecCbArg - a callback object token that will be passed in the retrieve method

setMessageReclamationCallback

public void setMessageReclamationCallback(LBMMessageReclamationCallback cb,
                                          java.lang.Object cbArg)

Register a callback interface (and a callback handle argument) to be called when a message is forcibly reclaimed from the collection of retained messages on a UME source (UME only). This callback is called directly in line and does not use the event queue; therefore, the callback function used should not block or it will block the context thread processing.

Parameters:

cb - An object implementing the LBMMessageReclamationCallback interface

cbArg - Callback object passed as a token to the callback interface

See Also:

LBMRegistrationIdCallback

getStores

public UMEStoreEntry[] getStores()

Gets an array of the UME stores this source has configuration entries for.

Returns:

An array of UMEStoreEntry objects. Each member of the array contains information about a different UME store.

Since:

UME 2.0

getStoreGroups

public UMEStoreGroupEntry[] getStoreGroups()

Gets an array of the UME store groups this source has configured.

Returns:

An array of UMEStoreGroupEntry objects. Each member of the array contains information about a different UME store group.

Since:

UME 2.0