org.alfresco.repo.security.authority.script
Class ScriptAuthorityService

java.lang.Object
  extended by org.alfresco.repo.processor.BaseProcessorExtension
      extended by org.alfresco.repo.jscript.BaseScopableProcessorExtension
          extended by org.alfresco.repo.security.authority.script.ScriptAuthorityService
All Implemented Interfaces:
org.alfresco.processor.ProcessorExtension, Scopeable

public class ScriptAuthorityService
extends BaseScopableProcessorExtension

Script object representing the authority service. Provides Script access to groups and may in future be extended for roles and people.


Constructor Summary
ScriptAuthorityService()
           
 
Method Summary
 ScriptGroup createRootGroup(java.lang.String shortName, java.lang.String displayName)
          Create a new root group in the default application zones
 ScriptGroup[] getAllRootGroups()
          Search the root groups, those without a parent group.
 ScriptGroup[] getAllRootGroupsInZone(java.lang.String zone)
          Get the root groups, those without a parent group.
 AuthorityService getAuthorityService()
           
 ScriptGroup getGroup(java.lang.String shortName)
          Get a group given its short name
 ScriptGroup getGroupForFullAuthorityName(java.lang.String fullAuthorityName)
          Get a group given it full authority name (Which must begin with 'GROUP_'
 ScriptGroup[] searchGroups(java.lang.String shortNameFilter)
          Search for groups in all zones.
 ScriptGroup[] searchGroupsInZone(java.lang.String shortNameFilter, java.lang.String zone)
          Search for groups in a specific zone
 ScriptGroup[] searchRootGroups(java.lang.String displayNamePattern)
          Search the root groups, those without a parent group.
 ScriptGroup[] searchRootGroupsInZone(java.lang.String displayNamePattern, java.lang.String zone)
          Search the root groups, those without a parent group.
 void setAuthorityService(AuthorityService authorityService)
           
 
Methods inherited from class org.alfresco.repo.jscript.BaseScopableProcessorExtension
getScope, setScope
 
Methods inherited from class org.alfresco.repo.processor.BaseProcessorExtension
getExtensionName, register, setExtensionName, setProcessor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScriptAuthorityService

public ScriptAuthorityService()
Method Detail

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

getAuthorityService

public AuthorityService getAuthorityService()

searchRootGroupsInZone

public ScriptGroup[] searchRootGroupsInZone(java.lang.String displayNamePattern,
                                            java.lang.String zone)
Search the root groups, those without a parent group.

Returns:
The root groups (empty if there are no root groups)

searchRootGroups

public ScriptGroup[] searchRootGroups(java.lang.String displayNamePattern)
Search the root groups, those without a parent group.

Returns:
The root groups (empty if there are no root groups)

getAllRootGroups

public ScriptGroup[] getAllRootGroups()
Search the root groups, those without a parent group. Searches in all zones.

Returns:
The root groups (empty if there are no root groups)

getAllRootGroupsInZone

public ScriptGroup[] getAllRootGroupsInZone(java.lang.String zone)
Get the root groups, those without a parent group.

Parameters:
zone - zone to search in.
Returns:
The root groups (empty if there are no root groups)

getGroup

public ScriptGroup getGroup(java.lang.String shortName)
Get a group given its short name

Parameters:
shortName, - the shortName of the group
Returns:
the authority or null if it can't be found

getGroupForFullAuthorityName

public ScriptGroup getGroupForFullAuthorityName(java.lang.String fullAuthorityName)
Get a group given it full authority name (Which must begin with 'GROUP_'

Parameters:
fullAuthorityName, - the shortName of the group
Returns:
the authority or null if it can't be found

createRootGroup

public ScriptGroup createRootGroup(java.lang.String shortName,
                                   java.lang.String displayName)
Create a new root group in the default application zones

Returns:
the new root group.

searchGroups

public ScriptGroup[] searchGroups(java.lang.String shortNameFilter)
Search for groups in all zones.

Parameters:
shortNameFilter - partial match on shortName (* and ?) work. If empty then matches everything.
Returns:
the groups matching the query

searchGroupsInZone

public ScriptGroup[] searchGroupsInZone(java.lang.String shortNameFilter,
                                        java.lang.String zone)
Search for groups in a specific zone

Parameters:
shortNameFilter - partial match on shortName (* and ?) work. If empty then matches everything.
zone - zone to search in.
Returns:
the groups matching the query


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.