Package org.pac4j.core.http.ajax

Class DefaultAjaxRequestResolver

java.lang.Object

org.pac4j.core.http.ajax.DefaultAjaxRequestResolver

All Implemented Interfaces:

HttpConstants, AjaxRequestResolver, Pac4jConstants

public class DefaultAjaxRequestResolver
extends java.lang.Object
implements AjaxRequestResolver, HttpConstants, Pac4jConstants

Default way to compute if a HTTP request is an AJAX one.

Since:

1.8.0

Author:

Jerome Leleu

Nested Class Summary

Nested classes/interfaces inherited from interface org.pac4j.core.context.HttpConstants

HttpConstants.HTTP_METHOD

Field Summary

Fields

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

Fields inherited from interface org.pac4j.core.context.HttpConstants

ACCEPT_HEADER, ACCESS_CONTROL_ALLOW_CREDENTIALS_HEADER, ACCESS_CONTROL_ALLOW_HEADERS_HEADER, ACCESS_CONTROL_ALLOW_METHODS_HEADER, ACCESS_CONTROL_ALLOW_ORIGIN_HEADER, ACCESS_CONTROL_EXPOSE_HEADERS_HEADER, ACCESS_CONTROL_MAX_AGE_HEADER, AJAX_HEADER_NAME, AJAX_HEADER_VALUE, APPLICATION_FORM_ENCODED_HEADER_VALUE, APPLICATION_JSON, AUTHENTICATE_HEADER, AUTHORIZATION_HEADER, BAD_REQUEST, BASIC_HEADER_PREFIX, BEARER_HEADER_PREFIX, CONTENT_TYPE_HEADER, CREATED, DEFAULT_CONNECT_TIMEOUT, DEFAULT_HTTP_PORT, DEFAULT_HTTPS_PORT, DEFAULT_READ_TIMEOUT, DIGEST_HEADER_PREFIX, FACES_PARTIAL_AJAX_PARAMETER, FORBIDDEN, FOUND, HTML_CONTENT_TYPE, LOCATION_HEADER, NO_CONTENT, OK, SCHEME_HTTP, SCHEME_HTTPS, SEE_OTHER, TEMPORARY_REDIRECT, UNAUTHORIZED

Fields inherited from interface org.pac4j.core.util.Pac4jConstants

ADD_ELEMENT, AUTHORIZERS, CENTRAL_LOGOUT, CLIENT_NAME, CLIENTS, CONFIG_FACTORY, CSRF_TOKEN, CSRF_TOKEN_EXPIRATION_DATE, DEFAULT_CLIENT, DEFAULT_CLIENT_NAME_PARAMETER, DEFAULT_FORCE_CLIENT_PARAMETER, DEFAULT_LOGOUT_URL_PATTERN_VALUE, DEFAULT_REALM_NAME, DEFAULT_URL, DEFAULT_URL_VALUE, DESTROY_SESSION, ELEMENT_SEPARATOR, IS_AJAX_REQUEST, LOCAL_LOGOUT, LOGOUT_ENDPOINT_PARAMETER, LOGOUT_URL_PATTERN, MATCHERS, OIDC_CLAIM_SESSIONID, PASSWORD, PREVIOUS_CSRF_TOKEN, RENEW_SESSION, REQUESTED_URL, SESSION_ID, TYPED_ID_SEPARATOR, URL, USER_PROFILES, USERNAME

Constructor Summary

Constructors

Constructor	Description
DefaultAjaxRequestResolver()

Method Summary

Modifier and Type	Method	Description
HttpAction	buildAjaxResponse(WebContext context, SessionStore sessionStore, RedirectionActionBuilder redirectionActionBuilder)	Build an AJAX reponse.
boolean	isAddRedirectionUrlAsHeader()
boolean	isAjax(WebContext context, SessionStore sessionStore)	Whether it is an AJAX request.
void	setAddRedirectionUrlAsHeader(boolean addRedirectionUrlAsHeader)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

DefaultAjaxRequestResolver

public DefaultAjaxRequestResolver()

Method Detail

isAjax

public boolean isAjax(WebContext context,
                      SessionStore sessionStore)

Description copied from interface: AjaxRequestResolver

Whether it is an AJAX request.

Specified by:

isAjax in interface AjaxRequestResolver

Parameters:

context - the web context

sessionStore - the session store

Returns:

whether it is an AJAX request

buildAjaxResponse

public HttpAction buildAjaxResponse(WebContext context,
                                    SessionStore sessionStore,
                                    RedirectionActionBuilder redirectionActionBuilder)

Description copied from interface: AjaxRequestResolver

Build an AJAX reponse.

Specified by:

buildAjaxResponse in interface AjaxRequestResolver

Parameters:

context - the web context

sessionStore - the session store

redirectionActionBuilder - the builder of the redirection, is case the redirect URL calculation needs to be performed

Returns:

the AJAX response

isAddRedirectionUrlAsHeader

public boolean isAddRedirectionUrlAsHeader()

setAddRedirectionUrlAsHeader

public void setAddRedirectionUrlAsHeader(boolean addRedirectionUrlAsHeader)