com.latencybusters.lbm
Class LBMWildcardReceiverAttributes

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

All Implemented Interfaces:

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

public class LBMWildcardReceiverAttributes
extends java.util.Properties

Encapsulates the set of default LBM wildcard receiver attributes.

See Also:

Serialized Form

Field Summary

protected LBMWildcardReceiverCreateCallback	_rcv_create_cb
protected java.lang.Object	_rcv_create_cbArg
protected LBMWildcardReceiverDeleteCallback	_rcv_delete_cb
protected java.lang.Object	_rcv_delete_cbArg

Fields inherited from class java.util.Properties

defaults

Constructor Summary

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

LBMWildcardReceiverAttributes(java.lang.String contextName, java.lang.String pattern, int pattern_type)
Create and fill an LBMWildcardReceiverAttributes object with the current default values for the given context name, pattern and pattern type.

Method Summary

void	dispose() Free memory associated with this set of attributes.
LBMConfigOption[]	dumpAttributeList() Returns an array of LBMConfigOptions.
protected void	finalize()
java.lang.String	getValue(java.lang.String attributeName) Returns the current value of an attribute from this set of wildcard receiver-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 pattern, int pattern_type) Fill an LBMWildcardReceiverAttributes object with the default values for the given context name, pattern and pattern type.
void	setPatternCallback(LBMWildcardPatternCallback cb, java.lang.Object cbArg) Set the callback interface (and a callback handle argument) to be called when a pattern match is desired for a topic discovered for a wildcard receiver if the pattern type is set to "appcb".
java.lang.Object	setProperty(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of wildcard receiver-related attributes.
void	setReceiverCreateCallback(LBMWildcardReceiverCreateCallback cb, java.lang.Object cbArg) Set the receiver create callback for this wildcard receiver; this callback will be called when a new internal receiver is created and allows the LBMReceiverAttributes that will be used to create the receiver to be changed before the receiver is created.
void	setReceiverDeleteCallback(LBMWildcardReceiverDeleteCallback cb, java.lang.Object cbArg) Set the receiver delete callback for this wildcard receiver; this callback will be called when a new internal receiver is deleted.
void	setValue(java.lang.String attributeName, java.lang.String attributeValue) Set the current value of an attribute in this set of wildcard receiver-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

Field Detail

_rcv_create_cb

protected LBMWildcardReceiverCreateCallback _rcv_create_cb

_rcv_create_cbArg

protected java.lang.Object _rcv_create_cbArg

_rcv_delete_cb

protected LBMWildcardReceiverDeleteCallback _rcv_delete_cb

_rcv_delete_cbArg

protected java.lang.Object _rcv_delete_cbArg

Constructor Detail

LBMWildcardReceiverAttributes

public LBMWildcardReceiverAttributes()
                              throws LBMException

Create and fill an LBMWildcardReceiverAttributes object with the current default values.

Throws:

LBMException

LBMWildcardReceiverAttributes

public LBMWildcardReceiverAttributes(java.lang.String contextName,
                                     java.lang.String pattern,
                                     int pattern_type)
                              throws LBMException

Create and fill an LBMWildcardReceiverAttributes object with the current default values for the given context name, pattern and pattern type.

Parameters:

contextName - The name of the context under which the wildcard receiver is to be created.

pattern - The wildcard receiver pattern which will be used to create the wildcard receiver. Must match the wildcard receiver pattern in the XML configuration exactly.

pattern_type - The pattern_type of the wildcard receiver. Is written into the attributes object.

Throws:

LBMException - if contextName, or pattern and pattern_type combination are not permitted by the XML configuration.

Method Detail

setFromXml

public void setFromXml(java.lang.String contextName,
                       java.lang.String pattern,
                       int pattern_type)
                throws LBMException

Fill an LBMWildcardReceiverAttributes object with the default values for the given context name, pattern and pattern type.

Parameters:

contextName - The name of the context under which the wildcard receiver is to be created.

pattern - The wildcard receiver pattern which will be used to create the wildcard receiver. Must match the wildcard receiver pattern in the XML configuration exactly.

pattern_type - The pattern_type of the wildcard receiver. Is written into the attributes object.

Throws:

LBMException - if contextName, or pattern and pattern_type combination are not permitted by the XML configuration.

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 wildcard receiver-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 wildcard receiver-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 wildcard receiver-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.

setPatternCallback

public void setPatternCallback(LBMWildcardPatternCallback cb,
                               java.lang.Object cbArg)

Set the callback interface (and a callback handle argument) to be called when a pattern match is desired for a topic discovered for a wildcard receiver if the pattern type is set to "appcb".

Parameters:

cb - An object implementing the LBMWildcardPatternCallback interface

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

setReceiverCreateCallback

public void setReceiverCreateCallback(LBMWildcardReceiverCreateCallback cb,
                                      java.lang.Object cbArg)

Set the receiver create callback for this wildcard receiver; this callback will be called when a new internal receiver is created and allows the LBMReceiverAttributes that will be used to create the receiver to be changed before the receiver is created.

Parameters:

cb - An object implementing the LBMWildcardReceiverCreateCallback interface.

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

setReceiverDeleteCallback

public void setReceiverDeleteCallback(LBMWildcardReceiverDeleteCallback cb,
                                      java.lang.Object cbArg)

Set the receiver delete callback for this wildcard receiver; this callback will be called when a new internal receiver is deleted.

Parameters:

cb - An object implementing the LBMWildcardReceiverDeleteCallback interface.

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