com.solacesystems.jcsmp

Class Queue

java.lang.Object

com.solacesystems.jcsmp.impl.AbstractDestination

com.solacesystems.jcsmp.Queue

All Implemented Interfaces:

Destination, Endpoint, Serializable

public abstract class Queue
extends com.solacesystems.jcsmp.impl.AbstractDestination
implements Endpoint, Serializable

Identifier for Solace appliance Queue names. Queues may be acquired from JCSMPFactory.createQueue(String).

Queue names are UTF-8 strings with a maximum encoded length of 250 bytes. Names are case-sensitive. Queue names are hierarchical, with levels separated by the / character. A Queue name cannot contain an empty level. Invalid characters: ['*<>&;], as well as control characters.

This class is thread safe.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() Gets the destination name specified at object creation time.
boolean	isAnonymous() Getter for the anonymous flag.
boolean	isDurable() Whether this Endpoint is durable.
boolean	isTemporary() A flag indicating whether this is a temporary destination.
void	setAnonymous(boolean anonymous) This setter is used to mark the queue as anonymous.

Methods inherited from class com.solacesystems.jcsmp.impl.AbstractDestination

getVirtualRouterName, hashCode, initIfRequired, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.solacesystems.jcsmp.Endpoint

getVirtualRouterName

Method Detail

getName

public String getName()

Description copied from class: com.solacesystems.jcsmp.impl.AbstractDestination

Gets the destination name specified at object creation time.

Specified by:

getName in interface Destination

Specified by:

getName in interface Endpoint

Overrides:

getName in class com.solacesystems.jcsmp.impl.AbstractDestination

Returns:

Name of the destination

isDurable

public boolean isDurable()

Description copied from interface: Endpoint

Whether this Endpoint is durable.

Specified by:

isDurable in interface Endpoint

Returns:

true if this Endpoint is durable, false otherwise.

isTemporary

public boolean isTemporary()

Description copied from interface: Destination

A flag indicating whether this is a temporary destination.

Specified by:

isTemporary in interface Destination

Overrides:

isTemporary in class com.solacesystems.jcsmp.impl.AbstractDestination

Returns:

true if this destination is marked as temporary, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isAnonymous

public boolean isAnonymous()

Getter for the anonymous flag. NOTE: This getter was added for JCSMP auto-instrumentation in order to populate the messaging.destination.anonymous span attribute.

Returns:

true if the temporary queue is anonymous, false otherwise

setAnonymous

public void setAnonymous(boolean anonymous)

This setter is used to mark the queue as anonymous. NOTE: This will only be true if the queue is temporary and the name is auto-generated (true for createTemporaryQueue(), false for createTemporaryQueue(String name)).

Parameters:

anonymous - true if the temporary queue is anonymous, false otherwise