Package org.eclipse.jetty.security

Class AbstractLoginService

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.security.AbstractLoginService

All Implemented Interfaces:

LoginService, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

DataSourceLoginService, HashLoginService, JDBCLoginService

public abstract class AbstractLoginService
extends ContainerLifeCycle
implements LoginService

AbstractLoginService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractLoginService.RolePrincipal	RolePrincipal
static class	AbstractLoginService.UserPrincipal	UserPrincipal

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_fullValidate
protected IdentityService	_identityService
protected java.lang.String	_name

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractLoginService()

Method Summary

Modifier and Type	Method	Description
IdentityService	getIdentityService()	Get the IdentityService associated with this Login Service.
java.lang.String	getName()
boolean	isFullValidate()
protected abstract java.lang.String[]	loadRoleInfo(AbstractLoginService.UserPrincipal user)
protected abstract AbstractLoginService.UserPrincipal	loadUserInfo(java.lang.String username)
UserIdentity	login(java.lang.String username, java.lang.Object credentials, javax.servlet.ServletRequest request)	Login a user.
void	logout(UserIdentity user)
void	setFullValidate(boolean fullValidate)
void	setIdentityService(IdentityService identityService)	Set the identityService.
void	setName(java.lang.String name)	Set the name.
java.lang.String	toString()
boolean	validate(UserIdentity user)	Validate a user identity.

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, doStop, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Field Detail

_identityService

protected IdentityService _identityService

_name

protected java.lang.String _name

_fullValidate

protected boolean _fullValidate

Constructor Detail

AbstractLoginService

protected AbstractLoginService()

Method Detail

loadRoleInfo

protected abstract java.lang.String[] loadRoleInfo(AbstractLoginService.UserPrincipal user)

loadUserInfo

protected abstract AbstractLoginService.UserPrincipal loadUserInfo(java.lang.String username)

getName

public java.lang.String getName()

Specified by:

getName in interface LoginService

Returns:

Get the name of the login service (aka Realm name)

See Also:

LoginService.getName()

setIdentityService

public void setIdentityService(IdentityService identityService)

Set the identityService.

Specified by:

setIdentityService in interface LoginService

Parameters:

identityService - the identityService to set

setName

public void setName(java.lang.String name)

Set the name.

Parameters:

name - the name to set

toString

public java.lang.String toString()

Overrides:

toString in class AbstractLifeCycle

login

public UserIdentity login(java.lang.String username,
                          java.lang.Object credentials,
                          javax.servlet.ServletRequest request)

Description copied from interface: LoginService

Login a user.

Specified by:

login in interface LoginService

Parameters:

username - The user name

credentials - The users credentials

request - TODO

Returns:

A UserIdentity if the credentials matched, otherwise null

See Also:

LoginService.login(java.lang.String, java.lang.Object, javax.servlet.ServletRequest)

validate

public boolean validate(UserIdentity user)

Description copied from interface: LoginService

Validate a user identity. Validate that a UserIdentity previously created by a call to LoginService.login(String, Object, ServletRequest) is still valid.

Specified by:

validate in interface LoginService

Parameters:

user - The user to validate

Returns:

true if authentication has not been revoked for the user.

See Also:

LoginService.validate(org.eclipse.jetty.server.UserIdentity)

getIdentityService

public IdentityService getIdentityService()

Description copied from interface: LoginService

Get the IdentityService associated with this Login Service.

Specified by:

getIdentityService in interface LoginService

Returns:

the IdentityService associated with this Login Service.

See Also:

LoginService.getIdentityService()

logout

public void logout(UserIdentity user)

Specified by:

logout in interface LoginService

See Also:

LoginService.logout(org.eclipse.jetty.server.UserIdentity)

isFullValidate

public boolean isFullValidate()

setFullValidate

public void setFullValidate(boolean fullValidate)