com.canto.cumulus.prefs

Class PermissionTemplate

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.PermissionTemplate

All Implemented Interfaces:

Item

public class PermissionTemplate
extends BaseManager
implements Item

This class stores the settings for a single permission template. A permission template contains two types of permissions:

1. positive permission: are added to the permissions pool of the user or role when applying the template
2. negative permission: are removed from the permissions pool of the user or role when applying the template

See Also:

PermissionTemplatesList.getPermissionTemplate(String)

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(java.lang.String userOrRole, java.lang.String permission) Adds the specified positive permission for the specified user or role.
void	addPermissionRemoval(java.lang.String userOrRole, java.lang.String permission) Adds the specified negative permission for the specified user or role.
JPack	exportSet() Exports this set into a JPack.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this is the default permission template.
java.lang.String	getName() Returns the name of this permission template.
JPack	getPack() Internal function
java.util.Collection<java.lang.String>	getPermissionRemovals(java.lang.String userOrRole) Returns a collection of all negative permissions for the given user or role.
java.util.Collection<java.lang.String>	getPermissions(java.lang.String userOrRole) Returns a collection of all positive permissions for the given user or role.
PermissionsListTables	getPermissionsListTables() Return the table-specific permission template configuration that overwrite the generic information.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this set.
java.util.Collection<java.lang.String>	getUserAndRoleNames() Returns a collection of all uer UIDs and role names known to this template.
boolean	hasPermission(java.lang.String userOrRole, java.lang.String permission) Returns whether the given user or role has the specified positive permission.
boolean	hasPermissionRemoval(java.lang.String userOrRole, java.lang.String permission) Returns whether the given user or role has the specified negative permission.
boolean	isDefault() Returns whether this item is the default item.
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
void	removePermission(java.lang.String userOrRole, java.lang.String permission) Removes the specified positive permission for the specified user or role.
void	removePermissionRemoval(java.lang.String userOrRole, java.lang.String permission) Removes the specified negative permission for the specified user or role.
void	removeUserOrRole(java.lang.String userOrRole) Removes the user or role including all assigned permissions.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Returns the name of this permission template.

Returns:

name of this permission template

getIsDefault

public boolean getIsDefault()

Returns whether this is the default permission template.

Returns:

true if this is the default permission template

addPermission

public void addPermission(java.lang.String userOrRole,
                 java.lang.String permission)

Adds the specified positive permission for the specified user or role.

Parameters:

userOrRole - the role name or user UID to add the permission for

permission - the permission to add

addPermissionRemoval

public void addPermissionRemoval(java.lang.String userOrRole,
                        java.lang.String permission)

Adds the specified negative permission for the specified user or role.

Parameters:

userOrRole - the role name or user UID to add the permission for

permission - the permission to add as a negative permission

removeUserOrRole

public void removeUserOrRole(java.lang.String userOrRole)

Removes the user or role including all assigned permissions.

Parameters:

userOrRole - the role name or user UID to remove

removePermission

public void removePermission(java.lang.String userOrRole,
                    java.lang.String permission)

Removes the specified positive permission for the specified user or role.

Parameters:

userOrRole - the role name or user UID to remove the permission from

permission - the permission to remove

removePermissionRemoval

public void removePermissionRemoval(java.lang.String userOrRole,
                           java.lang.String permission)

Removes the specified negative permission for the specified user or role.

Parameters:

userOrRole - the role name or user UID to remove the permission from

permission - the permission to remove as a negative permission

hasPermission

public boolean hasPermission(java.lang.String userOrRole,
                    java.lang.String permission)

Returns whether the given user or role has the specified positive permission.

Parameters:

userOrRole - the role name or user UID

permission - permission name

Returns:

true if the permission is assigned as a positive permission for the given role or user

hasPermissionRemoval

public boolean hasPermissionRemoval(java.lang.String userOrRole,
                           java.lang.String permission)

Returns whether the given user or role has the specified negative permission.

Parameters:

userOrRole - the role name or user UID

permission - permission name

Returns:

true if the permission is assigned as a negative permission for the given role or user

getPermissionsListTables

public PermissionsListTables getPermissionsListTables()

Return the table-specific permission template configuration that overwrite the generic information.

Returns:

The table-specific permission template information.

Since:

8.0

getPermissions

public java.util.Collection<java.lang.String> getPermissions(java.lang.String userOrRole)

Returns a collection of all positive permissions for the given user or role.

Parameters:

userOrRole - the role name or user UID to get all positive permissions for

Returns:

collection of String permissions

getPermissionRemovals

public java.util.Collection<java.lang.String> getPermissionRemovals(java.lang.String userOrRole)

Returns a collection of all negative permissions for the given user or role.

Parameters:

userOrRole - the role name or user UID to get all negative permissions for

Returns:

collection of String permissions

getUserAndRoleNames

public java.util.Collection<java.lang.String> getUserAndRoleNames()

Returns a collection of all uer UIDs and role names known to this template.

Returns:

collection of names

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

Since:

8.1

See Also:

PermissionTemplatesList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)

getPack

public JPack getPack()

Internal function

Overrides:

getPack in class BaseManager

Returns:

data

getID

public java.lang.String getID()

Description copied from interface: Item

Returns the UID of the item in the items namespace.

Specified by:

getID in interface Item

Returns:

item UID

isDefault

public boolean isDefault()

Description copied from interface: Item

Returns whether this item is the default item.

Specified by:

isDefault in interface Item

Returns:

true if this is the default item

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Specified by:

getDescription in interface Item

Parameters:

languageID - specifying the language for the description

Returns:

description text

Since:

8.0

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Specified by:

setDescription in interface Item

Parameters:

languageID - the language to set the description for

description - the new description

Since:

8.0

getDisplayName

public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Specified by:

getDisplayName in interface Item

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

Since:

8.5

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Specified by:

setDisplayName in interface Item

Parameters:

languageID - the language to set the display name for

displayName - the new display name

Since:

8.5

isSharingRestricted

public boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Specified by:

isSharingRestricted in interface Item

Returns:

true if the set visibility is restricted to a group of users or roles

Since:

8.6

setSharingRestricted

public void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Specified by:

setSharingRestricted in interface Item

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

Since:

8.6

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.

Specified by:

getRestrictionsList in interface Item

Returns:

list of roles and users that are allowed to view this set

Since:

8.6