com.sssw.jms.api.admin
Interface JMQDestinationAdmin

All Superinterfaces:

Remote

public interface JMQDestinationAdmin

extends Remote

Interface for managing JMS destinations.

The JMQDestinationAdmin object is obtained from the JMQConnection object.

See Also:

JMQConnection.getDestinationAdmin()

Field Summary

static String	ACL_NAME ACL name protecting the destination.
static String	DURABLE_CONSUMERS_ALLOWED Does the destination allow durable subscribers.
static String	MAX_CONSUMER_NUM Maximum number of consumers that can be concurrently connected to this destination.
static String	MAX_MSG_SIZE Maximum size (in bytes) of the Message that can be produced to this destination.
static String	MAX_UNCONSUMED_MSGBYTES Maximum unconsumed message bytes.
static String	MAX_UNCONSUMED_MSGNUM Maximum number of unconsumed messages.
static String	MESSAGE_EXPIRATION This property sets the expiration value for all messages that pass through this destination.
static String	RECEIVE_ENABLED This property determines whether or not messages will be delivered from a particular destination.
static String	SEND_ENABLED This property determines whether or not messages can be sent to a particular destination.

Method Summary

JMQDestination	createDestination(String name, int type, Properties props) Create a destination (queue or topic) with a given name and properties.
void	deleteDestination(String name, int type) Delete a destination (queue or topic) with a given name
Properties	getDestinationProperties(String name, int type) Get destination (queue or topic) properties
String[]	getDestinations(int type) Return all destinations (queues or topics)
JMQSubscriberInfo[]	getDurableSubscribers(String topicName) Return all durable subscribers on a topic
void	setDestinationProperties(String name, int type, Properties props) Set destination (queue or topic) properties

Field Detail

ACL_NAME

public static final String ACL_NAME

ACL name protecting the destination.

See Also:

Constant Field Values

MAX_MSG_SIZE

public static final String MAX_MSG_SIZE

Maximum size (in bytes) of the Message that can be produced to this destination. The default value for this property is Integer.MAX_VALUE.

See Also:

Constant Field Values

MAX_CONSUMER_NUM

public static final String MAX_CONSUMER_NUM

Maximum number of consumers that can be concurrently connected to this destination. The default value for this property is Integer.MAX_VALUE.

See Also:

Constant Field Values

DURABLE_CONSUMERS_ALLOWED

public static final String DURABLE_CONSUMERS_ALLOWED

Does the destination allow durable subscribers. This property is ignored for Queues. The default value for this property is "true". This property is ignored for Queues.

See Also:

Constant Field Values

MAX_UNCONSUMED_MSGNUM

public static final String MAX_UNCONSUMED_MSGNUM

Maximum number of unconsumed messages. For a queue, the number of unconsumed messages is the total of all unacknowledged messages on the queue. For a topic, the number of unconsumed messages is the total number of all unacknowledged messages for all connected subcribers. The default value for this property is Integer.MAX_VALUE.

See Also:

Constant Field Values

MAX_UNCONSUMED_MSGBYTES

public static final String MAX_UNCONSUMED_MSGBYTES

Maximum unconsumed message bytes. This number of unconsumed message bytes for a destination is calculated in the same was as the number of unconsumed messages. The default value for this property is Integer.MAX_VALUE.

See Also:

Constant Field Values

SEND_ENABLED

public static final String SEND_ENABLED

This property determines whether or not messages can be sent to a particular destination. If the property is set to "false" a send will result in a JMSException. The default value is true.

Since:

jBroker MQ 2.1

See Also:

Constant Field Values

RECEIVE_ENABLED

public static final String RECEIVE_ENABLED

This property determines whether or not messages will be delivered from a particular destination. If the property is set to "false" no messages can be received from the message broker. The default value is true.

Since:

jBroker MQ 2.1

See Also:

Constant Field Values

MESSAGE_EXPIRATION

public static final String MESSAGE_EXPIRATION

This property sets the expiration value for all messages that pass through this destination. If a producers sets message expiration it will be overridden by the destination value. The default value is zero which means that no expiration value will be applied.

Since:

jBroker MQ 2.1

See Also:

Constant Field Values

Method Detail

createDestination

public JMQDestination createDestination(String name,
                                        int type,
                                        Properties props)
                                 throws RemoteException,
                                        JMSException

Create a destination (queue or topic) with a given name and properties.

Parameters:

name - name of the destination

type - type of the destination (JMQDestination.QUEUE or JMQDestination.TOPIC)

props - destination properties

Returns:

a newly created JMQDestination

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

JMQDestination

deleteDestination

public void deleteDestination(String name,
                              int type)
                       throws RemoteException,
                              JMSException

Delete a destination (queue or topic) with a given name

Parameters:

name - name of the destination

type - type of the destination (JMQDestination.QUEUE or JMQDestination.TOPIC)

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

JMQDestination

getDestinationProperties

public Properties getDestinationProperties(String name,
                                           int type)
                                    throws RemoteException,
                                           JMSException

Get destination (queue or topic) properties

Parameters:

name - name of the destination

type - type of the destination (JMQDestination.QUEUE or JMQDestination.TOPIC)

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

JMQDestination

setDestinationProperties

public void setDestinationProperties(String name,
                                     int type,
                                     Properties props)
                              throws RemoteException,
                                     JMSException

Set destination (queue or topic) properties

Parameters:

name - name of the destination

type - type of the destination (JMQDestination.QUEUE or JMQDestination.TOPIC)

props - destination properties

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

See Also:

JMQDestination

getDestinations

public String[] getDestinations(int type)
                         throws RemoteException,
                                JMSException

Return all destinations (queues or topics)

Parameters:

type - type of the destination (JMQDestination.QUEUE or JMQDestination.TOPIC)

Returns:

a string array of destination names

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

Since:

jBroker MQ 1.3

See Also:

JMQDestination

getDurableSubscribers

public JMQSubscriberInfo[] getDurableSubscribers(String topicName)
                                          throws RemoteException,
                                                 JMSException

Return all durable subscribers on a topic

Parameters:

topicName - the topic for which to retrieve durable subscribers

Returns:

an array of JMQSubscriberInfo data structures, which contain subscriber name and connection client identifier

Throws:

RemoteException - the remote invocation of this method failed

JMSException - the JMS provider could not execute this method

Since:

jBroker MQ 2.1