com.solacesystems.jcsmp

Class Topic

java.lang.Object

com.solacesystems.jcsmp.impl.AbstractDestination

com.solacesystems.jcsmp.Topic

All Implemented Interfaces:

Destination, Subscription, Serializable

public abstract class Topic
extends com.solacesystems.jcsmp.impl.AbstractDestination
implements Subscription, Serializable

An identifier for Solace appliance topics and topic subscriptions.

SolOS Topics

Topic names are NULL-terminated UTF-8 strings with a maximum encoded length of 250 bytes, not including the NULL terminator. Topic names are case-sensitive. Topic names are hierarchical, with levels separated by the / character. A topic may not contain an empty level. A topic is wildcarded if its last level is the character > or a level contains a *.

Topics may be composed of any UTF-8 character. If the "*" character appears within a topic, it must be the last character in a level.

The RxAllDeliverToOne flag is valid on topic subscriptions.

Topic Validation

Validation rules are applied to a Topic instance only when it is first used with an initialized. Session in client mode (that is, topic-routing mode) or non-client mode (that is, content-routing mode), at which point an InvalidArgumentException is thrown if the topic string is not legal for the configured session mode.

This class is thread safe.
This class is immutable.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Tests if equal to another topic.
int	hashCode() Gets the hashcode.
boolean	isRxAllDeliverToOne() This flag, when present in a topic subscription, overrides the DeliverToOne property in a message.
boolean	isTemporary() A flag indicating whether this is a temporary destination.
String	toString()

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

getName, getVirtualRouterName, initIfRequired

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isRxAllDeliverToOne

public boolean isRxAllDeliverToOne()

This flag, when present in a topic subscription, overrides the DeliverToOne property in a message. If the topic in the message matches, it is delivered to clients with matching subscriptions with the RxAllDeliverToOne set, in addition to being round-robined amongst clients subscribed to the topic without this override.

Returns:

Whether the RxAllDeliverToOne flag is set.

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)

Tests if equal to another topic.

Note: Topic equality ignores the Topic.isRxAllDeliverToOne() flag; topics differing only by the value of this flag are considered equal.

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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

hashCode

public int hashCode()

Gets the hashcode.

Note: Topic equality ignores the Topic.isRxAllDeliverToOne() flag; topics differing only by the value of this flag are considered equal.

Overrides:

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