com.pushtechnology.diffusion.client.types

Enum TopicPermission

java.lang.Object

java.lang.Enum<TopicPermission>

com.pushtechnology.diffusion.client.types.TopicPermission

All Implemented Interfaces:

Permission, Serializable, Comparable<TopicPermission>

Deprecated.

since 6.5. Replaced by the equivalent PathPermission. In previous releases, the path-scoped permissions were called "topic permissions". This was a source of confusion since some of the permissions apply to message paths or to session lock names, both of which are hierarchical but have nothing to do with topics in the topic tree. The term "topic permission" has been renamed "path permission" throughout the API. Additional methods have been added to reflect this renaming. The old methods are deprecated and will be removed in a future release.

@Deprecated
public enum TopicPermission
extends Enum<TopicPermission>
implements Permission

Permissions protecting access-controlled operations that are evaluated for a specific path.

Since:

5.2

See Also:

GlobalPermission

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACQUIRE_LOCK Deprecated. Acquire a session lock.
EDIT_OWN_TIME_SERIES_EVENTS Deprecated. Submit edits to time series topic events which have an author which is the same as the principal of the calling session.
EDIT_TIME_SERIES_EVENTS Deprecated. Submit edits to time series topic events.
MODIFY_TOPIC Deprecated. Add a topic or remove a topic.
QUERY_OBSOLETE_TIME_SERIES_EVENTS Deprecated. Evaluate queries that return a non-current view of a time series topic.
READ_TOPIC Deprecated. Required to receive information from a topic.
SELECT_TOPIC Deprecated. Use a topic selector that selects the topic path.
SEND_TO_MESSAGE_HANDLER Deprecated. Send a message to a handler registered with the server.
SEND_TO_SESSION Deprecated. Send a message to a client session.
UNKNOWN_TOPIC_PERMISSION Deprecated. A permission that is unsupported by the session.
UPDATE_TOPIC Deprecated. Update a topic.

Method Summary

Modifier and Type	Method and Description
static TopicPermission	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static TopicPermission[]	values() Deprecated. 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

SELECT_TOPIC

public static final TopicPermission SELECT_TOPIC

Deprecated.

Use a topic selector that selects the topic path.

A session must have this permission for the path prefix of any topic selector used to subscribe or fetch.

When the subscription or fetch request completes, the resulting topics are further filtered based on the READ_TOPIC permission.

A session that has READ_TOPIC but not SELECT_TOPIC for a particular topic path cannot subscribe directly to topics belonging to the path. However, the session can be independently subscribed by a control session that has GlobalPermission.MODIFY_SESSION permission in addition to the appropriate SELECT_TOPIC permission.

Since:

5.7

READ_TOPIC

public static final TopicPermission READ_TOPIC

Deprecated.

Required to receive information from a topic.

If a session does not have read_topic permission for a topic, the topic will be excluded from the results of subscription or fetch operations for the session, and the topic's details cannot be retrieved by the session.

See Also:

SELECT_TOPIC

UPDATE_TOPIC

public static final TopicPermission UPDATE_TOPIC

Deprecated.

Update a topic.

MODIFY_TOPIC

public static final TopicPermission MODIFY_TOPIC

Deprecated.

Add a topic or remove a topic.

SEND_TO_MESSAGE_HANDLER

public static final TopicPermission SEND_TO_MESSAGE_HANDLER

Deprecated.

Send a message to a handler registered with the server.

SEND_TO_SESSION

public static final TopicPermission SEND_TO_SESSION

Deprecated.

Send a message to a client session.

QUERY_OBSOLETE_TIME_SERIES_EVENTS

public static final TopicPermission QUERY_OBSOLETE_TIME_SERIES_EVENTS

Deprecated.

Evaluate queries that return a non-current view of a time series topic.

The READ_TOPIC permission is required to evaluate any type of TimeSeries.Query for a time series topic. This permission is additionally required for queries that potentially return a non-current view of all or part of a time series. Such queries include value range queries that specify an edit range, and all types of edit range query.

Since:

6.0

See Also:

TimeSeries

EDIT_TIME_SERIES_EVENTS

public static final TopicPermission EDIT_TIME_SERIES_EVENTS

Deprecated.

Submit edits to time series topic events.

The UPDATE_TOPIC permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic.

Since:

6.0

See Also:

TimeSeries, EDIT_OWN_TIME_SERIES_EVENTS

EDIT_OWN_TIME_SERIES_EVENTS

public static final TopicPermission EDIT_OWN_TIME_SERIES_EVENTS

Deprecated.

Submit edits to time series topic events which have an author which is the same as the principal of the calling session.

This permission is a more restrictive alternative to EDIT_TIME_SERIES_EVENTS.

The UPDATE_TOPIC permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic where the event author is the same as the principal of the calling session.

Since:

6.0

See Also:

TimeSeries, EDIT_TIME_SERIES_EVENTS

ACQUIRE_LOCK

public static final TopicPermission ACQUIRE_LOCK

Deprecated.

Acquire a session lock.

Since:

6.1

See Also:

Session.lock(java.lang.String)

UNKNOWN_TOPIC_PERMISSION

public static final TopicPermission UNKNOWN_TOPIC_PERMISSION

Deprecated.

A permission that is unsupported by the session.

Since:

6.1

Method Detail

values

public static TopicPermission[] values()

Deprecated.

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 (TopicPermission c : TopicPermission.values())
    System.out.println(c);

Returns:

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

valueOf

public static TopicPermission valueOf(String name)

Deprecated.

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