org.alfresco.repo.security.permissions.impl.model

Class PermissionModel

java.lang.Object

org.alfresco.repo.security.permissions.impl.model.PermissionModel

All Implemented Interfaces:

ModelDAO

public class PermissionModel
extends Object
implements ModelDAO

The implementation of the model DAO Reads and stores the top level model information Encapsulates access to this information

Author:

andyh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PermissionModel.RequiredKey Cache key

Constructor Summary

Constructors

Constructor and Description
PermissionModel() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addPermissionModel(String model) Adds a permission model
boolean	checkPermission(PermissionReference required) Is this permission refernece to a permission and not a permissoinSet?
Set<PermissionReference>	getAllExposedPermissions() Get all exposed permissions (regardless of type exposure)
Set<PermissionReference>	getAllPermissions() Get all exposed permissions (regardless of type exposure)
Set<PermissionReference>	getAllPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the permissions that can be set for the given node.
Set<PermissionReference>	getAllPermissions(org.alfresco.service.namespace.QName type) Get the permissions that can be set for the given type.
Set<PermissionReference>	getAllPermissions(org.alfresco.service.namespace.QName typeName, Set<org.alfresco.service.namespace.QName> aspects) Get the permissions that can be set for the given type.
org.alfresco.service.cmr.security.AccessStatus	getDefaultPermission() Set the default access status
org.alfresco.service.cmr.security.AccessStatus	getDefaultPermission(PermissionReference pr) Get the default acces status for the givne permission
Set<PermissionReference>	getExposedPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the permissions that are exposed to be set for the given node.
Set<PermissionReference>	getExposedPermissions(org.alfresco.service.namespace.QName type) Get the permissions that are exposed to be set for the given type.
Set<? extends PermissionEntry>	getGlobalPermissionEntries() Get the global permissions for the model.
Set<PermissionReference>	getGranteePermissions(PermissionReference permissionReference) Get the permissions which are granted by the supplied permission.
Set<PermissionReference>	getGrantingPermissions(PermissionReference permissionReference) Get all the permissions that grant this permission.
Set<PermissionReference>	getImmediateGranteePermissions(PermissionReference permissionReference) Get the permissions which are granted by the supplied permission.
PermissionReference	getPermissionReference(org.alfresco.service.namespace.QName qname, String permissionName) Find a permission by name in the type context.
Map<org.alfresco.service.namespace.QName,PermissionSet>	getPermissionSets() Get the permission sets by type
Set<PermissionReference>	getRequiredPermissions(PermissionReference required, org.alfresco.service.namespace.QName qName, Set<org.alfresco.service.namespace.QName> aspectQNames, RequiredPermission.On on) Get the permissions that must also be present on the node for the required permission to apply.
Set<PermissionReference>	getUnconditionalRequiredPermissions(PermissionReference required, RequiredPermission.On on)
boolean	hasFull(PermissionReference permissionReference) Does this permission allow full control?
void	init() Adds the model.
boolean	isUnique(PermissionReference permissionReference) Does the permission reference have a unique name?
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService) Set the dictionary service
void	setDtdSchema(String dtdSchema) Set the dtd schema that is used to validate permission model
void	setModel(String model) Set the model
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService) Set the node service
void	setValidate(boolean validate) Indicates whether model should be validated on initialization against specified dtd

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PermissionModel

public PermissionModel()

Default constructor

Method Detail

setModel

public void setModel(String model)

Set the model

Parameters:

model - String

setDtdSchema

public void setDtdSchema(String dtdSchema)

Set the dtd schema that is used to validate permission model

Parameters:

dtdSchema - String

setValidate

public void setValidate(boolean validate)

Indicates whether model should be validated on initialization against specified dtd

Parameters:

validate - boolean

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

Set the dictionary service

Parameters:

dictionaryService - DictionaryService

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Set the node service

Parameters:

nodeService - NodeService

init

public void init()

Adds the model.

addPermissionModel

public void addPermissionModel(String model)

Adds a permission model

Parameters:

model - path to the permission model to add

getDefaultPermission

public org.alfresco.service.cmr.security.AccessStatus getDefaultPermission()

Set the default access status

Returns:

the default access status

getDefaultPermission

public org.alfresco.service.cmr.security.AccessStatus getDefaultPermission(PermissionReference pr)

Get the default acces status for the givne permission

Parameters:

pr - PermissionReference

Returns:

the access status

getGlobalPermissionEntries

public Set<? extends PermissionEntry> getGlobalPermissionEntries()

Description copied from interface: ModelDAO

Get the global permissions for the model. Permissions that apply to all nodes and take precedence over node specific permissions.

Specified by:

getGlobalPermissionEntries in interface ModelDAO

Returns:

Set

getPermissionSets

public Map<org.alfresco.service.namespace.QName,PermissionSet> getPermissionSets()

Get the permission sets by type

Returns:

the permission sets by type

getAllPermissions

public Set<PermissionReference> getAllPermissions(org.alfresco.service.namespace.QName type)

Description copied from interface: ModelDAO

Get the permissions that can be set for the given type.

Specified by:

getAllPermissions in interface ModelDAO

Parameters:

type - - the type in the data dictionary.

getExposedPermissions

public Set<PermissionReference> getExposedPermissions(org.alfresco.service.namespace.QName type)

Description copied from interface: ModelDAO

Get the permissions that are exposed to be set for the given type.

Specified by:

getExposedPermissions in interface ModelDAO

Parameters:

type - - the type in the data dictionary.

getAllPermissions

public Set<PermissionReference> getAllPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ModelDAO

Get the permissions that can be set for the given node. This is determined by the node type.

Specified by:

getAllPermissions in interface ModelDAO

Parameters:

nodeRef - NodeRef

getExposedPermissions

public Set<PermissionReference> getExposedPermissions(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Description copied from interface: ModelDAO

Get the permissions that are exposed to be set for the given node. This is determined by the node type.

Specified by:

getExposedPermissions in interface ModelDAO

Parameters:

nodeRef - NodeRef

getAllPermissions

public Set<PermissionReference> getAllPermissions(org.alfresco.service.namespace.QName typeName,
                                                  Set<org.alfresco.service.namespace.QName> aspects)

Description copied from interface: ModelDAO

Get the permissions that can be set for the given type.

Specified by:

getAllPermissions in interface ModelDAO

Parameters:

typeName - - the type in the data dictionary.

getGrantingPermissions

public Set<PermissionReference> getGrantingPermissions(PermissionReference permissionReference)

Description copied from interface: ModelDAO

Get all the permissions that grant this permission.

Specified by:

getGrantingPermissions in interface ModelDAO

Parameters:

permissionReference - PermissionReference

checkPermission

public boolean checkPermission(PermissionReference required)

Description copied from interface: ModelDAO

Is this permission refernece to a permission and not a permissoinSet?

Specified by:

checkPermission in interface ModelDAO

Parameters:

required - PermissionReference

Returns:

boolean

getGranteePermissions

public Set<PermissionReference> getGranteePermissions(PermissionReference permissionReference)

Description copied from interface: ModelDAO

Get the permissions which are granted by the supplied permission.

Specified by:

getGranteePermissions in interface ModelDAO

Parameters:

permissionReference - PermissionReference

getImmediateGranteePermissions

public Set<PermissionReference> getImmediateGranteePermissions(PermissionReference permissionReference)

Description copied from interface: ModelDAO

Get the permissions which are granted by the supplied permission.

Specified by:

getImmediateGranteePermissions in interface ModelDAO

Parameters:

permissionReference - PermissionReference

getPermissionReference

public PermissionReference getPermissionReference(org.alfresco.service.namespace.QName qname,
                                                  String permissionName)

Description copied from interface: ModelDAO

Find a permission by name in the type context. If the context is null and the permission name is unique it will be found.

Specified by:

getPermissionReference in interface ModelDAO

Parameters:

qname - QName

permissionName - String

Returns:

PermissionReference

getRequiredPermissions

public Set<PermissionReference> getRequiredPermissions(PermissionReference required,
                                                       org.alfresco.service.namespace.QName qName,
                                                       Set<org.alfresco.service.namespace.QName> aspectQNames,
                                                       RequiredPermission.On on)

Description copied from interface: ModelDAO

Get the permissions that must also be present on the node for the required permission to apply.

Specified by:

getRequiredPermissions in interface ModelDAO

Parameters:

required - PermissionReference

qName - QName

on - RequiredPermission.On

getUnconditionalRequiredPermissions

public Set<PermissionReference> getUnconditionalRequiredPermissions(PermissionReference required,
                                                                    RequiredPermission.On on)

Specified by:

getUnconditionalRequiredPermissions in interface ModelDAO

isUnique

public boolean isUnique(PermissionReference permissionReference)

Description copied from interface: ModelDAO

Does the permission reference have a unique name?

Specified by:

isUnique in interface ModelDAO

Parameters:

permissionReference - PermissionReference

Returns:

boolean

getAllExposedPermissions

public Set<PermissionReference> getAllExposedPermissions()

Description copied from interface: ModelDAO

Get all exposed permissions (regardless of type exposure)

Specified by:

getAllExposedPermissions in interface ModelDAO

hasFull

public boolean hasFull(PermissionReference permissionReference)

Description copied from interface: ModelDAO

Does this permission allow full control?

Specified by:

hasFull in interface ModelDAO

Parameters:

permissionReference - PermissionReference

Returns:

boolean

getAllPermissions

public Set<PermissionReference> getAllPermissions()

Description copied from interface: ModelDAO

Get all exposed permissions (regardless of type exposure)

Specified by:

getAllPermissions in interface ModelDAO