A B C D G H I J L O P R S W

A

ActionContext - Class in org.pac4j.play.java

Context for the RequiresAuthenticationAction aggregating the Play Http.Context and the RequiresAuthentication annotation.

authenticate(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

authenticationFailure(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

authenticationSuccess(CommonProfile, ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

B

build(Http.Context, Object) - Static method in class org.pac4j.play.java.ActionContext

Build the action context from the Play Http.Context and the RequiresAuthentication annotation.

C

call(Http.Context) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

Authentication algorithm.

callback() - Static method in class org.pac4j.play.CallbackController

This method handles the callback call from the provider to finish the authentication process.

CallbackController - Class in org.pac4j.play

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

CallbackController() - Constructor for class org.pac4j.play.CallbackController

Config - Class in org.pac4j.play

This class gathers all the configuration.

Config() - Constructor for class org.pac4j.play.Config

Constants - Interface in org.pac4j.play

This class gathers all the constants.

D

defaultUrl(String, String) - Static method in class org.pac4j.play.CallbackController

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

destroySession(WebContext) - Method in class org.pac4j.play.PlayLogoutHandler

G

generateSessionId() - Static method in class org.pac4j.play.StorageHelper

Generate a session identifier.

get(String, String) - Static method in class org.pac4j.play.StorageHelper

Get an object from storage.

get(String) - Static method in class org.pac4j.play.StorageHelper

Get an object from storage.

getCacheKeyPrefix() - Static method in class org.pac4j.play.Config

Gets the prefix used for all cache operations

getClientName() - Method in class org.pac4j.play.java.ActionContext

getClients() - Static method in class org.pac4j.play.Config

getCtx() - Method in class org.pac4j.play.java.ActionContext

getFullRequestURL() - Method in class org.pac4j.play.java.JavaWebContext

getFullRequestURL() - Method in class org.pac4j.play.scala.ScalaWebContext

getOrCreationSessionId(Http.Session) - Static method in class org.pac4j.play.StorageHelper

Get a session identifier and generates it if no session exists.

getProfile(String) - Static method in class org.pac4j.play.StorageHelper

Get the profile from storage.

getProfileTimeout() - Static method in class org.pac4j.play.Config

getRedirectAction(String) - Static method in class org.pac4j.play.java.JavaController

This method returns the url of the provider where the user must be redirected for authentication.

getRedirectAction(String, String) - Static method in class org.pac4j.play.java.JavaController

This method returns the url of the provider where the user must be redirected for authentication.

getRequest() - Method in class org.pac4j.play.java.ActionContext

getRequestedUrl(String, String) - Static method in class org.pac4j.play.StorageHelper

Get a requested url from storage.

getRequestHeader(String) - Method in class org.pac4j.play.java.JavaWebContext

getRequestHeader(String) - Method in class org.pac4j.play.scala.ScalaWebContext

getRequestMethod() - Method in class org.pac4j.play.java.JavaWebContext

getRequestMethod() - Method in class org.pac4j.play.scala.ScalaWebContext

getRequestParameter(String) - Method in class org.pac4j.play.java.JavaWebContext

getRequestParameter(String) - Method in class org.pac4j.play.scala.ScalaWebContext

getRequestParameters() - Method in class org.pac4j.play.java.JavaWebContext

getRequestParameters() - Method in class org.pac4j.play.scala.ScalaWebContext

getRequireAllRoles() - Method in class org.pac4j.play.java.ActionContext

getRequireAnyRole() - Method in class org.pac4j.play.java.ActionContext

getScheme() - Method in class org.pac4j.play.java.JavaWebContext

getScheme() - Method in class org.pac4j.play.scala.ScalaWebContext

getServerName() - Method in class org.pac4j.play.java.JavaWebContext

getServerName() - Method in class org.pac4j.play.scala.ScalaWebContext

getServerPort() - Method in class org.pac4j.play.java.JavaWebContext

getServerPort() - Method in class org.pac4j.play.scala.ScalaWebContext

getSession() - Method in class org.pac4j.play.java.JavaWebContext

getSessionAttribute(String) - Method in class org.pac4j.play.java.JavaWebContext

getSessionAttribute(String) - Method in class org.pac4j.play.scala.ScalaWebContext

getSessionId() - Method in class org.pac4j.play.java.ActionContext

getSessionTimeout() - Static method in class org.pac4j.play.Config

getTargetUrl() - Method in class org.pac4j.play.java.ActionContext

getUserProfile() - Static method in class org.pac4j.play.java.JavaController

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

getWebContext() - Method in class org.pac4j.play.java.ActionContext

H

hasAccess(CommonProfile, ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

I

isAjax() - Method in class org.pac4j.play.java.ActionContext

isAjaxRequest(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

Is it a request Ajax?

isStateless() - Method in class org.pac4j.play.java.ActionContext

isStateless(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

Is it a stateless authentication flow?

J

JavaController - Class in org.pac4j.play.java

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

JavaController() - Constructor for class org.pac4j.play.java.JavaController

JavaWebContext - Class in org.pac4j.play.java

This class is the Java web context for Play.

JavaWebContext(Http.Request, Http.Response, Http.Session) - Constructor for class org.pac4j.play.java.JavaWebContext

L

logger - Static variable in class org.pac4j.play.CallbackController

logger - Static variable in class org.pac4j.play.java.JavaController

logoutAndOk() - Static method in class org.pac4j.play.CallbackController

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

logoutAndRedirect() - Static method in class org.pac4j.play.CallbackController

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.

O

org.pac4j.play - package org.pac4j.play

org.pac4j.play.java - package org.pac4j.play.java

org.pac4j.play.scala - package org.pac4j.play.scala

P

PlayLogoutHandler - Class in org.pac4j.play

This class handles logout requests from CAS server.

PlayLogoutHandler() - Constructor for class org.pac4j.play.PlayLogoutHandler

R

recordSession(WebContext, String) - Method in class org.pac4j.play.PlayLogoutHandler

REDIRECT_URL_LOGOUT_PARAMETER_NAME - Static variable in interface org.pac4j.play.Constants

remove(String, String) - Static method in class org.pac4j.play.StorageHelper

Remove an object in storage.

remove(String) - Static method in class org.pac4j.play.StorageHelper

Remove an object from storage.

removeProfile(String) - Static method in class org.pac4j.play.StorageHelper

Remove a user profile from storage.

RequiresAuthentication - Annotation Type in org.pac4j.play.java

RequiresAuthenticationAction - Class in org.pac4j.play.java

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

RequiresAuthenticationAction() - Constructor for class org.pac4j.play.java.RequiresAuthenticationAction

retrieveOriginalUrl(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

Retrieve the requested url from the session.

retrieveUserProfile(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

S

save(String, String, Object) - Static method in class org.pac4j.play.StorageHelper

Save an object in storage.

save(String, Object, int) - Static method in class org.pac4j.play.StorageHelper

Save an object in storage.

saveOriginalUrl(ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

saveProfile(String, CommonProfile) - Static method in class org.pac4j.play.StorageHelper

Save a user profile in storage.

saveRequestedUrl(String, String, String) - Static method in class org.pac4j.play.StorageHelper

Save a requested url to storage.

saveUserProfile(CommonProfile, ActionContext) - Method in class org.pac4j.play.java.RequiresAuthenticationAction

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

ScalaWebContext<C> - Class in org.pac4j.play.scala

This class is the Scala web context for Play.

ScalaWebContext(Request<C>, Session) - Constructor for class org.pac4j.play.scala.ScalaWebContext

SEPARATOR - Static variable in interface org.pac4j.play.Constants

setCacheKeyPrefix(String) - Static method in class org.pac4j.play.Config

Sets the prefix to use for all cache operations

setClients(Clients) - Static method in class org.pac4j.play.Config

setProfileTimeout(int) - Static method in class org.pac4j.play.Config

setResponseHeader(String, String) - Method in class org.pac4j.play.java.JavaWebContext

setResponseHeader(String, String) - Method in class org.pac4j.play.scala.ScalaWebContext

setResponseStatus(int) - Method in class org.pac4j.play.scala.ScalaWebContext

setSessionAttribute(String, Object) - Method in class org.pac4j.play.java.JavaWebContext

setSessionAttribute(String, Object) - Method in class org.pac4j.play.scala.ScalaWebContext

setSessionTimeout(int) - Static method in class org.pac4j.play.Config

StorageHelper - Class in org.pac4j.play

This class is an helper to store/retrieve objects (from cache).

StorageHelper() - Constructor for class org.pac4j.play.StorageHelper

W

writeResponseContent(String) - Method in class org.pac4j.play.scala.ScalaWebContext

A B C D G H I J L O P R S W