org.pac4j.play

Class CallbackController

java.lang.Object

play.mvc.Results

play.mvc.Controller

org.pac4j.play.CallbackController

All Implemented Interfaces:

play.mvc.Http.HeaderNames, play.mvc.Http.Status

Direct Known Subclasses:

JavaController

public class CallbackController
extends play.mvc.Controller

This controller is the class to finish the authentication process and logout the user.

Public methods : callback(), logoutAndOk() and logoutAndRedirect() must be used in the routes file.

Since:

1.0.0

Author:

Jerome Leleu

Nested Class Summary

Nested classes/interfaces inherited from class play.mvc.Results

play.mvc.Results.ByteChunks, play.mvc.Results.Chunks<A>, play.mvc.Results.Redirect, play.mvc.Results.Status, play.mvc.Results.StringChunks, play.mvc.Results.Todo

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Fields inherited from class play.mvc.Results

TODO

Fields inherited from interface play.mvc.Http.Status

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EXPECTATION_FAILED, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, UNAUTHORIZED, UNSUPPORTED_MEDIA_TYPE, USE_PROXY

Fields inherited from interface play.mvc.Http.HeaderNames

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ACCEPT_RANGES, ACCESS_CONTROL_ALLOW_CREDENTIALS, ACCESS_CONTROL_ALLOW_HEADERS, ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ACCESS_CONTROL_EXPOSE_HEADERS, ACCESS_CONTROL_MAX_AGE, ACCESS_CONTROL_REQUEST_HEADERS, ACCESS_CONTROL_REQUEST_METHOD, AGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONNECTION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FROM, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_RANGE, IF_UNMODIFIED_SINCE, LAST_MODIFIED, LOCATION, MAX_FORWARDS, ORIGIN, PRAGMA, PROXY_AUTHENTICATE, PROXY_AUTHORIZATION, RANGE, REFERER, RETRY_AFTER, SERVER, SET_COOKIE, SET_COOKIE2, TE, TRAILER, TRANSFER_ENCODING, UPGRADE, USER_AGENT, VARY, VIA, WARNING, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor and Description
CallbackController()

Method Summary

Modifier and Type	Method and Description
static play.libs.F.Promise<play.mvc.Result>	callback() This method handles the callback call from the provider to finish the authentication process.
static String	defaultUrl(String url, String defaultUrl) This method returns the default url from a specified url compared with a default url.
static play.mvc.Result	logoutAndOk() This method logouts the authenticated user and send him to a blank page.
static play.mvc.Result	logoutAndRedirect() This method logouts the authenticated user and send him to the url defined in the Constants.REDIRECT_URL_LOGOUT_PARAMETER_NAME parameter name or to the defaultLogoutUrl.

Methods inherited from class play.mvc.Controller

changeLang, changeLang, clearLang, ctx, flash, flash, flash, lang, request, response, session, session, session

Methods inherited from class play.mvc.Results

badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, badRequest, created, created, created, created, created, created, created, created, created, created, created, created, created, created, created, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, forbidden, found, found, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, movedPermanently, movedPermanently, noContent, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, notFound, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, ok, redirect, redirect, seeOther, seeOther, status, status, status, status, status, status, status, status, status, status, status, status, status, temporaryRedirect, temporaryRedirect, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized, unauthorized

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

CallbackController

public CallbackController()

Method Detail

callback

public static play.libs.F.Promise<play.mvc.Result> callback()

This method handles the callback call from the provider to finish the authentication process. The credentials and then the profile of the authenticated user is retrieved and the originally requested url (or the specific saved url) is restored.

Returns:

the redirection to the saved request

logoutAndOk

public static play.mvc.Result logoutAndOk()

This method logouts the authenticated user and send him to a blank page.

Returns:

the redirection to the blank page

logoutAndRedirect

public static play.mvc.Result logoutAndRedirect()

This method logouts the authenticated user and send him to the url defined in the Constants.REDIRECT_URL_LOGOUT_PARAMETER_NAME parameter name or to the defaultLogoutUrl. This parameter is matched against the BaseConfig.getLogoutUrlPattern().

Returns:

the redirection to the "logout url"

defaultUrl

public static String defaultUrl(String url,
                                String defaultUrl)

This method returns the default url from a specified url compared with a default url.

Parameters:

url -

defaultUrl -

Returns:

the default url