public class ConsumerInfo extends Object
ConsumerInfo
represents JMS consumer informaton used by JMS
message management APIs to provide consumer information to management clients
in CompositeData format.
CompositeData
,
JMSDurableSubscriberRuntimeMBean
Modifier and Type | Method and Description |
---|---|
String |
getClientID()
Gets the client ID.
|
protected Map |
getCompositeDataMap() |
protected CompositeType |
getCompositeType() |
String |
getConnectionAddress()
Gets the connection address of the client consumer.
|
String |
getName()
Gets the name of the consumer.
|
String |
getSelector()
Gets the selector associated with a consumer.
|
boolean |
isDurable()
Specifies whether the subscriber has a durable or non-durable subscription.
|
boolean |
isNoLocal()
Specifies whether a subscriber that uses the same JMS connection to publish and subscribe to a single topic
receives the messages it publishes.
|
protected void |
readCompositeData(CompositeData cd) |
void |
setClientID(String clientID)
Sets the client ID.
|
void |
setConnectionAddress(String connectionAddress)
Sets the connection address attribute of the client consumer.
|
void |
setDurable(boolean durable)
Sets the isDurable flag.
|
void |
setName(String name)
Sets the name attribute for a consumer.
|
void |
setNoLocal(boolean noLocal)
Sets the
noLocal attribute. |
void |
setSelector(String selector)
Sets the selector attribute for this consumer.
|
CompositeData |
toCompositeData()
Converts a
ConsumerInfo instance to a CompositeData representation. |
public CompositeData toCompositeData() throws OpenDataException
Converts a ConsumerInfo
instance to a CompositeData representation.
OpenDataException
- Thrown when an error occurs while constructing the CompositeData
representation.public String getClientID()
Gets the client ID.
public void setClientID(String clientID)
Sets the client ID.
clientID
- the clientID.public String getConnectionAddress()
Gets the connection address of the client consumer.
public void setConnectionAddress(String connectionAddress)
Sets the connection address attribute of the client consumer.
connectionAddress
- a connection address.public boolean isDurable()
Specifies whether the subscriber has a durable or non-durable subscription.
public void setDurable(boolean durable)
Sets the isDurable flag.
durable
- The durable to set.public String getName()
Gets the name of the consumer.
public void setName(String name)
Sets the name attribute for a consumer.
name
- the name for the consumer.public boolean isNoLocal()
Specifies whether a subscriber that uses the same JMS connection to publish and subscribe to a single topic receives the messages it publishes.
public void setNoLocal(boolean noLocal)
Sets the noLocal
attribute.
noLocal
- true if the subscriber should not receive the messages it publishes.
the noLocal to set.public String getSelector()
Gets the selector associated with a consumer.
public void setSelector(String selector)
Sets the selector attribute for this consumer.
selector
- the selector.protected void readCompositeData(CompositeData cd)
protected Map getCompositeDataMap()
protected CompositeType getCompositeType() throws OpenDataException
OpenDataException