webMethods Broker API for JMS
Version 9.5.1.0.171 091713

com.webmethods.jms
Interface WmDestination

All Superinterfaces:
javax.jms.Destination
All Known Subinterfaces:
WmQueue, WmTopic

public interface WmDestination
extends javax.jms.Destination

Interface defining webMethods extensions to javax.jms.Destination and its subclasses.


Field Summary
static int SHARED_STATE_ORDERING_NONE
          Shared state ordering disabled.
static int SHARED_STATE_ORDERING_PUBLISHER
          Shared state ordering by publisher.
static int SHARED_STATE_ORDERING_SESSION
          Shared state ordering by session.
static java.lang.String WILDCARD
          The wildcard string used for Topics.
 
Method Summary
 boolean getDeadLetterOnly()
          Get whether dead letter subscriptions are enabled for this topic.
 java.lang.String getEventType()
          Get the event type name used for this destination.
 boolean getLocalOnly()
          Get whether local only subscriptions are enabled for this topic.
 java.lang.String getName()
          Get the name of this destination.
 boolean getPriorityOrdering()
          Get whether priority ordering is enabled for this destination.
 boolean getReadOnly()
          Get whether this destination is read-only.
 boolean getSharedState()
          Get the shared state for this destination.
 int getSharedStateOrdering()
          Get the shared state ordering for this destination.
 boolean isWildCard()
          Get whether the topic is a wildcard.
 void setDeadLetterOnly(boolean deadLetterOnly)
          Enable dead letter subscriptions for this topic.
 void setEventType(java.lang.String eventType)
          Set the event type name used for this destination.
 void setLocalOnly(boolean localOnly)
          Enable local only subscriptions for this topic.
 void setName(java.lang.String name)
          Set the name for this destination.
 void setPriorityOrdering(boolean priorityOrdering)
          Enable of disable priority ordering for this destination.
 void setReadOnly()
          Set this destination to read-only.
 void setSharedState(boolean sharedState)
          Set the shared state for this destination.
 void setSharedStateOrdering(int sharedStateOrdering)
          Set the shared state ordering for this destination.
 

Field Detail

WILDCARD

static final java.lang.String WILDCARD
The wildcard string used for Topics.

See Also:
Constant Field Values

SHARED_STATE_ORDERING_NONE

static final int SHARED_STATE_ORDERING_NONE
Shared state ordering disabled.

See Also:
Constant Field Values

SHARED_STATE_ORDERING_PUBLISHER

static final int SHARED_STATE_ORDERING_PUBLISHER
Shared state ordering by publisher. This guarantees that messages from a single publisher to a destination cannot be processed out of order.

See Also:
Constant Field Values

SHARED_STATE_ORDERING_SESSION

static final int SHARED_STATE_ORDERING_SESSION
Shared state ordering by session. This guarantees that messages from a single publisher to all destinations in a session cannot be processed out of order.

See Also:
Constant Field Values
Method Detail

setName

void setName(java.lang.String name)
             throws javax.jms.JMSException
Set the name for this destination.

The destination name must be a valid name. All destinations must have a name.

Parameters:
name - the Destination name.
Throws:
javax.jms.InvalidDestinationException - if the destination name is invalid
javax.jms.JMSException - if unable to set the name
See Also:
getName()

getName

java.lang.String getName()
                         throws javax.jms.JMSException
Get the name of this destination.

Returns:
the destination name
Throws:
javax.jms.JMSException
See Also:
setName(java.lang.String)

setEventType

void setEventType(java.lang.String eventType)
                  throws javax.jms.JMSException
Set the event type name used for this destination.

Parameters:
eventType - the event type name for this destination
Throws:
javax.jms.JMSException - if unable to set the event type
See Also:
getEventType()

getEventType

java.lang.String getEventType()
                              throws javax.jms.JMSException
Get the event type name used for this destination.

Returns:
the event type name for this destination
Throws:
javax.jms.JMSException
See Also:
setEventType(java.lang.String)

setSharedState

void setSharedState(boolean sharedState)
                    throws javax.jms.JMSException
Set the shared state for this destination. If the destination is a queue then multiple queue receivers may connect to the same queue. If the destination is a topic then multiple durable subscribers may connect to the same subscription.

Parameters:
sharedState - the shared state value for this destination
Throws:
javax.jms.JMSException - if unable to set the shared state
See Also:
getSharedState()

getSharedState

boolean getSharedState()
                       throws javax.jms.JMSException
Get the shared state for this destination.

Returns:
the shared state for this destination
Throws:
javax.jms.JMSException
See Also:
setSharedState(boolean)

setSharedStateOrdering

void setSharedStateOrdering(int sharedStateOrdering)
                            throws javax.jms.JMSException
Set the shared state ordering for this destination.

Parameters:
sharedStateOrdering - the shared state ordering value for this destination; either SHARED_STATE_ORDERING_NONE, SHARED_STATE_ORDERING_PUBLISHER or SHARED_STATE_ORDERING_SESSION
Throws:
javax.jms.JMSException - if unable to set the shared state ordering
See Also:
getSharedStateOrdering()

getSharedStateOrdering

int getSharedStateOrdering()
                           throws javax.jms.JMSException
Get the shared state ordering for this destination.

Returns:
the shared state ordering for this destination
Throws:
javax.jms.JMSException
See Also:
setSharedStateOrdering(int)

setDeadLetterOnly

void setDeadLetterOnly(boolean deadLetterOnly)
                       throws javax.jms.JMSException
Enable dead letter subscriptions for this topic. When enabled consumers of this topic will only receive messages if they are undeliverable.

Parameters:
deadLetterOnly - true to enable dead letter subscriptions
Throws:
javax.jms.JMSException - if unable to set dead letter subscriptions
See Also:
getDeadLetterOnly()

getDeadLetterOnly

boolean getDeadLetterOnly()
                          throws javax.jms.JMSException
Get whether dead letter subscriptions are enabled for this topic.

Returns:
whether dead letter subscriptions are enabled
Throws:
javax.jms.JMSException
See Also:
setDeadLetterOnly(boolean)

setLocalOnly

void setLocalOnly(boolean localOnly)
                  throws javax.jms.JMSException
Enable local only subscriptions for this topic. When enabled consumers of this topic will only receive messages published by publishers connected to the same Broker as the subscriber.

Parameters:
localOnly - true to enable local only subscriptions
Throws:
javax.jms.JMSException - if unable to set local only subscriptions
See Also:
getLocalOnly()

getLocalOnly

boolean getLocalOnly()
                     throws javax.jms.JMSException
Get whether local only subscriptions are enabled for this topic.

Returns:
whether dead letter subscriptions are enabled
Throws:
javax.jms.JMSException
See Also:
setLocalOnly(boolean)

setPriorityOrdering

void setPriorityOrdering(boolean priorityOrdering)
                         throws javax.jms.JMSException
Enable of disable priority ordering for this destination. If enabled messages will be received in priority order. If disabled messages will be received in publisher order.

The default is for priority ordering to be enabled.

Parameters:
priorityOrdering - true to enable priority ordering
Throws:
javax.jms.JMSException - if unable to set priority ordering
See Also:
getPriorityOrdering()

getPriorityOrdering

boolean getPriorityOrdering()
                            throws javax.jms.JMSException
Get whether priority ordering is enabled for this destination.

Returns:
whether priority ordering is enabled
Throws:
javax.jms.JMSException
See Also:
setPriorityOrdering(boolean)

setReadOnly

void setReadOnly()
                 throws javax.jms.JMSException
Set this destination to read-only. Once set to read-only none of the destination's attributes can be modified.

Throws:
javax.jms.JMSException
See Also:
getReadOnly()

getReadOnly

boolean getReadOnly()
                    throws javax.jms.JMSException
Get whether this destination is read-only.

Returns:
whether this destination is read-only
Throws:
javax.jms.JMSException

isWildCard

boolean isWildCard()
                   throws javax.jms.JMSException
Get whether the topic is a wildcard.

Returns:
true if the topic is wildcard; false otherwise
Throws:
javax.jms.JMSException

webMethods Broker API for JMS
Version 9.5.1.0.171 091713


Copyright © 2001 - 2013 Software AG Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their suppliers.