org.pac4j.play.java

Class RequiresAuthenticationAction

java.lang.Object

play.mvc.Results

play.mvc.Action<play.mvc.Result>

org.pac4j.play.java.RequiresAuthenticationAction

public class RequiresAuthenticationAction
extends play.mvc.Action<play.mvc.Result>

This action checks if the user is not authenticated and starts the authentication process if necessary.

It handles both statefull (default) or stateless resources by delegating to a pac4j client.

• If statefull, it relies on the session and on the callback filter to terminate the authentication process.
• If stateless it validates the provided credentials and forward the request to the underlying resource if the authentication succeeds.

The filter also handles basic authorization based on two parameters: requireAnyRole and requireAllRoles.

Since:

1.0.0

Author:

Jerome Leleu, Michael Remond

Nested Class Summary

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

play.mvc.Action.Simple

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 inherited from class play.mvc.Action

configuration, delegate

Fields inherited from class play.mvc.Results

TODO

Constructor Summary

Constructors

Constructor and Description
RequiresAuthenticationAction()

Method Summary

Modifier and Type	Method and Description
protected play.libs.F.Promise<org.pac4j.core.profile.CommonProfile>	authenticate(ActionContext actionContext) Authenticates the current request by getting the credentials and the corresponding user profile.
protected play.libs.F.Promise<play.mvc.Result>	authenticationFailure(ActionContext actionContext) Default authentication failure strategy which generates an unauthorized page if stateless web service or redirect to the authentication provider after saving the original url.
protected play.libs.F.Promise<play.mvc.Result>	authenticationSuccess(org.pac4j.core.profile.CommonProfile profile, ActionContext actionContext) Default authentication success strategy which forward to the next action if the user has access or returns an access denied error otherwise.
play.libs.F.Promise<play.mvc.Result>	call(play.mvc.Http.Context ctx) Authentication algorithm.
protected boolean	hasAccess(org.pac4j.core.profile.CommonProfile profile, ActionContext actionContext) Returns true if the user defined by the profile has access to the underlying resource depending on the requireAnyRole and requireAllRoles fields.
protected boolean	isAjaxRequest(ActionContext actionContext) Is it a request Ajax?
protected boolean	isStateless(ActionContext actionContext) Is it a stateless authentication flow?
protected String	retrieveOriginalUrl(ActionContext actionContext) Retrieve the requested url from the session.
protected play.libs.F.Promise<org.pac4j.core.profile.CommonProfile>	retrieveUserProfile(ActionContext actionContext) Retrieve user profile either by looking in the session or trying to authenticate directly if stateless web service.
protected void	saveOriginalUrl(ActionContext actionContext) Save the requested url in session if the request is not Ajax.
protected void	saveUserProfile(org.pac4j.core.profile.CommonProfile profile, ActionContext actionContext) Save the user profile in session or attach it to the request if stateless web service.

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

Constructor Detail

RequiresAuthenticationAction

public RequiresAuthenticationAction()

Method Detail

call

public play.libs.F.Promise<play.mvc.Result> call(play.mvc.Http.Context ctx)

Authentication algorithm.

Specified by:

call in class play.mvc.Action<play.mvc.Result>

retrieveUserProfile

protected play.libs.F.Promise<org.pac4j.core.profile.CommonProfile> retrieveUserProfile(ActionContext actionContext)

Retrieve user profile either by looking in the session or trying to authenticate directly if stateless web service.

Parameters:

actionContext -

Returns:

authenticationFailure

protected play.libs.F.Promise<play.mvc.Result> authenticationFailure(ActionContext actionContext)

Default authentication failure strategy which generates an unauthorized page if stateless web service or redirect to the authentication provider after saving the original url.

Parameters:

actionContext -

Returns:

saveUserProfile

protected void saveUserProfile(org.pac4j.core.profile.CommonProfile profile,
                               ActionContext actionContext)

Save the user profile in session or attach it to the request if stateless web service.

Parameters:

profile -

actionContext -

authenticationSuccess

protected play.libs.F.Promise<play.mvc.Result> authenticationSuccess(org.pac4j.core.profile.CommonProfile profile,
                                                                     ActionContext actionContext)
                                                              throws Throwable

Default authentication success strategy which forward to the next action if the user has access or returns an access denied error otherwise.

Parameters:

profile -

actionContext -

Returns:

Throws:

Throwable

authenticate

protected play.libs.F.Promise<org.pac4j.core.profile.CommonProfile> authenticate(ActionContext actionContext)

Authenticates the current request by getting the credentials and the corresponding user profile.

Parameters:

actionContext -

Returns:

hasAccess

protected boolean hasAccess(org.pac4j.core.profile.CommonProfile profile,
                            ActionContext actionContext)

Returns true if the user defined by the profile has access to the underlying resource depending on the requireAnyRole and requireAllRoles fields.

Parameters:

profile -

actionContext -

Returns:

saveOriginalUrl

protected void saveOriginalUrl(ActionContext actionContext)

Save the requested url in session if the request is not Ajax.

Parameters:

actionContext -

retrieveOriginalUrl

protected String retrieveOriginalUrl(ActionContext actionContext)

Retrieve the requested url from the session.

Parameters:

actionContext -

Returns:

isAjaxRequest

protected boolean isAjaxRequest(ActionContext actionContext)

Is it a request Ajax?

Parameters:

actionContext -

Returns:

isStateless

protected boolean isStateless(ActionContext actionContext)

Is it a stateless authentication flow?

Parameters:

actionContext -

Returns: