PTDiffusionGlobalPermission Class Reference

Introduction

Permissions that protect globally scoped, access-controlled operations.

There is no related object, permission is granted globally.

See Also

PTDiffusionPathPermission

Since

6.3

Inheritance diagram for PTDiffusionGlobalPermission:

Class Methods
(instancetype)	+ authenticate
(instancetype)	+ viewSession
(instancetype)	+ modifySession
(instancetype)	+ registerHandler
(instancetype)	+ viewServer
(instancetype)	+ controlServer
(instancetype)	+ viewSecurity
(instancetype)	+ modifySecurity
(instancetype)	+ unknownGlobalPermission
(instancetype)	+ readTopicViews
(instancetype)	+ modifyTopicViews
Class Methods inherited from PTDiffusionEnumeration
(NSSet< PTDiffusionEnumeration * > *)	+ elements

Additional Inherited Members
Instance Methods inherited from PTDiffusionEnumeration
(BOOL)	- isEqualToEnumeration:

Method Documentation

+ (instancetype) authenticate

Add an authentication handler.

Returns

Instance indicating the permission to add an authentication handler.

Since

6.3

+ (instancetype) controlServer

Change the server's runtime state - for example, shut it down.

Returns

Instance indicating permission to change the server's runtime state.

Since

6.3

+ (instancetype) modifySecurity

Change the security configuration.

Returns

Instance indicating permission to change the security configuration.

Since

6.3

+ (instancetype) modifySession

Alter a client session. This covers a range of actions including:

• subscribe session to topic
• throttle session
• enable conflation for session
• close session

Returns

Instance indicating permission to alter a client session.

Since

6.3

+ (instancetype) modifyTopicViews

Modify topic views.

Returns

Instance indicating the permission to modify topic views.

Since

6.3

+ (instancetype) readTopicViews

Read topic views.

Returns

Instance indicating the permission to read topic views.

Since

6.3

+ (instancetype) registerHandler

Required to register any server-side handler.

This restricts clients from consuming resources by registering long lived handlers (or example, addMessageHandler). Typically these would never be called due to lack of other permissions.

Returns

Instance indicating permission to register any server-side handler.

Since

6.3

+ (instancetype) unknownGlobalPermission

A permission that is unsupported by the session.

Returns

Instance indicating an unsupported permission by the session.

Since

6.3

+ (instancetype) viewSecurity

Read the security configuration.

Returns

Instance indicating permission to read the security configuration.

Since

6.3

+ (instancetype) viewServer

View the server's runtime state - for example, read metrics.

Returns

Instance indicating permission to view the server's runtime state.

Since

6.3

+ (instancetype) viewSession

List or listen to client sessions.

Returns

Instance indicating the permission to list of listen to client sessions.

Since

6.3