org.alfresco.repo.webservice.accesscontrol

Class AccessControlWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.accesscontrol.AccessControlWebService

All Implemented Interfaces:

Remote, AccessControlServiceSoapPort

public class AccessControlWebService
extends AbstractWebService
implements AccessControlServiceSoapPort

Field Summary

Fields inherited from class org.alfresco.repo.webservice.AbstractWebService

contentService, dictionaryService, namespaceService, nodeService, querySessionCache, searchService, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
AccessControlWebService()

Method Summary

Methods

Modifier and Type	Method and Description
ACL[]	addACEs(Predicate predicate, ACE[] aces) Adds a number of ACE's to a collection of references.
String[]	addChildAuthorities(String parentAuthority, String[] authorities) Add an existing authority as a child of another authority.
String[]	createAuthorities(String parentAuthority, NewAuthority[] newAuthorites) Creates a new authority under a given parent authority.
void	deleteAuthorities(String[] authorities) Delete existing authority
ACL[]	getACLs(Predicate predicate, ACE filter) Get the list of the ACL's for a reference.
String[]	getAllAuthorities(AuthorityFilter filter) Get all authorities that match the filter
String[]	getAuthorities() Gets all the authorities that the current user belongs to
String[]	getChildAuthorities(String authority, SiblingAuthorityFilter filter) Gets all the child authorities of a given authority, taking into account a filter
GetClassPermissionsResult[]	getClassPermissions(String[] classNames) Gets a list of the settable permissions for a list of classes.
OwnerResult[]	getOwners(Predicate predicate) Get the current node owner.
String[]	getParentAuthorities(String authority, SiblingAuthorityFilter filter) Gets all the parent authorities of a given authority, taking into account a filter
GetPermissionsResult[]	getPermissions(Predicate predicate) Gets a list of the settable permissions for a set of references.
HasPermissionsResult[]	hasPermissions(Predicate predicate, String[] permissions) Determines whether the current authenticated user has the permissions on each of the specified references.
ACL[]	removeACEs(Predicate predicate, ACE[] aces) Removes ACE's from a collection of references.
void	removeChildAuthorities(String parentAuthority, String[] authorities) Remove a child authority
void	setAuthorityService(AuthorityService authorityService) Set the authentication service
ACL[]	setInheritPermission(Predicate predicate, boolean inheritPermission) Set the inherit permission property of a set of references.
void	setOwnableService(OwnableService ownableService) Set the ownable service
OwnerResult[]	setOwners(Predicate predicate, String owner) Sets the current node owner.
void	setPermissionService(PermissionService permissionService) Set the permissions service
void	setTransactionService(TransactionServiceImpl transactionService) Set the transaction service

Methods inherited from class org.alfresco.repo.webservice.AbstractWebService

setContentService, setDictionaryService, setNamespaceService, setNodeService, setQuerySessionCache, setSearchService, setServiceRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessControlWebService

public AccessControlWebService()

Method Detail

setTransactionService

public void setTransactionService(TransactionServiceImpl transactionService)

Set the transaction service

Parameters:

transactionService - the transaction service

setPermissionService

public void setPermissionService(PermissionService permissionService)

Set the permissions service

Parameters:

permissionService - the permissions service

setOwnableService

public void setOwnableService(OwnableService ownableService)

Set the ownable service

Parameters:

ownableService - the ownable service

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Set the authentication service

Parameters:

authorityService - the authentication service

getACLs

public ACL[] getACLs(Predicate predicate,
            ACE filter)
              throws RemoteException,
                     AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Get the list of the ACL's for a reference.

Specified by:

getACLs in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getACLs(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.accesscontrol.ACE)

addACEs

public ACL[] addACEs(Predicate predicate,
            ACE[] aces)
              throws RemoteException,
                     AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Adds a number of ACE's to a collection of references.

Specified by:

addACEs in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.addACEs(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.accesscontrol.ACE[])

removeACEs

public ACL[] removeACEs(Predicate predicate,
               ACE[] aces)
                 throws RemoteException,
                        AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Removes ACE's from a collection of references.

Specified by:

removeACEs in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.removeACEs(org.alfresco.repo.webservice.types.Predicate, org.alfresco.repo.webservice.accesscontrol.ACE[])

getPermissions

public GetPermissionsResult[] getPermissions(Predicate predicate)
                                      throws RemoteException,
                                             AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Gets a list of the settable permissions for a set of references.

Specified by:

getPermissions in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getPermissions(org.alfresco.repo.webservice.types.Predicate)

getClassPermissions

public GetClassPermissionsResult[] getClassPermissions(String[] classNames)
                                                throws RemoteException,
                                                       AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Gets a list of the settable permissions for a list of classes.

Specified by:

getClassPermissions in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getClassPermissions(java.lang.String[])

hasPermissions

public HasPermissionsResult[] hasPermissions(Predicate predicate,
                                    String[] permissions)
                                      throws RemoteException,
                                             AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Determines whether the current authenticated user has the permissions on each of the specified references.

Specified by:

hasPermissions in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.hasPermissions(org.alfresco.repo.webservice.types.Predicate, java.lang.String[])

setInheritPermission

public ACL[] setInheritPermission(Predicate predicate,
                         boolean inheritPermission)
                           throws RemoteException,
                                  AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Set the inherit permission property of a set of references.

Specified by:

setInheritPermission in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.setInheritPermission(org.alfresco.repo.webservice.types.Predicate, boolean)

getOwners

public OwnerResult[] getOwners(Predicate predicate)
                        throws RemoteException,
                               AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Get the current node owner.

Specified by:

getOwners in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getOwners(org.alfresco.repo.webservice.types.Predicate)

setOwners

public OwnerResult[] setOwners(Predicate predicate,
                      String owner)
                        throws RemoteException,
                               AccessControlFault

Description copied from interface: AccessControlServiceSoapPort

Sets the current node owner.

Specified by:

setOwners in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.setOwners(org.alfresco.repo.webservice.types.Predicate, java.lang.String)

addChildAuthorities

public String[] addChildAuthorities(String parentAuthority,
                           String[] authorities)
                             throws RemoteException,
                                    AccessControlFault

Add an existing authority as a child of another authority.

Specified by:

addChildAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.addChildAuthorities(java.lang.String, java.lang.String[])

createAuthorities

public String[] createAuthorities(String parentAuthority,
                         NewAuthority[] newAuthorites)
                           throws RemoteException,
                                  AccessControlFault

Creates a new authority under a given parent authority. If no parent authority is provided then the new authority is created at the root.

Specified by:

createAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.createAuthorities(java.lang.String, org.alfresco.repo.webservice.accesscontrol.NewAuthority[])

deleteAuthorities

public void deleteAuthorities(String[] authorities)
                       throws RemoteException,
                              AccessControlFault

Delete existing authority

Specified by:

deleteAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.deleteAuthorities(java.lang.String[])

getAllAuthorities

public String[] getAllAuthorities(AuthorityFilter filter)
                           throws RemoteException,
                                  AccessControlFault

Get all authorities that match the filter

Specified by:

getAllAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getAllAuthorities(org.alfresco.repo.webservice.accesscontrol.AuthorityFilter)

getAuthorities

public String[] getAuthorities()
                        throws RemoteException,
                               AccessControlFault

Gets all the authorities that the current user belongs to

Specified by:

getAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getAuthorities()

getChildAuthorities

public String[] getChildAuthorities(String authority,
                           SiblingAuthorityFilter filter)
                             throws RemoteException,
                                    AccessControlFault

Gets all the child authorities of a given authority, taking into account a filter

Specified by:

getChildAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getChildAuthorities(java.lang.String, org.alfresco.repo.webservice.accesscontrol.SiblingAuthorityFilter)

getParentAuthorities

public String[] getParentAuthorities(String authority,
                            SiblingAuthorityFilter filter)
                              throws RemoteException,
                                     AccessControlFault

Gets all the parent authorities of a given authority, taking into account a filter

Specified by:

getParentAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.getParentAuthorities(java.lang.String, org.alfresco.repo.webservice.accesscontrol.SiblingAuthorityFilter)

removeChildAuthorities

public void removeChildAuthorities(String parentAuthority,
                          String[] authorities)
                            throws RemoteException,
                                   AccessControlFault

Remove a child authority

Specified by:

removeChildAuthorities in interface AccessControlServiceSoapPort

Throws:

RemoteException

AccessControlFault

See Also:

AccessControlServiceSoapPort.removeChildAuthorities(java.lang.String, java.lang.String[])