|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.security.authority.AuthorityServiceImpl
public class AuthorityServiceImpl
The default implementation of the authority service.
Nested Class Summary | |
---|---|
class |
AuthorityServiceImpl.UserAuthoritySet
Lazy load set of authorities. |
Nested classes/interfaces inherited from interface org.alfresco.service.cmr.security.AuthorityService |
---|
AuthorityService.AuthorityFilter |
Field Summary |
---|
Fields inherited from interface org.alfresco.service.cmr.security.AuthorityService |
---|
ZONE_APP_DEFAULT, ZONE_APP_SHARE, ZONE_APP_WCM, ZONE_AUTH_ALFRESCO, ZONE_AUTH_EXT_PREFIX |
Constructor Summary | |
---|---|
AuthorityServiceImpl()
|
Method Summary | |
---|---|
void |
addAuthority(java.util.Collection parentNames,
java.lang.String childName)
Set a given child authority to be included by the given parent authorities. |
void |
addAuthority(java.lang.String parentName,
java.lang.String childName)
Set an authority to include another authority. |
void |
addAuthorityToZones(java.lang.String authorityName,
java.util.Set zones)
Add a zone to an authority. |
void |
afterPropertiesSet()
|
boolean |
authorityExists(java.lang.String name)
Check if an authority exists. |
java.lang.String |
createAuthority(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String shortName)
Create an authority. |
java.lang.String |
createAuthority(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String shortName,
java.lang.String authorityDisplayName,
java.util.Set authorityZones)
Create an authority with a display name and zone. |
void |
deleteAuthority(java.lang.String name)
Delete an authority and all its relationships. |
void |
deleteAuthority(java.lang.String name,
boolean cascade)
Delete an authority and all its relationships, optionally recursively deleting child authorities of the same type. |
java.util.Set |
findAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String parentAuthority,
boolean immediate,
java.lang.String displayNamePattern,
java.lang.String zoneName)
Search for authorities by pattern matching (* and ?) against the authority name. |
java.util.Set |
getAllAuthorities(org.alfresco.service.cmr.security.AuthorityType type)
Get all authorities by type See also "getAuthorities" (paged) alternative |
java.util.Set |
getAllAuthoritiesInZone(java.lang.String zoneName,
org.alfresco.service.cmr.security.AuthorityType type)
Gets the names of all authorities in a zone, optionally filtered by type See also "getAuthorities" paged alternative (note: in that case, zone must exist) |
java.util.Set |
getAllRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type)
Get all root authorities by type. |
java.util.Set |
getAllRootAuthoritiesInZone(java.lang.String zoneName,
org.alfresco.service.cmr.security.AuthorityType type)
Gets the names of all root authorities in a zone, optionally filtered by type. |
java.util.Set |
getAuthorities()
Get the authorities for the current user |
org.alfresco.query.PagingResults |
getAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String zoneName,
java.lang.String displayNameFilter,
boolean sortByDisplayName,
boolean sortAscending,
org.alfresco.query.PagingRequest pagingRequest)
Get authorities by type and/or zone |
java.util.Set |
getAuthoritiesForUser(java.lang.String currentUserName)
Get the authorities for the given user |
java.lang.String |
getAuthorityDisplayName(java.lang.String name)
Get the display name for the given authority. |
org.alfresco.service.cmr.repository.NodeRef |
getAuthorityNodeRef(java.lang.String name)
Gets the authority node for the specified name |
java.util.Set |
getAuthorityZones(java.lang.String name)
Gets the name of the zone containing the specified authority. |
java.util.Set |
getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String name,
boolean immediate)
Get all the authorities that are contained by the given authority. |
java.util.Set |
getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String name,
boolean immediate)
Get the authorities that contain the given authority, but use getAuthoritiesForUser(userName).contains(authority) rather than
getContainingAuthorities(type, userName, false).contains(authority) or
use #getContainingAuthoritiesInZone(AuthorityType, String, AuthorityService.ZONE_APP_DEFAULT)
as they will be much faster. |
java.util.Set |
getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String authority,
java.lang.String zoneName,
AuthorityService.AuthorityFilter filter,
int size)
Get a set of authorities with varying filter criteria |
java.util.Set |
getDefaultZones()
Get the name of the default zone. |
java.lang.String |
getName(org.alfresco.service.cmr.security.AuthorityType type,
java.lang.String shortName)
Create the full identifier for an authority given its short name and type. |
org.alfresco.service.cmr.repository.NodeRef |
getOrCreateZone(java.lang.String zoneName)
Gets or creates an authority zone node with the specified name |
java.lang.String |
getShortName(java.lang.String name)
Extract the short name of an authority from its full identifier. |
org.alfresco.service.cmr.repository.NodeRef |
getZone(java.lang.String zoneName)
Gets an authority zone node with the specified name |
boolean |
hasAdminAuthority()
Check of the current user has admin authority. |
boolean |
hasGuestAuthority()
Check of the current user has guest authority. |
boolean |
isAdminAuthority(java.lang.String authorityName)
Does the given authority have admin authority. |
boolean |
isGuestAuthority(java.lang.String authorityName)
Does the given authority have guest authority. |
void |
removeAuthority(java.lang.String parentName,
java.lang.String childName)
Remove an authority as a member of another authority. |
void |
removeAuthorityFromZones(java.lang.String authorityName,
java.util.Set zones)
Remove a zone from an authority |
void |
setAdminGroups(java.util.Set adminGroups)
|
void |
setAuthenticationService(AuthenticationService authenticationService)
|
void |
setAuthorityDAO(AuthorityDAO authorityDAO)
|
void |
setAuthorityDisplayName(java.lang.String authorityName,
java.lang.String authorityDisplayName)
Set the display name for the given authority. |
void |
setGuestGroups(java.util.Set guestGroups)
|
void |
setPermissionServiceSPI(PermissionServiceSPI permissionServiceSPI)
|
void |
setPersonService(PersonService personService)
|
void |
setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
|
void |
setUserNameMatcher(UserNameMatcher userNameMatcher)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuthorityServiceImpl()
Method Detail |
---|
public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
public void setPersonService(PersonService personService)
public void setAuthorityDAO(AuthorityDAO authorityDAO)
public void setUserNameMatcher(UserNameMatcher userNameMatcher)
public void setAuthenticationService(AuthenticationService authenticationService)
public void setPermissionServiceSPI(PermissionServiceSPI permissionServiceSPI)
public void setAdminGroups(java.util.Set adminGroups)
public void setGuestGroups(java.util.Set guestGroups)
public void afterPropertiesSet() throws java.lang.Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
java.lang.Exception
public boolean hasAdminAuthority()
hasAdminAuthority
in interface AuthorityService
public boolean isAdminAuthority(java.lang.String authorityName)
isAdminAuthority
in interface AuthorityService
authorityName
- The name of the authority.
public boolean hasGuestAuthority()
hasGuestAuthority
in interface AuthorityService
public boolean isGuestAuthority(java.lang.String authorityName)
isGuestAuthority
in interface AuthorityService
authorityName
- The name of the authority.
public java.util.Set getAuthorities()
getAuthorities
in interface AuthorityService
public java.util.Set getAuthoritiesForUser(java.lang.String currentUserName)
getAuthoritiesForUser
in interface AuthorityService
public java.util.Set getAllAuthorities(org.alfresco.service.cmr.security.AuthorityType type)
getAllAuthorities
in interface AuthorityService
type
- the type of authorities - cannot be null
(paged)
public org.alfresco.query.PagingResults getAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String zoneName, java.lang.String displayNameFilter, boolean sortByDisplayName, boolean sortAscending, org.alfresco.query.PagingRequest pagingRequest)
getAuthorities
in interface AuthorityService
type
- the type of authorities (note: mandatory if zoneName is null)zoneName
- the zoneName (note: mandatory if type is null)displayNameFilter
- optional filter (startsWith / ignoreCase) for authority display name (note: implied trailing "*")sortByDisplayName
- if true then sort (ignoring case) by the authority display name, if false then unsorted
note: for users, displayName/shortName is equivalent to the userName, for groups if the display is null then use the short namesortAscending
- if true then sort ascending else sort descending (ignore if sortByDisplayName is false)pagingRequest
- the requested page (skipCount, maxItems, queryExectionId)public void addAuthority(java.lang.String parentName, java.lang.String childName)
addAuthority
in interface AuthorityService
parentName
- -
the full name string identifier for the parent.childName
- -
the string identifier for the child.public void addAuthority(java.util.Collection parentNames, java.lang.String childName)
addAuthority
in interface AuthorityService
parentNames
- -
the full name string identifier for the parents.childName
- -
the string identifier for the child.public java.lang.String createAuthority(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String shortName)
createAuthority
in interface AuthorityService
type
- -
the type of the authorityshortName
- -
the short name of the authority to create
this will also be set as the default display name for the authority
public void deleteAuthority(java.lang.String name)
deleteAuthority
in interface AuthorityService
public void deleteAuthority(java.lang.String name, boolean cascade)
deleteAuthority
in interface AuthorityService
name
- the authority long namecascade
- should the delete be cascaded to child authorities of the same type?public java.util.Set getAllRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type)
getAllRootAuthorities
in interface AuthorityService
type
- -
the type of the authority
public java.util.Set getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String name, boolean immediate)
getContainedAuthorities
in interface AuthorityService
type
- -
if not null, limit to the type of authority specifiedname
- -
the name of the containing authorityimmediate
- -
if true, limit the depth to just immediate child, if false
find authorities at any depth
public java.util.Set getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String name, boolean immediate)
getAuthoritiesForUser(userName).contains(authority)
rather than
getContainingAuthorities(type, userName, false).contains(authority)
or
use #getContainingAuthoritiesInZone(AuthorityType, String, AuthorityService.ZONE_APP_DEFAULT)
as they will be much faster.
For example, this method can be used find out all the authorities that contain a
group.
getContainingAuthorities
in interface AuthorityService
type
- -
if not null, limit to the type of authority specifiedname
- -
the name of the authority for which the containing authorities
are required.immediate
- -
limit to immediate parents or any ancestor.
public org.alfresco.service.cmr.repository.NodeRef getAuthorityNodeRef(java.lang.String name)
getAuthorityNodeRef
in interface AuthorityService
name
- The authority name
public java.util.Set getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String authority, java.lang.String zoneName, AuthorityService.AuthorityFilter filter, int size)
getContainingAuthoritiesInZone
in interface AuthorityService
type
- authority type or null for all typesauthority
- if non-null, only return those authorities who contain this authorityzoneName
- if non-null, only include authorities in the named zonefilter
- optional callback to apply further filter criteria or nullsize
- if greater than zero, the maximum results to return. The search strategy used is varied depending on
this number.
public void removeAuthority(java.lang.String parentName, java.lang.String childName)
AuthorityService
removeAuthority
in interface AuthorityService
parentName
- -
the string identifier for the parent.childName
- -
the string identifier for the child.public boolean authorityExists(java.lang.String name)
authorityExists
in interface AuthorityService
name
- (the long name).
public java.lang.String createAuthority(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String shortName, java.lang.String authorityDisplayName, java.util.Set authorityZones)
createAuthority
in interface AuthorityService
type
- the type of the authorityshortName
- the short name of the authority to createauthorityDisplayName
- the display name for the authority
public java.lang.String getAuthorityDisplayName(java.lang.String name)
getAuthorityDisplayName
in interface AuthorityService
name
- - the full authority string including any prefix (e.g. GROUP_woof)
public void setAuthorityDisplayName(java.lang.String authorityName, java.lang.String authorityDisplayName)
setAuthorityDisplayName
in interface AuthorityService
public java.util.Set getAuthorityZones(java.lang.String name)
getAuthorityZones
in interface AuthorityService
name
- the authority long name
AuthorityService#DEFAULT_ZONE
if the
authority exists but has no zone, or null
if the authority does not exist.public org.alfresco.service.cmr.repository.NodeRef getOrCreateZone(java.lang.String zoneName)
getOrCreateZone
in interface AuthorityService
zoneName
- the zone name
public org.alfresco.service.cmr.repository.NodeRef getZone(java.lang.String zoneName)
getZone
in interface AuthorityService
zoneName
- the zone name
public java.util.Set getAllAuthoritiesInZone(java.lang.String zoneName, org.alfresco.service.cmr.security.AuthorityType type)
getAllAuthoritiesInZone
in interface AuthorityService
zoneName
- the zone name - note: if zone does not exist then will currently return empty settype
- the authority type to filter by or null
for all authority types
(paged)
public void addAuthorityToZones(java.lang.String authorityName, java.util.Set zones)
addAuthorityToZones
in interface AuthorityService
public void removeAuthorityFromZones(java.lang.String authorityName, java.util.Set zones)
removeAuthorityFromZones
in interface AuthorityService
public java.util.Set getDefaultZones()
getDefaultZones
in interface AuthorityService
public java.util.Set getAllRootAuthoritiesInZone(java.lang.String zoneName, org.alfresco.service.cmr.security.AuthorityType type)
getAllRootAuthoritiesInZone
in interface AuthorityService
zoneName
- the zone nametype
- the authority type to filter by or null
for all authority types
public java.util.Set findAuthorities(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String parentAuthority, boolean immediate, java.lang.String displayNamePattern, java.lang.String zoneName)
findAuthorities
in interface AuthorityService
parentAuthority
- if non-null, will look only for authorities who are a child of the named parentimmediate
- if true
then only search root groups if parentAuthority is null, or immediate children of parentAuthority if it is non-null.zoneName
- - may be null to indicate all zones
public java.lang.String getName(org.alfresco.service.cmr.security.AuthorityType type, java.lang.String shortName)
getName
in interface AuthorityService
public java.lang.String getShortName(java.lang.String name)
getShortName
in interface AuthorityService
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |