org.alfresco.repo.security.authority

Class AuthorityServiceImpl

java.lang.Object

org.alfresco.repo.security.authority.AuthorityServiceImpl

All Implemented Interfaces:

AuthorityService, org.springframework.beans.factory.InitializingBean

public class AuthorityServiceImpl
extends Object
implements AuthorityService, org.springframework.beans.factory.InitializingBean

The default implementation of the authority service.

Author:

Andy Hind

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
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_AUTH_ALFRESCO, ZONE_AUTH_EXT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AuthorityServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addAuthority(Collection<String> parentNames, String childName) Set a given child authority to be included by the given parent authorities.
void	addAuthority(String parentName, String childName) Set an authority to include another authority.
void	addAuthorityToZones(String authorityName, Set<String> zones) Add a zone to an authority.
void	afterPropertiesSet()
boolean	authorityExists(String name) Check if an authority exists.
long	countGroups() Count the number of users (not groups)
long	countUsers() Count the number of groups
String	createAuthority(org.alfresco.service.cmr.security.AuthorityType type, String shortName) Create an authority.
String	createAuthority(org.alfresco.service.cmr.security.AuthorityType type, String shortName, String authorityDisplayName, Set<String> authorityZones) Create an authority with a display name and zone.
void	deleteAuthority(String name) Delete an authority and all its relationships.
void	deleteAuthority(String name, boolean cascade) Delete an authority and all its relationships, optionally recursively deleting child authorities of the same type.
Set<String>	findAuthorities(org.alfresco.service.cmr.security.AuthorityType type, String parentAuthority, boolean immediate, String displayNamePattern, String zoneName) Search for authorities by pattern matching (* and ?) against the authority name.
Set<String>	getAllAuthorities(org.alfresco.service.cmr.security.AuthorityType type) Get all authorities by type See also "getAuthorities" (paged) alternative
Set<String>	getAllAuthoritiesInZone(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)
Set<String>	getAllRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type) Get all root authorities by type.
Set<String>	getAllRootAuthoritiesInZone(String zoneName, org.alfresco.service.cmr.security.AuthorityType type) Gets the names of all root authorities in a zone, optionally filtered by type.
Set<String>	getAuthorities() Get the authorities for the current user
org.alfresco.query.PagingResults<String>	getAuthorities(org.alfresco.service.cmr.security.AuthorityType type, String zoneName, String displayNameFilter, boolean sortByDisplayName, boolean sortAscending, org.alfresco.query.PagingRequest pagingRequest) Get authorities by type and/or zone
Set<String>	getAuthoritiesForUser(String currentUserName) Get the authorities for the given user
org.alfresco.query.PagingResults<AuthorityInfo>	getAuthoritiesInfo(org.alfresco.service.cmr.security.AuthorityType type, String zoneName, String displayNameFilter, String sortBy, boolean sortAscending, org.alfresco.query.PagingRequest pagingRequest) Get authorities by type and/or zone
String	getAuthorityDisplayName(String name) Get the display name for the given authority.
org.alfresco.service.cmr.repository.NodeRef	getAuthorityNodeRef(String name) Gets the authority node for the specified name
Set<String>	getAuthorityZones(String name) Gets the name of the zone containing the specified authority.
Set<String>	getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type, String name, boolean immediate) Get all the authorities that are contained by the given authority.
Set<String>	getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type, 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 AuthorityService.getContainingAuthoritiesInZone(AuthorityType, String, String, AuthorityFilter, int) as they will be much faster.
Set<String>	getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type, String authority, String zoneName, AuthorityService.AuthorityFilter filter, int size) Get a set of authorities with varying filter criteria
Set<String>	getDefaultZones() Get the name of the default zone.
String	getName(org.alfresco.service.cmr.security.AuthorityType type, String shortName) Create the full identifier for an authority given its short name and type.
org.alfresco.service.cmr.repository.NodeRef	getOrCreateZone(String zoneName) Gets or creates an authority zone node with the specified name
String	getShortName(String name) Extract the short name of an authority from its full identifier.
org.alfresco.service.cmr.repository.NodeRef	getZone(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.
void	init()
boolean	isAdminAuthority(String authorityName) Does the given authority have admin authority.
boolean	isGuestAuthority(String authorityName) Does the given authority have guest authority.
void	removeAuthority(String parentName, String childName) Remove an authority as a member of another authority.
void	removeAuthorityFromZones(String authorityName, Set<String> zones) Remove a zone from an authority
void	setAdminGroups(Set<String> adminGroups)
void	setAuthenticationService(AuthenticationService authenticationService)
void	setAuthorityDAO(AuthorityDAO authorityDAO)
void	setAuthorityDisplayName(String authorityName, String authorityDisplayName) Set the display name for the given authority.
void	setGuestGroups(Set<String> guestGroups)
void	setPermissionServiceSPI(PermissionServiceSPI permissionServiceSPI)
void	setPersonService(PersonService personService)
void	setPolicyComponent(PolicyComponent policyComponent)
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

AuthorityServiceImpl

public AuthorityServiceImpl()

Method Detail

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setPersonService

public void setPersonService(PersonService personService)

setAuthorityDAO

public void setAuthorityDAO(AuthorityDAO authorityDAO)

setUserNameMatcher

public void setUserNameMatcher(UserNameMatcher userNameMatcher)

setAuthenticationService

public void setAuthenticationService(AuthenticationService authenticationService)

setPermissionServiceSPI

public void setPermissionServiceSPI(PermissionServiceSPI permissionServiceSPI)

setAdminGroups

public void setAdminGroups(Set<String> adminGroups)

setGuestGroups

public void setGuestGroups(Set<String> guestGroups)

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

init

public void init()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

hasAdminAuthority

public boolean hasAdminAuthority()

Check of the current user has admin authority. There is no contract for who should have this authority, only that it can be tested here. It could be determined by group membership, role, authentication mechanism, ...

Specified by:

hasAdminAuthority in interface AuthorityService

Returns:

true if the currently authenticated user has the admin authority

isAdminAuthority

public boolean isAdminAuthority(String authorityName)

Does the given authority have admin authority.

Specified by:

isAdminAuthority in interface AuthorityService

Parameters:

authorityName - The name of the authority.

Returns:

Whether the authority is an 'administrator'.

hasGuestAuthority

public boolean hasGuestAuthority()

Check of the current user has guest authority. There is no contract for who should have this authority, only that it can be tested here. It could be determined by group membership, role, authentication mechanism, ...

Specified by:

hasGuestAuthority in interface AuthorityService

Returns:

true if the currently authenticated user has the guest authority

isGuestAuthority

public boolean isGuestAuthority(String authorityName)

Does the given authority have guest authority.

Specified by:

isGuestAuthority in interface AuthorityService

Parameters:

authorityName - The name of the authority.

Returns:

Whether the authority is a 'guest'.

countUsers

public long countUsers()

Description copied from interface: AuthorityService

Count the number of groups

Specified by:

countUsers in interface AuthorityService

Returns:

Returns the number of groups

countGroups

public long countGroups()

Description copied from interface: AuthorityService

Count the number of users (not groups)

Specified by:

countGroups in interface AuthorityService

Returns:

Returns the number of usrs

getAuthorities

public Set<String> getAuthorities()

Get the authorities for the current user

Specified by:

getAuthorities in interface AuthorityService

Returns:

authorities for the current user

getAuthoritiesForUser

public Set<String> getAuthoritiesForUser(String currentUserName)

Get the authorities for the given user

Specified by:

getAuthoritiesForUser in interface AuthorityService

getAllAuthorities

public Set<String> getAllAuthorities(org.alfresco.service.cmr.security.AuthorityType type)

Get all authorities by type See also "getAuthorities" (paged) alternative

Specified by:

getAllAuthorities in interface AuthorityService

Parameters:

type - the type of authorities - cannot be null

Returns:

all authorities by type

See Also:

(paged)

getAuthoritiesInfo

public org.alfresco.query.PagingResults<AuthorityInfo> getAuthoritiesInfo(org.alfresco.service.cmr.security.AuthorityType type,
                                                                          String zoneName,
                                                                          String displayNameFilter,
                                                                          String sortBy,
                                                                          boolean sortAscending,
                                                                          org.alfresco.query.PagingRequest pagingRequest)

Get authorities by type and/or zone

Specified by:

getAuthoritiesInfo in interface AuthorityService

Parameters:

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 "*")

sortBy - either "displayName", "shortName", "authorityName" or null if no sorting. note: for users, displayName/shortName is equivalent to the userName, for groups if the display is null then use the short name

sortAscending - if true then sort ascending else sort descending (ignore if sortByDisplayName is false)

pagingRequest - the requested page (skipCount, maxItems, queryExectionId)

getAuthorities

public org.alfresco.query.PagingResults<String> getAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
                                                               String zoneName,
                                                               String displayNameFilter,
                                                               boolean sortByDisplayName,
                                                               boolean sortAscending,
                                                               org.alfresco.query.PagingRequest pagingRequest)

Get authorities by type and/or zone

Specified by:

getAuthorities in interface AuthorityService

Parameters:

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 name

sortAscending - if true then sort ascending else sort descending (ignore if sortByDisplayName is false)

pagingRequest - the requested page (skipCount, maxItems, queryExectionId)

addAuthority

public void addAuthority(String parentName,
                         String childName)

Set an authority to include another authority. For example, adding a group to a group or adding a user to a group.

Specified by:

addAuthority in interface AuthorityService

Parameters:

parentName - - the full name string identifier for the parent.

childName - - the string identifier for the child.

addAuthority

public void addAuthority(Collection<String> parentNames,
                         String childName)

Set a given child authority to be included by the given parent authorities. For example, adding a group to groups or adding a user to groups.

Specified by:

addAuthority in interface AuthorityService

Parameters:

parentNames - - the full name string identifier for the parents.

childName - - the string identifier for the child.

createAuthority

public String createAuthority(org.alfresco.service.cmr.security.AuthorityType type,
                              String shortName)

Create an authority.

Specified by:

createAuthority in interface AuthorityService

Parameters:

type - - the type of the authority

shortName - - the short name of the authority to create this will also be set as the default display name for the authority

Returns:

the name of the authority (this will be the prefix, if any associated with the type appended with the short name)

deleteAuthority

public void deleteAuthority(String name)

Delete an authority and all its relationships. Note child authorities are not deleted.

Specified by:

deleteAuthority in interface AuthorityService

Parameters:

name - String

deleteAuthority

public void deleteAuthority(String name,
                            boolean cascade)

Delete an authority and all its relationships, optionally recursively deleting child authorities of the same type.

Specified by:

deleteAuthority in interface AuthorityService

Parameters:

name - the authority long name

cascade - should the delete be cascaded to child authorities of the same type?

getAllRootAuthorities

public Set<String> getAllRootAuthorities(org.alfresco.service.cmr.security.AuthorityType type)

Get all root authorities by type. Root authorities are ones that were created without an authority as the parent authority;

Specified by:

getAllRootAuthorities in interface AuthorityService

Parameters:

type - - the type of the authority

Returns:

all root authorities by type.

getContainedAuthorities

public Set<String> getContainedAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
                                           String name,
                                           boolean immediate)

Get all the authorities that are contained by the given authority. For a group you could get all the authorities it contains, just the users it contains or just the other groups it includes.

Specified by:

getContainedAuthorities in interface AuthorityService

Parameters:

type - - if not null, limit to the type of authority specified

name - - the name of the containing authority

immediate - - if true, limit the depth to just immediate child, if false find authorities at any depth

getContainingAuthorities

public Set<String> getContainingAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
                                            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 AuthorityService.getContainingAuthoritiesInZone(AuthorityType, String, String, AuthorityFilter, int) as they will be much faster. For example, this method can be used find out all the authorities that contain a group.

Specified by:

getContainingAuthorities in interface AuthorityService

Parameters:

type - - if not null, limit to the type of authority specified

name - - the name of the authority for which the containing authorities are required.

immediate - - limit to immediate parents or any ancestor.

getAuthorityNodeRef

public org.alfresco.service.cmr.repository.NodeRef getAuthorityNodeRef(String name)

Gets the authority node for the specified name

Specified by:

getAuthorityNodeRef in interface AuthorityService

Parameters:

name - The authority name

Returns:

the reference to the authority node

getContainingAuthoritiesInZone

public Set<String> getContainingAuthoritiesInZone(org.alfresco.service.cmr.security.AuthorityType type,
                                                  String authority,
                                                  String zoneName,
                                                  AuthorityService.AuthorityFilter filter,
                                                  int size)

Get a set of authorities with varying filter criteria

Specified by:

getContainingAuthoritiesInZone in interface AuthorityService

Parameters:

type - authority type or null for all types

authority - if non-null, only return those authorities who contain this authority

zoneName - if non-null, only include authorities in the named zone

filter - optional callback to apply further filter criteria or null

size - if greater than zero, the maximum results to return. The search strategy used is varied depending on this number.

Returns:

a set of authorities

removeAuthority

public void removeAuthority(String parentName,
                            String childName)

Description copied from interface: AuthorityService

Remove an authority as a member of another authority. The child authority will still exist. If the child authority was not created as a root authority and you remove its creation link, it will be moved to a root authority. If you want rid of it, use delete.

Specified by:

removeAuthority in interface AuthorityService

Parameters:

parentName - - the string identifier for the parent.

childName - - the string identifier for the child.

authorityExists

public boolean authorityExists(String name)

Check if an authority exists.

Specified by:

authorityExists in interface AuthorityService

Parameters:

name - (the long name).

Returns:

true, the authority exists.

createAuthority

public String createAuthority(org.alfresco.service.cmr.security.AuthorityType type,
                              String shortName,
                              String authorityDisplayName,
                              Set<String> authorityZones)

Create an authority with a display name and zone.

Specified by:

createAuthority in interface AuthorityService

Parameters:

type - the type of the authority

shortName - the short name of the authority to create

authorityDisplayName - the display name for the authority

authorityZones - identifier for external user registry owning the authority or null if not applicable

Returns:

the full name of the authority (this will be the prefix, if any associated with the type appended with the short name)

getAuthorityDisplayName

public String getAuthorityDisplayName(String name)

Get the display name for the given authority.

Specified by:

getAuthorityDisplayName in interface AuthorityService

Parameters:

name - - the full authority string including any prefix (e.g. GROUP_woof)

Returns:

- the display name

setAuthorityDisplayName

public void setAuthorityDisplayName(String authorityName,
                                    String authorityDisplayName)

Set the display name for the given authority. Setting the display name is only supported for authorities of type group

Specified by:

setAuthorityDisplayName in interface AuthorityService

Parameters:

authorityName - String

authorityDisplayName - String

getAuthorityZones

public Set<String> getAuthorityZones(String name)

Gets the name of the zone containing the specified authority.

Specified by:

getAuthorityZones in interface AuthorityService

Parameters:

name - the authority long name

Returns:

the the name of the zone containing the specified authority, AuthorityService.ZONE_APP_DEFAULT if the authority exists but has no zone, or null if the authority does not exist.

getOrCreateZone

public org.alfresco.service.cmr.repository.NodeRef getOrCreateZone(String zoneName)

Gets or creates an authority zone node with the specified name

Specified by:

getOrCreateZone in interface AuthorityService

Parameters:

zoneName - the zone name

Returns:

reference to the zone node

getZone

public org.alfresco.service.cmr.repository.NodeRef getZone(String zoneName)

Gets an authority zone node with the specified name

Specified by:

getZone in interface AuthorityService

Parameters:

zoneName - the zone name

Returns:

reference to the zone node or null

getAllAuthoritiesInZone

public Set<String> getAllAuthoritiesInZone(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)

Specified by:

getAllAuthoritiesInZone in interface AuthorityService

Parameters:

zoneName - the zone name - note: if zone does not exist then will currently return empty set

type - the authority type to filter by or null for all authority types

Returns:

the names of all authorities in a zone, optionally filtered by type

See Also:

(paged)

addAuthorityToZones

public void addAuthorityToZones(String authorityName,
                                Set<String> zones)

Add a zone to an authority.

Specified by:

addAuthorityToZones in interface AuthorityService

Parameters:

authorityName - String

removeAuthorityFromZones

public void removeAuthorityFromZones(String authorityName,
                                     Set<String> zones)

Remove a zone from an authority

Specified by:

removeAuthorityFromZones in interface AuthorityService

Parameters:

authorityName - String

getDefaultZones

public Set<String> getDefaultZones()

Get the name of the default zone.

Specified by:

getDefaultZones in interface AuthorityService

Returns:

the default zone

getAllRootAuthoritiesInZone

public Set<String> getAllRootAuthoritiesInZone(String zoneName,
                                               org.alfresco.service.cmr.security.AuthorityType type)

Gets the names of all root authorities in a zone, optionally filtered by type.

Specified by:

getAllRootAuthoritiesInZone in interface AuthorityService

Parameters:

zoneName - the zone name

type - the authority type to filter by or null for all authority types

Returns:

the names of all root authorities in a zone, optionally filtered by type

findAuthorities

public Set<String> findAuthorities(org.alfresco.service.cmr.security.AuthorityType type,
                                   String parentAuthority,
                                   boolean immediate,
                                   String displayNamePattern,
                                   String zoneName)

Search for authorities by pattern matching (* and ?) against the authority name. Note: This will use a search index to find the results (eg. via Lucene / SOLR).

Specified by:

findAuthorities in interface AuthorityService

Parameters:

type - AuthorityType

parentAuthority - if non-null, will look only for authorities who are a child of the named parent

immediate - if true then only search root groups if parentAuthority is null, or immediate children of parentAuthority if it is non-null.

displayNamePattern - String

zoneName - - may be null to indicate all zones

getName

public String getName(org.alfresco.service.cmr.security.AuthorityType type,
                      String shortName)

Create the full identifier for an authority given its short name and type.

Specified by:

getName in interface AuthorityService

Parameters:

type - AuthorityType

shortName - String

Returns:

String

getShortName

public String getShortName(String name)

Extract the short name of an authority from its full identifier.

Specified by:

getShortName in interface AuthorityService

Parameters:

name - String

Returns:

String