org.eclipse.emf.emfstore.server.auth

Interface ESOrgUnitResolver

All Known Implementing Classes:

DefaultESOrgUnitResolverService

public interface ESOrgUnitResolver

Since:

1.5

Author:

emueller

Method Summary

Modifier and Type	Method and Description
ESUser	copyAndResolveUser(ESUser user) Resolves the given user and returns a copy of it with all roles.
List<ESGroup>	getGroups(ESOrgUnit orgUnit) Returns the group membership of the organizational unit.
List<ESGroup>	getGroups(ESOrgUnitId orgUnitId) Returns the group member of the organizational unit the given ESOrgUnitId belongs to.
List<ESRole>	getRolesFromGroups(ESOrgUnit orgUnit) Returns all roles that can be obtained via group membership.
void	init(ESOrgUnitProvider orgUnitProvider) Initializes this service.
ESUser	resolveRoles(ESAuthenticationInformation authInfo) Resolves the user behind the given ESAuthenticationInformation.
ESUser	resolveUser(ESOrgUnitId orgUnitId) Resolves the ID of an ESUser.

Method Detail

resolveRoles

ESUser resolveRoles(ESAuthenticationInformation authInfo)
             throws AccessControlException

Resolves the user behind the given ESAuthenticationInformation.

Parameters:

authInfo - the authentication information to be resolved

Returns:

the resolved ESUser

Throws:

AccessControlException - in case of missing access right

resolveUser

ESUser resolveUser(ESOrgUnitId orgUnitId)
            throws AccessControlException

Resolves the ID of an ESUser.

Parameters:

orgUnitId - the organization unit ID to be resolved

Returns:

the resolved ESUser

Throws:

AccessControlException - in case of missing access right

getRolesFromGroups

List<ESRole> getRolesFromGroups(ESOrgUnit orgUnit)

Returns all roles that can be obtained via group membership.

Parameters:

orgUnit - the organizational unit for which to determine the roles

Returns:

a list of ESRoles

getGroups

List<ESGroup> getGroups(ESOrgUnitId orgUnitId)
                 throws AccessControlException

Returns the group member of the organizational unit the given ESOrgUnitId belongs to.

Parameters:

orgUnitId - the ID of an organizational unit

Returns:

a list of ESGroups

Throws:

AccessControlException - in case of missing access right

getGroups

List<ESGroup> getGroups(ESOrgUnit orgUnit)

Returns the group membership of the organizational unit.

Parameters:

orgUnit - an organizational unit

Returns:

a list of ESGroups

copyAndResolveUser

ESUser copyAndResolveUser(ESUser user)

Resolves the given user and returns a copy of it with all roles.

Parameters:

user - the user to be resolved

Returns:

a copy of the user with resolved roles

init

void init(ESOrgUnitProvider orgUnitProvider)

Initializes this service.

Parameters:

orgUnitProvider - the ESOrgUnitProvider for obtaining organizational units