|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AliasManager
API to manage application-specific user aliases.
Method Summary | |
---|---|
String |
findAliasByUsername(Application application,
String username)
Will return the 'alias' associated to the user. |
String |
findUsernameByAlias(Application application,
String authenticatingUsername)
Will return the 'real' username of the authenticating user. |
void |
removeAlias(Application application,
String username)
Remove an application-specific alias for a username. |
List<String> |
search(EntityQuery entityQuery)
Perform an AliasQuery search on the alias tables of Crowd. |
void |
storeAlias(Application application,
String username,
String alias)
Add or update the application-specific alias for a username. |
Method Detail |
---|
String findUsernameByAlias(Application application, String authenticatingUsername)
application
- the application the user is associated withauthenticatingUsername
- the username passed to the application for authentication
IllegalArgumentException
- if either application or authenticatingUsername are nullString findAliasByUsername(Application application, String username)
application
- the application the user is associated withusername
- the 'real' username of the user
IllegalArgumentException
- if either application or authenticatingUsername are nullList<String> search(EntityQuery entityQuery)
AliasQuery
search on the alias tables of Crowd.
entityQuery
- Will accept an entity query for aliases as an AliasQuery
List
of usernames for a given AliasQuery
or an empty listvoid storeAlias(Application application, String username, String alias) throws AliasAlreadyInUseException
application
- application context.username
- real username of user in directory.alias
- application-specific alias (cannot be null
or blank).
IllegalArgumentException
- if parameters are null
or blank.
AliasAlreadyInUseException
- the alias is already in use by another user for the given application.void removeAlias(Application application, String username) throws AliasAlreadyInUseException
application
- application context.username
- real username of user in directory.
AliasAlreadyInUseException
- the username is already in use by another user as their alias for the given application.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |