com.solacesystems.jcsmp

Class DestinationUtils

java.lang.Object

com.solacesystems.jcsmp.DestinationUtils

public abstract class DestinationUtils
extends Object

Utility class for working with Destinations and marshaling them to Strings (network names).

A temporary destination is only valid for consumption within the session that created it; it is recommended to use JCSMPSession.createTemporaryQueue() and JCSMPSession.createTemporaryTopic() to acquire new instances of temporary destinations, instead of this utility.

Validation is not performed on parameters passed into these utility functions. As a consequence, it is only valid to use names obtained from the JCSMP API.

Method Summary

Modifier and Type	Method and Description
abstract String	getEncodedName(Destination destination) Deprecated. See DestinationUtils.getNetworkName(Destination).
abstract String	getNetworkName(Destination destination) Returns the String representing a Queue or Topic destination in an encoded network name form.
static DestinationUtils	onlyInstance() Get a concrete instance of this utility class.
abstract Destination	queueFromEncodedName(String name) Deprecated. See DestinationUtils.queueFromNetworkName(String).
abstract Destination	queueFromNetworkName(String name) Creates an (optionally temporary) Queue from the supplied name.
abstract Destination	topicFromEncodedName(String name) Deprecated. See DestinationUtils.topicFromNetworkName(String).
abstract Destination	topicFromNetworkName(String name) Creates an (optionally temporary) Topic from the supplied name.

Methods inherited from class java.lang.Object

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

Method Detail

onlyInstance

public static DestinationUtils onlyInstance()

Get a concrete instance of this utility class.

Returns:

An instance of DestinationUtils.

queueFromEncodedName

@Deprecated
public abstract Destination queueFromEncodedName(String name)

Deprecated. See DestinationUtils.queueFromNetworkName(String).

queueFromNetworkName

public abstract Destination queueFromNetworkName(String name)

Creates an (optionally temporary) Queue from the supplied name. The durability of the destination is inferred from the name.

An encoded network name must be obtained from DestinationUtils.getEncodedName(Destination).

Parameters:

name - A valid Queue name obtained from the API.

Returns:

A new Queue Destination instance.

topicFromEncodedName

@Deprecated
public abstract Destination topicFromEncodedName(String name)

Deprecated. See DestinationUtils.topicFromNetworkName(String).

topicFromNetworkName

public abstract Destination topicFromNetworkName(String name)

Creates an (optionally temporary) Topic from the supplied name. The durability of the destination is inferred from the name.

An encoded network name must be obtained from DestinationUtils.getEncodedName(Destination).

Parameters:

name - A valid Topic name obtained from the API.

Returns:

A new Topic Destination instance.

getEncodedName

@Deprecated
public abstract String getEncodedName(Destination destination)

Deprecated. See DestinationUtils.getNetworkName(Destination).

getNetworkName

public abstract String getNetworkName(Destination destination)

Returns the String representing a Queue or Topic destination in an encoded network name form.

Parameters:

destination - A Destination instance, must be an instance of a Queue or Topic.

Returns:

A String representing the destination.