Access Control Web Service Enhancements

From AlfrescoWiki

Jump to: navigation, search

NOTE: These enhancements are currently available in Alfresco Community HEAD and 2.9C-dev for testing and evaluation.

Back to Access Control Web Service

Contents

[edit] Data Types

[edit] NewAuthority

Type representing a new authority.

  • string type - the authority type
  • string name - the (short) name of the authority

[edit] Methods

[edit] getAllAuthorities

Gets all the authorities available in the respository. The results are filtered according to various criteria.

string[] getAllAuthorities(AuthorityFilter filter)

Parameters:

  • filter - filters the list of returned authorities. This is an optional parameter, if it is not set then all available authorities will be returned.

Return:

  • an array containing the available authorities

[edit] getAuthorities

Get the authorities for the current user.

string[] getAuthorities()

Return:

  • an array of authorities

[edit] createAuthorities

Create new authorities. If no parent authority is specified then root authorities will be created.

string[] createAuthorities(string parentAuthority, NewAuthority[] newAuthorities)

Parameters:

  • parentAuthority - the parent of the newly created authorities. This is an optional parameter, if it is not specified then the authorities will be created as root authorities.
  • newAuthorities - an array containing the new authority details

Return:

  • an array containing the newly created authorities

[edit] deleteAuthorities

Delete an authority.

void deleteAuthorities(string[] authorities)

Parameters:

  • an array containing the authorities to delete

[edit] addChildAuthorities

Adds child authorities to a specified parent authority.

Authority[] addChildAuthorities(Authority parentAuthority, Authority[] authorities)

Parameters:

  • parentAuthority - the parent authority
  • authorities - an array of authorities to add as children of the parent authority

Return:

  • An array containing the added authorities

[edit] removeChildAuthorities

Remove child authorities from the specified parent authority.

void removeChildAuthorities(string parentAuthority, string[] authorities)

Parameters:

  • parentAuthority - the parent authority.
  • authorities - an array containing the authorities being removed

[edit] getChildAuthorities

Get an authorities child authorities.

string[] getChildAuthorities(string authority, SiblingAuthorityFilter filter)

Parameters:

  • authority - the authority
  • filter - filters the results. This is an optional parameter, if none specfied all results are returned.

Return:

  • an array of child authorities

[edit] getParentAuthorities

Gets an authorities parent authorities.

string[] getParentAuthorities(string authority, SiblingAuthorityFilter filter)

Parameters:

  • authority - the authority
  • filter - filters the results. This is an optional parameter, if none specified all results are returned.

Return:

  • an array of parent authorities

Back to Access Control Web Service

Retrieved from "http://wiki.alfresco.com/wiki/Access_Control_Web_Service_Enhancements"