ej.hoka.auth.session

Class LoginEndpoint

java.lang.Object

ej.hoka.rest.RestEndpoint

ej.hoka.auth.session.LoginEndpoint

public abstract class LoginEndpoint
extends RestEndpoint

RestEndpoint that logs in users using cookie-based sessions.

See Also:

LogoutEndpoint, AuthenticatedRequestHandler

Field Summary

Fields inherited from class ej.hoka.rest.RestEndpoint

uri

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract HTTPResponse	failedLoginResponse(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Constructs the response upon failed login.
HTTPResponse	get(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles GET request on this endpoint.
protected abstract java.lang.String	login(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Checks the credentials in the request.
protected HTTPResponse	onSuccessfulLogin(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.String username, java.lang.String sessionID) Handles the login and send the appropriate response.
HTTPResponse	put(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles PUT request on this endpoint.
protected abstract HTTPResponse	successfulLoginResponse(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Constructs the response upon successful login.

Methods inherited from class ej.hoka.rest.RestEndpoint

delete, getURI, isGlobal, post

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginEndpoint

public LoginEndpoint(java.lang.String uri,
                     SessionAuthenticator authenticator)

Constructs the endpoint at given URI.

Parameters:

uri - the URI of the RestEndpoint.

authenticator - the SessionAuthenticator used to login 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.

put

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

Description copied from class: RestEndpoint

Handles PUT request on this endpoint.

Default implementation return a status code 501

Overrides:

put in class RestEndpoint

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.

login

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

Checks the credentials in the request.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the username of the logged in user, or null if login failed.

successfulLoginResponse

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

Constructs the response upon successful login.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the response to send.

failedLoginResponse

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

Constructs the response upon failed login.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

Returns:

the response to send.

onSuccessfulLogin

protected HTTPResponse onSuccessfulLogin(HTTPRequest request,
                                         java.util.Map<java.lang.String,java.lang.String> attributes,
                                         java.lang.String username,
                                         java.lang.String sessionID)

Handles the login and send the appropriate response.

Parameters:

request - the HTTPRequest.

attributes - the attributes populated by the request processing.

username - the username of the logged in user.

sessionID - the sessionID of the new session.

Returns:

the response to send.