Module org.eclipse.jetty.security

Package org.eclipse.jetty.security

Interface LoginService

All Known Implementing Classes:

AbstractLoginService, ConfigurableSpnegoLoginService, HashLoginService, JDBCLoginService

public interface LoginService

Login Service Interface.

The Login service provides an abstract mechanism for an Authenticator to check credentials and to create a UserIdentity using the set IdentityService.

Method Summary

Modifier and Type	Method	Description
IdentityService	getIdentityService()	Get the IdentityService associated with this Login Service.
java.lang.String	getName()
org.eclipse.jetty.server.UserIdentity	login(java.lang.String username, java.lang.Object credentials, jakarta.servlet.ServletRequest request)	Login a user.
void	logout(org.eclipse.jetty.server.UserIdentity user)
void	setIdentityService(IdentityService service)	Set the IdentityService associated with this Login Service.
boolean	validate(org.eclipse.jetty.server.UserIdentity user)	Validate a user identity.

Method Detail

getName

java.lang.String getName()

Returns:

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

login

org.eclipse.jetty.server.UserIdentity login(java.lang.String username,
                                            java.lang.Object credentials,
                                            jakarta.servlet.ServletRequest request)

Login a user.

Parameters:

username - The user name

credentials - The users credentials

request - TODO

Returns:

A UserIdentity if the credentials matched, otherwise null

validate

boolean validate(org.eclipse.jetty.server.UserIdentity user)

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

Parameters:

user - The user to validate

Returns:

true if authentication has not been revoked for the user.

getIdentityService

IdentityService getIdentityService()

Get the IdentityService associated with this Login Service.

Returns:

the IdentityService associated with this Login Service.

setIdentityService

void setIdentityService(IdentityService service)

Set the IdentityService associated with this Login Service.

Parameters:

service - the IdentityService associated with this Login Service.

logout

void logout(org.eclipse.jetty.server.UserIdentity user)