Package org.eclipse.jetty.security

Class DefaultIdentityService

java.lang.Object

org.eclipse.jetty.security.DefaultIdentityService

All Implemented Interfaces:

IdentityService

public class DefaultIdentityService
extends Object
implements IdentityService

The default IdentityService, which creates and uses DefaultUserIdentitys. The associate(UserIdentity, RunAsToken) method ignores the user, but will associate the IdentityService.RunAsToken with the current thread until IdentityService.Association.close() is called.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.security.IdentityService

IdentityService.Association, IdentityService.RunAsToken

Constructor Summary

Constructors

Constructor	Description
DefaultIdentityService()

Method Summary

Modifier and Type	Method	Description
IdentityService.Association	associate(UserIdentity user, IdentityService.RunAsToken runAsToken)	Associate a runas Token with the current user and thread.
UserIdentity	getSystemUserIdentity()
static boolean	isRoleAssociated(String role)
IdentityService.RunAsToken	newRunAsToken(String roleName)	Create a new RunAsToken from a runAsName (normally a role).
UserIdentity	newUserIdentity(Subject subject, Principal userPrincipal, String[] roles)	Create a new UserIdentity for use with this identity service.
void	onLogout(UserIdentity user)	Called to notify that a user has been logged out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultIdentityService

public DefaultIdentityService()

Method Details

isRoleAssociated

public static boolean isRoleAssociated(String role)

associate

public IdentityService.Association associate(UserIdentity user,
 IdentityService.RunAsToken runAsToken)

Description copied from interface: IdentityService

Associate a runas Token with the current user and thread.

Specified by:

associate in interface IdentityService

Parameters:

user - The UserIdentity

runAsToken - The runAsToken to associate, obtained from IdentityService.newRunAsToken(String), or null.

Returns:

A Closeable that, when closed, will disassociate the token and restore any prior associations.

onLogout

public void onLogout(UserIdentity user)

Description copied from interface: IdentityService

Called to notify that a user has been logged out. The service may, among other actions, close any IdentityService.Association for the calling thread.

Specified by:

onLogout in interface IdentityService

Parameters:

user - The user that has logged out

newRunAsToken

public IdentityService.RunAsToken newRunAsToken(String roleName)

Description copied from interface: IdentityService

Create a new RunAsToken from a runAsName (normally a role).

Specified by:

newRunAsToken in interface IdentityService

Parameters:

roleName - a role name

Returns:

A token that can be passed to IdentityService.associate(UserIdentity, RunAsToken).

getSystemUserIdentity

public UserIdentity getSystemUserIdentity()

Specified by:

getSystemUserIdentity in interface IdentityService

newUserIdentity

public UserIdentity newUserIdentity(Subject subject,
 Principal userPrincipal,
 String[] roles)

Description copied from interface: IdentityService

Create a new UserIdentity for use with this identity service. The UserIdentity should be immutable and able to be cached.

Specified by:

newUserIdentity in interface IdentityService

Parameters:

subject - Subject to include in UserIdentity

userPrincipal - Principal to include in UserIdentity. This will be returned from getUserPrincipal calls

roles - set of roles to include in UserIdentity.

Returns:

A new immutable UserIdententity