|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Dictionary<K,V>
java.util.Hashtable<java.lang.Object,java.lang.Object>
java.util.Properties
com.latencybusters.lbm.LBMReceiverAttributes
public class LBMReceiverAttributes
Encapsulates the set of default LBM receiver attributes.
Field Summary |
---|
Fields inherited from class java.util.Properties |
---|
defaults |
Constructor Summary | |
---|---|
LBMReceiverAttributes()
Create and fill an LBMReceiverAttributes object with the current default values. |
|
LBMReceiverAttributes(java.lang.String contextName,
java.lang.String topic)
Create and fill an LBMReceiverAttributes object with the current default values for the given context name and receiver topic name. |
Method Summary | |
---|---|
void |
dispose()
Free memory associated with this set of attributes. |
LBMConfigOption[] |
dumpAttributeList()
Returns an array of LBMConfigOptions |
void |
enableSingleReceiverCallback(boolean enable)
Used to enable or disable single receiver callbacks. |
protected void |
finalize()
|
java.lang.String |
getValue(java.lang.String attributeName)
Returns the current value of an attribute from this set of 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 topic)
Fill an LBMReceiverAttributes object with the default values specified by the XML configuration for the given context name and receiver topic name. |
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 receiver-related attributes. |
void |
setRecoverySequenceNumberCallback(UMERecoverySequenceNumberCallback cb,
java.lang.Object cbArg)
Register an extended callback interface (and a callback handle argument) to be called to enable a receiver to set the low sequence number it uses for recovery events (including late joins and durable subscriptions). |
void |
setRegistrationIdCallback(LBMRegistrationIdCallback cb,
java.lang.Object cbArg)
Register a callback interface (and a callback handle argument) to be called to enable a receiver to set the registration ID it uses for a given source (UME only). |
void |
setRegistrationIdCallback(UMERegistrationIdExCallback cb,
java.lang.Object cbArg)
Register an extended callback interface (and a callback handle argument) to be called to enable a receiver to set the registration ID it uses for a given source (UME only). |
void |
setSourceNotificationCallbacks(LBMSourceCreationCallback creationCb,
LBMSourceDeletionCallback deletionCb,
java.lang.Object cbArg)
Register callbacks for new source notifications and source deletion notifications for sources on the topic a receiver is listening to. |
void |
setValue(java.lang.String attributeName,
java.lang.String attributeValue)
Set the current value of an attribute in this set of 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 |
Constructor Detail |
---|
public LBMReceiverAttributes() throws LBMException
LBMException
public LBMReceiverAttributes(java.lang.String contextName, java.lang.String topic) throws LBMException
contextName
- Context name string.topic
- Receiver topic name string.
LBMException
- if the context name and / or receiver topic name is not permitted by the configuration or other operational failure.Method Detail |
---|
public void setFromXml(java.lang.String contextName, java.lang.String topic) throws LBMException
contextName
- Context name string.topic
- Receiver topic name string.
LBMException
- if the context name and / or receiver topic name is not permitted by the configuration or other operational failure.protected void finalize()
finalize
in class java.lang.Object
public void dispose()
public LBMConfigOption[] dumpAttributeList()
public java.lang.String getValue(java.lang.String attributeName) throws LBMException
attributeName
- Name of the attribute to retrieve
LBMException
- if attributeName
is not a valid attribute.public void setValue(java.lang.String attributeName, java.lang.String attributeValue) throws LBMException
attributeName
- Name of the attribute to setattributeValue
- New attribute value
LBMException
- if attributeName
is not a valid attribute,
or attributeValue
is not a valid value for attributeName
.setProperty(java.lang.String, java.lang.String)
public java.lang.Object setProperty(java.lang.String attributeName, java.lang.String attributeValue)
setProperty
in class java.util.Properties
attributeName
- Name of the attribute to setattributeValue
- New attribute value
LBMRuntimeException
- if attributeName
is not a valid attribute,
or attributeValue
is not a valid value for attributeName
.public void load(java.io.InputStream inStream) throws java.io.IOException
load
in class java.util.Properties
inStream
- Input stream of bytes
java.io.IOException
- if any I/O error occurs.
LBMRuntimeException
- if any invalid attribute is detected in inStream
.public void setObjectRecycler(LBMObjectRecyclerBase objRec, java.lang.Object objRecCbArg)
objRec
- an LBM object recycler that will be called when objects need to be retrievedobjRecCbArg
- a callback object token that will be passed in the retrieve methodpublic void setRegistrationIdCallback(LBMRegistrationIdCallback cb, java.lang.Object cbArg)
cb
- An object implementing the LBMRegistrationIdCallback interfacecbArg
- Callback object passed as a token to the callback interfaceLBMRegistrationIdCallback
,
LBMWildcardReceiverCreateCallback
public void setRegistrationIdCallback(UMERegistrationIdExCallback cb, java.lang.Object cbArg)
cb
- An object implementing the LBMRegistrationIdCallback interfacecbArg
- Callback object passed as a token to the callback interfaceLBMRegistrationIdCallback
,
LBMWildcardReceiverCreateCallback
public void setRecoverySequenceNumberCallback(UMERecoverySequenceNumberCallback cb, java.lang.Object cbArg)
cb
- An object implementing the UMERecoverySequenceNumberCallback interfacecbArg
- Callback object passed as a token to the callback interfaceUMERecoverySequenceNumberCallback
,
LBMWildcardReceiverCreateCallback
public void setSourceNotificationCallbacks(LBMSourceCreationCallback creationCb, LBMSourceDeletionCallback deletionCb, java.lang.Object cbArg) throws LBMException
creationCb
- Callback for new source notifications.deletionCb
- Callback for source deletions.cbArg
- Client-supplied callback object that will be passed into both the new source and source deletion callbacks.
LBMException
- if both source creation and source deletion callbacks are not specified at once.LBMWildcardReceiverCreateCallback
public void enableSingleReceiverCallback(boolean enable)
Enabling this is recommended for SMX and any application that does not use addReceiver() or removeReceiver().
allow
- Enable or disable addReceiver and removeReceiver
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |