|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.processor.BaseProcessorExtension
org.alfresco.repo.jscript.BaseScopableProcessorExtension
org.alfresco.repo.security.authority.script.ScriptAuthorityService
public class ScriptAuthorityService
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[] |
getAllRootGroups(int maxItems,
int skipCount)
Search the root groups, those without a parent group. |
ScriptGroup[] |
getAllRootGroups(ScriptPagingDetails paging)
Search the root groups, those without a parent group. |
ScriptGroup[] |
getAllRootGroupsInZone(java.lang.String zone)
Get the root groups, those without a parent group. |
ScriptGroup[] |
getAllRootGroupsInZone(java.lang.String zone,
int maxItems,
int skipCount)
Get the root groups, those without a parent group. |
ScriptGroup[] |
getAllRootGroupsInZone(java.lang.String zone,
ScriptPagingDetails paging,
java.lang.String sortBy)
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[] |
getGroups(java.lang.String filter,
ScriptPagingDetails paging)
Retreives groups matching the given filter from all zones. |
ScriptGroup[] |
getGroups(java.lang.String filter,
ScriptPagingDetails paging,
java.lang.String sortBy)
Retreives groups matching the given filter from all zones. |
ScriptGroup[] |
getGroupsInZone(java.lang.String filter,
java.lang.String zone,
ScriptPagingDetails paging,
java.lang.String sortBy)
Retreives groups matching the given filter from the given zone. |
ScriptUser |
getUser(java.lang.String username)
Get a user given their username |
ScriptGroup[] |
searchGroups(java.lang.String shortNameFilter)
Search for groups in all zones. |
ScriptGroup[] |
searchGroups(java.lang.String shortNameFilter,
ScriptPagingDetails paging,
java.lang.String sortBy)
Search for groups in all zones. |
ScriptGroup[] |
searchGroupsInZone(java.lang.String shortNameFilter,
java.lang.String zone)
Search for groups in a specific zone |
ScriptGroup[] |
searchGroupsInZone(java.lang.String shortNameFilter,
java.lang.String zone,
int maxItems,
int skipCount)
Search for groups in a specific zone Includes paging parameters to limit size of results returned. |
ScriptGroup[] |
searchGroupsInZone(java.lang.String shortNameFilter,
java.lang.String zone,
ScriptPagingDetails paging,
java.lang.String sortBy)
Search for groups in a specific zone Includes paging parameters to limit size of results returned. |
ScriptGroup[] |
searchRootGroups(java.lang.String displayNamePattern)
Search the root groups, those without a parent group. |
ScriptGroup[] |
searchRootGroups(java.lang.String displayNamePattern,
ScriptPagingDetails paging,
java.lang.String sortBy)
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. |
ScriptGroup[] |
searchRootGroupsInZone(java.lang.String displayNamePattern,
java.lang.String zone,
int maxItems,
int skipCount)
Search the root groups, those without a parent group. |
ScriptGroup[] |
searchRootGroupsInZone(java.lang.String displayNamePattern,
java.lang.String zone,
ScriptPagingDetails paging,
java.lang.String sortBy)
Search the root groups, those without a parent group. |
ScriptUser[] |
searchUsers(java.lang.String nameFilter,
ScriptPagingDetails paging,
java.lang.String sortBy)
Search for users Includes paging parameters to limit size of results returned. |
void |
setServiceRegistry(ServiceRegistry serviceRegistry)
|
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 |
---|
public ScriptAuthorityService()
Method Detail |
---|
public void setServiceRegistry(ServiceRegistry serviceRegistry)
public AuthorityService getAuthorityService()
public ScriptGroup[] searchRootGroupsInZone(java.lang.String displayNamePattern, java.lang.String zone)
public ScriptGroup[] searchRootGroupsInZone(java.lang.String displayNamePattern, java.lang.String zone, int maxItems, int skipCount)
maxItems
- Maximum number of items returned.skipCount
- number of items to skip.
public ScriptGroup[] searchRootGroupsInZone(java.lang.String displayNamePattern, java.lang.String zone, ScriptPagingDetails paging, java.lang.String sortBy)
paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (authorityName, shortName or displayName)
public ScriptGroup[] searchRootGroups(java.lang.String displayNamePattern)
public ScriptGroup[] searchRootGroups(java.lang.String displayNamePattern, ScriptPagingDetails paging, java.lang.String sortBy)
paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (authorityName, shortName or displayName)
public ScriptGroup[] getAllRootGroups()
public ScriptGroup[] getAllRootGroups(int maxItems, int skipCount)
public ScriptGroup[] getAllRootGroups(ScriptPagingDetails paging)
public ScriptGroup[] getAllRootGroupsInZone(java.lang.String zone)
zone
- zone to search in.
public ScriptGroup[] getAllRootGroupsInZone(java.lang.String zone, int maxItems, int skipCount)
zone
- zone to search in.maxItems
- Maximum number of items returned.skipCount
- number of items to skip.
public ScriptGroup[] getAllRootGroupsInZone(java.lang.String zone, ScriptPagingDetails paging, java.lang.String sortBy)
zone
- zone to search in.paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (authorityName, shortName or displayName)
public ScriptGroup[] getGroups(java.lang.String filter, ScriptPagingDetails paging)
filter
- Pattern to filter groups bypaging
- Paging details
public ScriptGroup[] getGroups(java.lang.String filter, ScriptPagingDetails paging, java.lang.String sortBy)
filter
- Pattern to filter groups bypaging
- Paging detailssortBy
- Field to sort by, can be shortName
or displayName
otherwise
the results are ordered by the authorityName
public ScriptGroup[] getGroupsInZone(java.lang.String filter, java.lang.String zone, ScriptPagingDetails paging, java.lang.String sortBy)
filter
- Pattern to filter groups byzone
- The zone in which to search for groupspaging
- Paging detailssortBy
- Field to sort by, can be shortName
, displayName
or
authorityName
, the default is displayName
public ScriptGroup getGroup(java.lang.String shortName)
shortName,
- the shortName of the group
public ScriptGroup getGroupForFullAuthorityName(java.lang.String fullAuthorityName)
fullAuthorityName,
- the shortName of the group
public ScriptGroup createRootGroup(java.lang.String shortName, java.lang.String displayName)
public ScriptGroup[] searchGroups(java.lang.String shortNameFilter)
shortNameFilter
- partial match on shortName (* and ?) work. If empty then matches everything.
public ScriptGroup[] searchGroups(java.lang.String shortNameFilter, ScriptPagingDetails paging, java.lang.String sortBy)
shortNameFilter
- partial match on shortName (* and ?) work. If empty then matches everything.paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (authorityName, shortName or displayName)
public ScriptGroup[] searchGroupsInZone(java.lang.String shortNameFilter, java.lang.String zone)
shortNameFilter
- partial match on shortName (* and ?) work. If empty then matches everything.zone
- zone to search in.
public ScriptGroup[] searchGroupsInZone(java.lang.String shortNameFilter, java.lang.String zone, int maxItems, int skipCount)
shortNameFilter
- partial match on shortName (* and ?) work. If empty then matches everything.zone
- zone to search in.maxItems
- Maximum number of items returned.skipCount
- number of items to skip.
public ScriptGroup[] searchGroupsInZone(java.lang.String shortNameFilter, java.lang.String zone, ScriptPagingDetails paging, java.lang.String sortBy)
shortNameFilter
- partial match on shortName (* and ?) work. If empty then matches everything.zone
- zone to search in.paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (authorityName, shortName or displayName)
public ScriptUser getUser(java.lang.String username)
username,
- the username of the user
public ScriptUser[] searchUsers(java.lang.String nameFilter, ScriptPagingDetails paging, java.lang.String sortBy)
nameFilter
- partial match of the name (username, first name, last name). If empty then matches everyone.paging
- Paging object with max number to return, and items to skipsortBy
- What to sort on (firstName, lastName or userName)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |