com.pushtechnology.diffusion.client.features

Enum Topics.UnsubscribeReason

java.lang.Object

java.lang.Enum<Topics.UnsubscribeReason>

com.pushtechnology.diffusion.client.features.Topics.UnsubscribeReason

All Implemented Interfaces:

Serializable, Comparable<Topics.UnsubscribeReason>

Enclosing interface:

Topics

public static enum Topics.UnsubscribeReason
extends Enum<Topics.UnsubscribeReason>

The reason that an unsubscription occurred.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHORIZATION The unsubscription occurred because the session is no longer authorized to access the topic.
BACK_PRESSURE The server has a significant backlog of messages for the session, and the topic specification has the conflation topic property set to "unsubscribe".
BRANCH_MAPPINGS The unsubscription occurred because branch mapping rules changed.
CONTROL The unsubscription was requested either by another session or by the server.
REMOVAL The unsubscription occurred because the topic was removed.
REQUESTED Unsubscribed by the subscribing session.
STREAM_CHANGE A fallback stream has been unsubscribed due to the addition of a stream that selects the topic.
SUBSCRIPTION_REFRESH The server has re-subscribed this session to the topic.
UNKNOWN_UNSUBSCRIBE_REASON A reason that is unsupported by the session.

Method Summary

Modifier and Type	Method and Description
static Topics.UnsubscribeReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static Topics.UnsubscribeReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUESTED

public static final Topics.UnsubscribeReason REQUESTED

Unsubscribed by the subscribing session.

CONTROL

public static final Topics.UnsubscribeReason CONTROL

The unsubscription was requested either by another session or by the server.

REMOVAL

public static final Topics.UnsubscribeReason REMOVAL

The unsubscription occurred because the topic was removed.

AUTHORIZATION

public static final Topics.UnsubscribeReason AUTHORIZATION

The unsubscription occurred because the session is no longer authorized to access the topic.

Since:

5.9

SUBSCRIPTION_REFRESH

public static final Topics.UnsubscribeReason SUBSCRIPTION_REFRESH

The server has re-subscribed this session to the topic. Existing streams are unsubscribed because the topic type and other attributes may have changed.

This can happen if a set of servers is configured to use session replication, and a session connected to one server reconnects ( "fails over") to a different server.

Since:

5.9

STREAM_CHANGE

public static final Topics.UnsubscribeReason STREAM_CHANGE

A fallback stream has been unsubscribed due to the addition of a stream that selects the topic.

Since:

5.9

BACK_PRESSURE

public static final Topics.UnsubscribeReason BACK_PRESSURE

The server has a significant backlog of messages for the session, and the topic specification has the conflation topic property set to "unsubscribe". The session can resubscribe to the topic. The unsubscription is not persisted to the cluster. If the session fails over to a different server it will be resubscribed to the topic.

BRANCH_MAPPINGS

public static final Topics.UnsubscribeReason BRANCH_MAPPINGS

The unsubscription occurred because branch mapping rules changed.

Since:

6.7

See Also:

SessionTrees

UNKNOWN_UNSUBSCRIBE_REASON

public static final Topics.UnsubscribeReason UNKNOWN_UNSUBSCRIBE_REASON

A reason that is unsupported by the session.

Since:

6.1

Method Detail

values

public static Topics.UnsubscribeReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Topics.UnsubscribeReason c : Topics.UnsubscribeReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Topics.UnsubscribeReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null