org.alfresco.module.org_alfresco_module_rm.security

Interface ExtendedSecurityService

All Known Implementing Classes:

ExtendedSecurityServiceImpl

public interface ExtendedSecurityService

Extended security service.

Since:

2.1

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method and Description
void	addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers) Add extended security for the specified authorities to a node.
void	addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers, boolean applyToParents) Add extended security for the specified authorities to a node.
Set<String>	getExtendedReaders(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the set of authorities that are extended readers for the given node.
Set<String>	getExtendedWriters(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get the set of authorities that are extended writers for the given node.
boolean	hasExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether a node has extended security.
void	removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef) Remove all extended readers and writers from the given node reference.
void	removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean applyToParents) Remove all extended readers and writers from the given node reference.
void	removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers) Remove the extended security for the specified authorities from a node.
void	removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef, Set<String> readers, Set<String> writers, boolean applyToParents) Remove the extended security for the specified authorities from a node.

Method Detail

hasExtendedSecurity

boolean hasExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether a node has extended security.

Parameters:

nodeRef - node reference

Returns:

boolean true if the node has extedned security, false otherwise

getExtendedReaders

Set<String> getExtendedReaders(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the set of authorities that are extended readers for the given node.

Parameters:

nodeRef - node reference

Returns:

Set<String> set of extended readers

getExtendedWriters

Set<String> getExtendedWriters(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Get the set of authorities that are extended writers for the given node.

Parameters:

nodeRef - node reference

Returns:

Set<String> set of extended writers

addExtendedSecurity

void addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                         Set<String> readers,
                         Set<String> writers)

Add extended security for the specified authorities to a node.

Parameters:

nodeRef - node reference

readers - set of authorities to add extended read permissions

writers - set of authorities to add extended write permissions

addExtendedSecurity

void addExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                         Set<String> readers,
                         Set<String> writers,
                         boolean applyToParents)

Add extended security for the specified authorities to a node.

If specified, the read and write extended permissions are applied to all parents up to the file plan as extended read. This ensures parental read, but not parental write.

Parameters:

nodeRef - node reference

readers - set of authorities to add extended read permissions

writers - set of authorities to add extended write permissions

applyToParents - true if extended security applied to parents (read only) false otherwise.

removeExtendedSecurity

void removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                            Set<String> readers,
                            Set<String> writers)

Remove the extended security for the specified authorities from a node.

Parameters:

nodeRef - node reference

readers - set of authorities to remove as extended readers

writers - set of authorities to remove as extended writers

removeExtendedSecurity

void removeExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                            Set<String> readers,
                            Set<String> writers,
                            boolean applyToParents)

Remove the extended security for the specified authorities from a node.

If specified, extended security will also be removed from the parent hierarchy.(read only). Note that extended security is records as a reference count, so security will only be utterly removed from the parent hierarchy if all references to the authority are removed.

Parameters:

nodeRef - node reference

readers - set of authorities to remove as extended readers

writers - set of authorities to remove as extedned writers

applyToParents - true if removal of extended security is applied to parent hierarchy (read only), false otherwise

removeAllExtendedSecurity

void removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Remove all extended readers and writers from the given node reference.

Parameters:

nodeRef - node reference

removeAllExtendedSecurity

void removeAllExtendedSecurity(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                               boolean applyToParents)

Remove all extended readers and writers from the given node reference.

Parameters:

nodeRef - node reference

applyToParents - if true then apply removal to parent hierarchy (read only) false otherwise.