org.pac4j.play

Class LogoutController

java.lang.Object

play.mvc.Results

play.mvc.Controller

org.pac4j.play.LogoutController

All Implemented Interfaces:

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

public class LogoutController
extends play.mvc.Controller

This filter handles the (application + identity provider) logout process, based on the logoutLogic.

The configuration can be provided via setters: setDefaultUrl(String) (default logourl url), setLogoutUrlPattern(String) (pattern that logout urls must match), setLocalLogout(Boolean) (whether the application logout must be performed), setDestroySession(Boolean) (whether we must destroy the web session during the local logout) and setCentralLogout(Boolean) (whether the centralLogout must be performed).

Since:

2.0.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field and Description
protected org.pac4j.core.config.Config	config
protected play.libs.concurrent.HttpExecutionContext	ec
protected PlaySessionStore	playSessionStore

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, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_A_TEAPOT, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, LENGTH_REQUIRED, LOCKED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTI_STATUS, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PERMANENT_REDIRECT, 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, TOO_MANY_REQUESTS, UNAUTHORIZED, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, 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_DISPOSITION, CONTENT_ENCODING, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_MD5, CONTENT_RANGE, CONTENT_TRANSFER_ENCODING, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, FORWARDED, 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, X_FORWARDED_FOR, X_FORWARDED_HOST, X_FORWARDED_PORT, X_FORWARDED_PROTO, X_REQUESTED_WITH

Constructor Summary

Constructors

Constructor and Description
LogoutController()

Method Summary

Modifier and Type	Method and Description
Boolean	getCentralLogout()
org.pac4j.core.config.Config	getConfig()
String	getDefaultUrl()
Boolean	getDestroySession()
Boolean	getLocalLogout()
String	getLogoutUrlPattern()
CompletionStage<play.mvc.Result>	logout()
void	setCentralLogout(Boolean centralLogout)
void	setConfig(org.pac4j.core.config.Config config)
void	setDefaultUrl(String defaultUrl)
void	setDestroySession(Boolean destroySession)
void	setLocalLogout(Boolean localLogout)
void	setLogoutUrlPattern(String logoutUrlPattern)

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, 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, found, found, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, internalServerError, movedPermanently, movedPermanently, noContent, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, notAcceptable, 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, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, paymentRequired, permanentRedirect, permanentRedirect, redirect, redirect, seeOther, seeOther, status, status, 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, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType, unsupportedMediaType

Methods inherited from class java.lang.Object

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

Field Detail

config

@Inject
protected org.pac4j.core.config.Config config

playSessionStore

@Inject
protected PlaySessionStore playSessionStore

ec

@Inject
protected play.libs.concurrent.HttpExecutionContext ec

Constructor Detail

LogoutController

public LogoutController()

Method Detail

logout

public CompletionStage<play.mvc.Result> logout()

getDefaultUrl

public String getDefaultUrl()

setDefaultUrl

public void setDefaultUrl(String defaultUrl)

getLogoutUrlPattern

public String getLogoutUrlPattern()

setLogoutUrlPattern

public void setLogoutUrlPattern(String logoutUrlPattern)

getConfig

public org.pac4j.core.config.Config getConfig()

setConfig

public void setConfig(org.pac4j.core.config.Config config)

getLocalLogout

public Boolean getLocalLogout()

setLocalLogout

public void setLocalLogout(Boolean localLogout)

getDestroySession

public Boolean getDestroySession()

setDestroySession

public void setDestroySession(Boolean destroySession)

getCentralLogout

public Boolean getCentralLogout()

setCentralLogout

public void setCentralLogout(Boolean centralLogout)