Package org.alfresco.repo.security.permissions.impl

Interface ModelDAO

All Known Implementing Classes:

PermissionModel

public interface ModelDAO

The API for the alfresco permission model.

Author:

Andy Hind

Method Summary

Modifier and Type	Method	Description
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(NodeRef nodeRef)	Get the permissions that can be set for the given node.
Set<PermissionReference>	getAllPermissions(QName type)	Get the permissions that can be set for the given type.
Set<PermissionReference>	getAllPermissions(QName type, Set<QName> aspects)	Get the permissions that can be set for the given type.
Set<PermissionReference>	getExposedPermissions(NodeRef nodeRef)	Get the permissions that are exposed to be set for the given node.
Set<PermissionReference>	getExposedPermissions(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 perm)	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(QName qname, String permissionName)	Find a permission by name in the type context.
Set<PermissionReference>	getRequiredPermissions(PermissionReference required, QName qName, Set<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?
boolean	isUnique(PermissionReference permissionReference)	Does the permission reference have a unique name?

Method Detail

getAllPermissions

Set<PermissionReference> getAllPermissions(QName type)

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

Parameters:

type - - the type in the data dictionary.

getAllPermissions

Set<PermissionReference> getAllPermissions(QName type,
                                           Set<QName> aspects)

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

Parameters:

type - - the type in the data dictionary.

getAllPermissions

Set<PermissionReference> getAllPermissions(NodeRef nodeRef)

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

Parameters:

nodeRef - NodeRef

getExposedPermissions

Set<PermissionReference> getExposedPermissions(QName type)

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

Parameters:

type - - the type in the data dictionary.

getExposedPermissions

Set<PermissionReference> getExposedPermissions(NodeRef nodeRef)

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

Parameters:

nodeRef - NodeRef

getGrantingPermissions

Set<PermissionReference> getGrantingPermissions(PermissionReference perm)

Get all the permissions that grant this permission.

Parameters:

perm - PermissionReference

getRequiredPermissions

Set<PermissionReference> getRequiredPermissions(PermissionReference required,
                                                QName qName,
                                                Set<QName> aspectQNames,
                                                RequiredPermission.On on)

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

Parameters:

required - PermissionReference

qName - QName

on - RequiredPermission.On

getUnconditionalRequiredPermissions

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

getGranteePermissions

Set<PermissionReference> getGranteePermissions(PermissionReference permissionReference)

Get the permissions which are granted by the supplied permission.

Parameters:

permissionReference - PermissionReference

getImmediateGranteePermissions

Set<PermissionReference> getImmediateGranteePermissions(PermissionReference permissionReference)

Get the permissions which are granted by the supplied permission.

Parameters:

permissionReference - PermissionReference

checkPermission

boolean checkPermission(PermissionReference required)

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

Parameters:

required - PermissionReference

Returns:

boolean

isUnique

boolean isUnique(PermissionReference permissionReference)

Does the permission reference have a unique name?

Parameters:

permissionReference - PermissionReference

Returns:

boolean

getPermissionReference

PermissionReference getPermissionReference(QName qname,
                                           String permissionName)

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

Parameters:

qname - QName

permissionName - String

Returns:

PermissionReference

getGlobalPermissionEntries

Set<? extends PermissionEntry> getGlobalPermissionEntries()

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

Returns:

Set

getAllExposedPermissions

Set<PermissionReference> getAllExposedPermissions()

Get all exposed permissions (regardless of type exposure)

getAllPermissions

Set<PermissionReference> getAllPermissions()

Get all exposed permissions (regardless of type exposure)

hasFull

boolean hasFull(PermissionReference permissionReference)

Does this permission allow full control?

Parameters:

permissionReference - PermissionReference

Returns:

boolean