Implements org.eclipse.jetty.security.Authenticator.Configuration.getAuthenticationType.

Returns:String

the name of the Authenticator

Annotations

@Override

Returns:Authenticator.Factory

the authenticatorFactory

Implements org.eclipse.jetty.security.Authenticator.Configuration.getIdentityService.

Get the identityService.

Returns:IdentityService

the identityService

Annotations

@Override

Returns:List<Authenticator.Factory>

the list of discovered authenticatorFactories

Implements org.eclipse.jetty.security.Authenticator.Configuration.getLoginService.

Get the loginService.

Returns:LoginService

the loginService

Annotations

@Override

Implements org.eclipse.jetty.security.Authenticator.Configuration.getParameter.

Doc from org.eclipse.jetty.security.Authenticator.Configuration.getParameter.

Get a SecurityHandler init parameter

Parameters

key:String

parameter name

Returns:String

Parameter value or null

Annotations

@Override

Implements org.eclipse.jetty.security.Authenticator.Configuration.getParameterNames.

Doc from org.eclipse.jetty.security.Authenticator.Configuration.getParameterNames.

Get a SecurityHandler init parameter names

Returns:Set<String>

Set of parameter names

Annotations

@Override

Implements org.eclipse.jetty.security.Authenticator.Configuration.getRealmName.

Returns:String

the realmName

Annotations

@Override

Implements org.eclipse.jetty.security.Authenticator.Configuration.getSessionMaxInactiveIntervalOnAuthentication.

Doc from org.eclipse.jetty.security.Authenticator.Configuration.getSessionMaxInactiveIntervalOnAuthentication.

Get the interval in seconds, which if non-zero, will be set with Session#setMaxInactiveInterval(int) when a session is newly authenticated

Returns:int

An interval in seconds; or 0 to not set the interval on authentication; or a negative number to make the session never timeout after authentication.

Annotations

@Override

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

Invoked to handle the passed HTTP request and response.

The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

The simplest implementation is:

public boolean handle(Request request, Response response, Callback callback)
{
    callback.succeeded();
    return true;
}

A HelloWorld implementation is:

public boolean handle(Request request, Response response, Callback callback)
{
    response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
    return true;
}

Parameters

request:Request

the HTTP request to handle

response:Response

the HTTP response to handle

callback:Callback

the callback to complete when the handling is complete

Returns:boolean

True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.

Annotations

@Override

Exceptions

Exception:

if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.

Implements org.eclipse.jetty.security.Authenticator.Configuration.isSessionRenewedOnAuthentication.

Doc from org.eclipse.jetty.security.Authenticator.Configuration.isSessionRenewedOnAuthentication.

Should session ID be renewed on authentication.

Returns:boolean

true if the session ID should be renewed on authentication

Annotations

@Override

Parameters

authenticationType:String

the name of the Authenticator to use

Exceptions

IllegalStateException:

if the SecurityHandler is running

Set the authenticator.

Parameters

authenticator:Authenticator

the authenticator

Exceptions

IllegalStateException:

if the SecurityHandler is running

Parameters

authenticatorFactory:Authenticator.Factory

the authenticatorFactory to set

Exceptions

IllegalStateException:

if the SecurityHandler is running

Set the identityService.

Parameters

identityService:IdentityService

the identityService to set

Set the loginService. If a LoginService is not set, or is set to null, then during doStart() the findLoginService() method is used to locate one.

Parameters

loginService:LoginService

the loginService to set

Set an authentication parameter for retrieval via Configuration#getParameter(String)

Parameters

key:String

the key

value:String

the init value

Returns:String

previous value

Exceptions

IllegalStateException:

if the SecurityHandler is started

Parameters

realmName:String

the realmName to set

Exceptions

IllegalStateException:

if the SecurityHandler is running

Set the interval in seconds, which if non-zero, will be set with org.eclipse.jetty.server.Session#setMaxInactiveInterval(int) when a session is newly authenticated.

Parameters

seconds:int

An interval in seconds; or 0 to not set the interval on authentication; or a negative number to make the session never timeout after authentication.

See Also

Configuration#getSessionMaxInactiveIntervalOnAuthentication()

Set renew the session on Authentication.

If set to true, then on authentication, the session associated with a request is invalidated and replaced with a new session.

Parameters

renew:boolean

true to renew the authentication on session

See Also

Configuration#isSessionRenewedOnAuthentication()