com.pushtechnology.diffusion.client.features.control.clients

Interface SecurityControl.Role

Enclosing interface:

SecurityControl

public static interface SecurityControl.Role

Encapsulates the defined details for an individual role.

Method Summary

Modifier and Type	Method and Description
Set<PathPermission>	getDefaultPathPermissions() Returns the set of default path permissions assigned to the role.
Set<TopicPermission>	getDefaultTopicPermissions() Deprecated. since 6.5. Use getDefaultPathPermissions() instead.
Set<GlobalPermission>	getGlobalPermissions() Returns the set of global permissions assigned to the role.
Set<String>	getIncludedRoles() Returns a set of roles included within the role.
Optional<String>	getLockingPrincipal() Returns an Optional, if the role is locked this will return the name of the principal that can update the role.
String	getName() Returns the role name.
Map<String,Set<PathPermission>>	getPathPermissions() Returns a map of path to path permission assignments for the role.
Map<String,Set<TopicPermission>>	getTopicPermissions() Deprecated. since 6.5. Use getPathPermissions() instead.

Method Detail

getName

String getName()

Returns the role name.

Returns:

the name

getGlobalPermissions

Set<GlobalPermission> getGlobalPermissions()

Returns the set of global permissions assigned to the role.

Returns:

the set of global permissions. This may be empty indicating that the role has no global permissions assigned.

getDefaultPathPermissions

Set<PathPermission> getDefaultPathPermissions()

Returns the set of default path permissions assigned to the role.

Returns:

the set of default path permissions. This may be empty indicating that the role has no default path permissions assigned.

getDefaultTopicPermissions

@Deprecated
Set<TopicPermission> getDefaultTopicPermissions()

Deprecated. since 6.5. Use getDefaultPathPermissions() instead.

Returns the set of default path permissions assigned to the role.

Returns:

the set of default path permissions. This may be empty indicating that the role has no default path permissions assigned.

getPathPermissions

Map<String,Set<PathPermission>> getPathPermissions()

Returns a map of path to path permission assignments for the role.

Returns:

a map of paths to path permission assignments. The returned map may be empty if there are no specific path permission assignments for the role. Any individual set of permissions may also be empty if the role has explicitly had no permissions specified for the path.

getTopicPermissions

@Deprecated
Map<String,Set<TopicPermission>> getTopicPermissions()

Deprecated. since 6.5. Use getPathPermissions() instead.

Returns a map of path to path permission assignments for the role.

Returns:

a map of paths to path permission assignments. The returned map may be empty if there are no specific path permission assignments for the role. Any individual set of permissions may also be empty if the role has explicitly had no permissions specified for the path.

getIncludedRoles

Set<String> getIncludedRoles()

Returns a set of roles included within the role.

Returns:

included roles. This may be empty if the role includes no other roles.

getLockingPrincipal

Optional<String> getLockingPrincipal()

Returns an Optional, if the role is locked this will return the name of the principal that can update the role.

Returns:

the locking principal. This will not return a value if the role is not locked.