Enum PathPermission

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

Namespace: PushTechnology.ClientInterface.Client.Types

Assembly: Diffusion.Client.dll

Syntax

public enum PathPermission : byte

Remarks

A session must have SELECT_TOPIC permission for the PathPrefix 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 MODIFY_SESSION permission in addition to the appropriate SELECT_TOPIC permission.

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.

The READ_TOPIC permission is required to evaluate any type of IQuery<TValue> for a time series topic. The QUERY_OBSOLETE_TIME_SERIES_EVENTS 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.

The UPDATE_TOPIC permission is required to update a time series topic. The EDIT_TIME_SERIES_EVENTS permission is additionally required to submit edits via EditAsync<TValue>(String, Int64, TValue) to a time series topic.

The EDIT_OWN_TIME_SERIES_EVENTS permission is a more restrictive alternative to EDIT_TIME_SERIES_EVENTS.

The UPDATE_TOPIC permission is required to update a time series topic. The EDIT_OWN_TIME_SERIES_EVENTS permission is additionally required to submit edits via EditAsync<TValue>(String, Int64, TValue) to a time series topic where the event author is the same as the principal of the calling session.

Fields

Name	Description
ACQUIRE_LOCK	Acquire a session lock.
EDIT_OWN_TIME_SERIES_EVENTS	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	Submit edits to time series topic events.
EXPOSE_BRANCH	Expose a branch of the topic tree via a virtual session tree (see ISessionTrees).
MODIFY_TOPIC	Add a topic or remove a topic.
QUERY_OBSOLETE_TIME_SERIES_EVENTS	Evaluate queries that return a non-current view of a time series topic.
READ_TOPIC	Required to receive information from a topic.
SELECT_TOPIC	Use a topic selector that selects the topic path.
SEND_TO_MESSAGE_HANDLER	Send a message to a handler registered with the server.
SEND_TO_SESSION	Send a message to a client session.
UNKNOWN_PATH_PERMISSION	A permission that is unsupported by the session.
UPDATE_TOPIC	Update a topic.