BEA WebLogic Server 9.1 API Reference

weblogic.jms.extensions
Class ConsumerInfo

java.lang.Object
  weblogic.jms.extensions.ConsumerInfo

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.

See Also:

CompositeData, JMSDurableSubscriberRuntimeMBean

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Constructor Summary

ConsumerInfo(CompositeData cd)
Creates a ConsumerInfo object from its CompositeData representation.

ConsumerInfo(String name, boolean durable, String selector, String clientID, boolean noLocal, String connectionAddress)
Creates a ConsumerInfo instance.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsumerInfo

public ConsumerInfo(CompositeData cd)

Creates a ConsumerInfo object from its CompositeData representation.

ConsumerInfo

public ConsumerInfo(String name,
                    boolean durable,
                    String selector,
                    String clientID,
                    boolean noLocal,
                    String connectionAddress)

Creates a ConsumerInfo instance.

Method Detail

getClientID

public String getClientID()

Gets the client ID.

Returns:

the clientID.

getCompositeDataMap

protected Map getCompositeDataMap()

getCompositeType

protected CompositeType getCompositeType()
                                  throws OpenDataException

Throws:

OpenDataException

getConnectionAddress

public String getConnectionAddress()

Gets the connection address of the client consumer.

Returns:

the connection address.

getName

public String getName()

Gets the name of the consumer.

Returns:

the name of the consumer.

getSelector

public String getSelector()

Gets the selector associated with a consumer.

Returns:

the selector.

isDurable

public boolean isDurable()

Specifies whether the subscriber has a durable or non-durable subscription.

Returns:

true if the subscription is durable.

isNoLocal

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.

Returns:

true if the subscriber does not receive the messages it publishes.

readCompositeData

protected void readCompositeData(CompositeData cd)

setClientID

public void setClientID(String clientID)

Sets the client ID.

Parameters:

clientID - the clientID.

setConnectionAddress

public void setConnectionAddress(String connectionAddress)

Sets the connection address attribute of the client consumer.

Parameters:

connectionAddress - a connection address.

setDurable

public void setDurable(boolean durable)

Sets the isDurable flag.

Parameters:

durable - The durable to set.

setName

public void setName(String name)

Sets the name attribute for a consumer.

Parameters:

name - the name for the consumer.

setNoLocal

public void setNoLocal(boolean noLocal)

Sets the noLocal attribute.

Parameters:

noLocal - true if the subscriber should not receive the messages it publishes. the noLocal to set.

setSelector

public void setSelector(String selector)

Sets the selector attribute for this consumer.

Parameters:

selector - the selector.

toCompositeData

public CompositeData toCompositeData()
                              throws OpenDataException

Converts a ConsumerInfo instance to a CompositeData representation.

Returns:

the CompositeData representation of the object.

Throws:

OpenDataException - Thrown when an error occurs while constructing the CompositeData representation.