org.pac4j.play.java

Class JavaController

java.lang.Object

play.mvc.Results

play.mvc.Controller

org.pac4j.play.CallbackController

org.pac4j.play.java.JavaController

All Implemented Interfaces:

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

public class JavaController
extends CallbackController

This controller is the Java controller to retrieve the user profile or the redirection url to start the authentication process.

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
JavaController()

Method Summary

Modifier and Type	Method and Description
protected static org.pac4j.core.client.RedirectAction	getRedirectAction(String clientName) This method returns the url of the provider where the user must be redirected for authentication.
protected static org.pac4j.core.client.RedirectAction	getRedirectAction(String clientName, String targetUrl) This method returns the url of the provider where the user must be redirected for authentication.
protected static org.pac4j.core.profile.CommonProfile	getUserProfile() This method returns the user profile if the user is authenticated or null otherwise.

Methods inherited from class org.pac4j.play.CallbackController

callback, defaultUrl, logoutAndOk, logoutAndRedirect

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

JavaController

public JavaController()

Method Detail

getRedirectAction

protected static org.pac4j.core.client.RedirectAction getRedirectAction(String clientName)

This method returns the url of the provider where the user must be redirected for authentication. The current requested url is saved into session to be restored after authentication.

Parameters:

clientName -

Returns:

the url of the provider where to redirect the user

getRedirectAction

protected static org.pac4j.core.client.RedirectAction getRedirectAction(String clientName,
                                                                        String targetUrl)

This method returns the url of the provider where the user must be redirected for authentication. The input targetUrl (or the current requested url if null) is saved into session to be restored after authentication.

Parameters:

clientName -

targetUrl -

Returns:

the url of the provider where to redirect the user

getUserProfile

protected static org.pac4j.core.profile.CommonProfile getUserProfile()

This method returns the user profile if the user is authenticated or null otherwise.

Returns:

the user profile if the user is authenticated or null otherwise