ej.hoka.auth.session

Class LogoutEndpoint

java.lang.Object

ej.hoka.rest.RestEndpoint

ej.hoka.auth.session.LogoutEndpoint

public abstract class LogoutEndpoint
extends RestEndpoint

RestEndpoint that logs out users using cookie-based sessions.

See Also:

LoginEndpoint, AuthenticatedRequestHandler

Field Summary

Fields inherited from class ej.hoka.rest.RestEndpoint

uri

Constructor Summary

Constructors

Constructor and Description
LogoutEndpoint(java.lang.String uri, SessionAuthenticator sessionAuthenticator) Constructs the endpoint at given URI.

Method Summary

Modifier and Type	Method and Description
protected abstract HTTPResponse	failedLogoutResponse(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Constructs the response upon failed logout.
HTTPResponse	get(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles GET request on this endpoint.
protected java.lang.String	getSessionID(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Retrieves the session ID from the cookies of the request.
protected HTTPResponse	setLoggedOut(HTTPResponse response) Updates the response to delete the session ID cookie.
protected abstract HTTPResponse	successfulLogoutResponse(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Constructs the response upon successful logout.

Methods inherited from class ej.hoka.rest.RestEndpoint

delete, getURI, isGlobal, post, put

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutEndpoint

public LogoutEndpoint(java.lang.String uri,
                      SessionAuthenticator sessionAuthenticator)

Constructs the endpoint at given URI.

Parameters:

uri - the URI of the RestEndpoint.

sessionAuthenticator - the SessionAuthenticator used to logout users.

Method Detail

get

public HTTPResponse get(HTTPRequest request,
                        java.util.Map<java.lang.String,java.lang.String> attributes)

Description copied from class: RestEndpoint

Handles GET request on this endpoint.

Default implementation return a status code 501

Overrides:

get in class RestEndpoint

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.

getSessionID

protected java.lang.String getSessionID(HTTPRequest request,
                                        java.util.Map<java.lang.String,java.lang.String> attributes)

Retrieves the session ID from the cookies of the request.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the session ID.

successfulLogoutResponse

protected abstract HTTPResponse successfulLogoutResponse(HTTPRequest request,
                                                         java.util.Map<java.lang.String,java.lang.String> attributes)

Constructs the response upon successful logout.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the response to send.

failedLogoutResponse

protected abstract HTTPResponse failedLogoutResponse(HTTPRequest request,
                                                     java.util.Map<java.lang.String,java.lang.String> attributes)

Constructs the response upon failed logout.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the response to send.

setLoggedOut

protected HTTPResponse setLoggedOut(HTTPResponse response)

Updates the response to delete the session ID cookie.

Parameters:

response - the response to send.

Returns:

the response with the expired "Set-Cookie".