weblogic.jms.extensions
Interface DestinationDetail

public interface DestinationDetail

A DestinationDetail contains information about a destination or a distributed destination member.

If the registration is made with a JNDI name of a Foreign JMS Server destination, the DestinationDetail contains the information about the remote destination or one of its members.

Since:

11gR1PS2 (WebLogic 10.3.3)

See Also:

JMSDestinationAvailabilityHelper, DestinationAvailabilityListener

DESTINATION_TYPE_PHYSICAL_QUEUE

static final int DESTINATION_TYPE_PHYSICAL_QUEUE

A regular (non-Distributed) WebLogic queue, or WebLogic pre-9.0 distributed queue.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_PHYSICAL_TOPIC

static final int DESTINATION_TYPE_PHYSICAL_TOPIC

A regular (non-Distributed) WebLogic topic, or WebLogic pre-9.0 distributed topic.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_FOREIGN_QUEUE

static final int DESTINATION_TYPE_FOREIGN_QUEUE

A third-party (non-WebLogic) queue.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_FOREIGN_TOPIC

static final int DESTINATION_TYPE_FOREIGN_TOPIC

A third-party (non-WebLogic) topic.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_DD_QUEUE

static final int DESTINATION_TYPE_DD_QUEUE

A member of a WebLogic 9.0 or later distributed queue.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_REPLICATED_DT

static final int DESTINATION_TYPE_REPLICATED_DT

A member of a WebLogic 9.0 or later replicated distributed topic. Unlike a partitioned distributed topic, a message sent to a particular replicated distributed topic member is automatically copied to all subscribers on all members.

See Also:

DestinationDetail.getType(), Constant Field Values

DESTINATION_TYPE_PARTITIONED_DT

static final int DESTINATION_TYPE_PARTITIONED_DT

A member of a WebLogic partitioned distributed topic. A message sent to a particular partitioned distributed topic member is only available on that member.

See Also:

DestinationDetail.getType(), Constant Field Values

getJNDIName

String getJNDIName()

The JNDI name of this distributed destination member or destination.

Returns:

A JNDI name representing the distributed destination member or destination.

getDestination

Destination getDestination()

The destination object of this distributed destination member or destination.

Returns:

A Destination representing the distributed destination member or a WLS destination; null for a 3rd party destination.

getType

int getType()

The type of this destination. The returned type depends on the registered JNDI name:

• DESTINATION_TYPE_PHYSICAL_QUEUE: A regular (non-Distributed) WebLogic queue, or WebLogic pre-9.0 distributed queue.
• DESTINATION_TYPE_PHYSICAL_TOPIC: A regular (non-Distributed) WebLogic topic, or WebLogic pre-9.0 distributed topic.
• DESTINATION_TYPE_FOREIGN_QUEUE: A third-party (non-WebLogic) queue.
• DESTINATION_TYPE_FOREIGN_TOPIC: A third-party (non-WebLogic) topic.
• DESTINATION_TYPE_DD_QUEUE: A member of a WebLogic 9.0 or later distributed queue.
• DESTINATION_TYPE_REPLICATED_DT: A member of a WebLogic 9.0 or later replicated distributed topic.
• DESTINATION_TYPE_PARTITIONED_DT: A member of a WebLogic partitioned distributed topic.

Registration of a JNDI name of a distributed destination member is treated as a regular (non-distributed) destination registration. In this case, the destination type in DestinationDetail notifications are either DestinationDetail.DESTINATION_TYPE_PHYSICAL_QUEUE or DestinationDetail.DESTINATION_TYPE_PHYSICAL_TOPIC.

Returns:

The type of this destination.

getJMSServerName

String getJMSServerName()

The name of the JMS server that hosts this destination. Always null if this destination is a third party (non-WebLogic) destination or a WebLogic pre-9.0 distributed destination.

Returns:

The name of the JMS server that hosts this destination.

getCreateDestinationArgument

String getCreateDestinationArgument()

The name used to get a destination reference using javax.jms.Session.createTopic or javax.jms.Session.createQueue.

Returns null for foreign vendors. This method is rarely used. Most applications should use getJNDIName() in combination with JNDI lookups instead.

Returns:

The argument that can be used in createTopic or createQueue.

isAdvancedTopicSupported

boolean isAdvancedTopicSupported()

Indicates if this destination is running on a 11gR1PS2 (WebLogic 10.3.3) or later release.

Returns:

true if this destination is running on a 11gR1PS2 (WebLogic 10.3.3) or later release. Otherwise false.

isLocalWLSServer

boolean isLocalWLSServer()

Indicates if this destination detail is a reference for a distributed destination member that is running on the same WebLogic server as the destination availability listener.

Returns:

true if this destination detail is a reference for a distributed destination member that is running on the same WebLogic server as the destination availability listener. Always returns false if the destination is a pre-9.0 WebLogic distributed destination, a foreign (non-WebLogic) destination, or a regular destination. For a WebLogic 9.0 or later distributed destination member, only returns false when the member is not running on the same server as the listener. When used by a stand-alone client, this method always returns false.

isLocalCluster

boolean isLocalCluster()

Indicates if this destination detail is a reference for a distributed destination member that is running in the same WebLogic cluster as the destination availability listener.

Returns:

true if this destination detail is a reference for a distributed destination member that is running in the same WebLogic cluster as the destination availability listener. Always returns false if the destination is a pre-9.0 WebLogic distributed destination, a foreign (non-WebLogic) destination, or a regular destination. For a WebLogic 9.0 or later distributed destination member, only returns false when the member is not running in the same cluster as the listener. When used by a stand-alone client, this method always returns false.

toString

String toString()

The JNDI name of this destination or member.

Overrides:

toString in class Object

Returns:

A JNDI name of a destination or member.