Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.services.security

PermissionKey

This class holds permissioning data that identifies an action on a product in a namespace. An instance of this class is returned by the {@link caplin.component.Component#getPermissionKey getPermissionKey()} method of components that implement the caplin.component.Component interface.

In order to determine the permissions assigned to a user, the permissioning data returned by the methods of this class can be passed as parameters to caplin.services.security.PermissionService#canUserPerformAction and caplin.services.security.PermissionService#addPermissionListener.

Constructor Summary

Attributes Name and Description
caplin.services.security.PermissionKey(String sProduct, String sNamespace, String sAction)

Creates a new PermissionKey.

Method Summary

Attributes Name and Description
String getAction()

Gets the permissioning action that was assigned to this instance (for example "VIEW").
String getNamespace()

Gets the permisssioning namespace that was assigned to this instance (for example "null").
String getProduct()

Gets the product name that was assigned to this instance (for example "/FX/Major").

Constructor Detail

► caplin.services.security.PermissionKey(String sProduct, String sNamespace, String sAction)

Creates a new PermissionKey.

Parameters
String sProduct The product name that will be assigned to this instance (for example "/FX/Major").
String sNamespace (Optional) The permissioning namespace that will be assigned to this instance (for example "null"). If "null", then the assigned permission resides in the global (default) namespace.
String sAction The permissioning action that will be assigned to this instance (for example "VIEW").

Method Detail

► String getAction()

Gets the permissioning action that was assigned to this instance (for example "VIEW").

Returns
The assigned permissioning action.

► String getNamespace()

Gets the permisssioning namespace that was assigned to this instance (for example "null").

Returns
The assigned permissioning namespace.

► String getProduct()

Gets the product name that was assigned to this instance (for example "/FX/Major").

Returns
The assigned product name.