org.pac4j.core.context

Class ContextHelper

java.lang.Object

org.pac4j.core.context.ContextHelper

All Implemented Interfaces:

HttpConstants

public final class ContextHelper
extends Object
implements HttpConstants

A helper for the web context.

Since:

1.8.1

Author:

Jerome Leleu

Nested Class Summary

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

HttpConstants.HTTP_METHOD

Field Summary

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

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, 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, FORBIDDEN, HTML_CONTENT_TYPE, LOCATION_HEADER, OK, SCHEME_HTTP, SCHEME_HTTPS, TEMP_REDIRECT, UNAUTHORIZED, UTF8_ENCODING

Constructor Summary

Constructors

Constructor and Description
ContextHelper()

Method Summary

Modifier and Type	Method and Description
static Cookie	getCookie(Collection<Cookie> cookies, String name) Get a specific cookie by its name.
static Cookie	getCookie(WebContext context, String name) Get a specific cookie by its name.
static boolean	isGet(WebContext context) Whether it is a GET request.
static boolean	isHttp(WebContext context) Whether the request is HTTP.
static boolean	isHttps(WebContext context) Whether the request is HTTPS.
static boolean	isHttpsOrSecure(WebContext context) Whether the request is HTTPS or secure.
static boolean	isPost(WebContext context) Whether it is a POST request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextHelper

public ContextHelper()

Method Detail

getCookie

public static Cookie getCookie(Collection<Cookie> cookies,
                               String name)

Get a specific cookie by its name.

Parameters:

cookies - provided cookies

name - the name of the cookie

Returns:

the cookie

getCookie

public static Cookie getCookie(WebContext context,
                               String name)

Get a specific cookie by its name.

Parameters:

context - the current web context

name - the name of the cookie

Returns:

the cookie

isGet

public static boolean isGet(WebContext context)

Whether it is a GET request.

Parameters:

context - the web context

Returns:

whether it is a GET request

isPost

public static boolean isPost(WebContext context)

Whether it is a POST request.

Parameters:

context - the web context

Returns:

whether it is a POST request

isHttpsOrSecure

public static boolean isHttpsOrSecure(WebContext context)

Whether the request is HTTPS or secure.

Parameters:

context - the current web context

Returns:

whether the request is HTTPS or secure

isHttp

public static boolean isHttp(WebContext context)

Whether the request is HTTP.

Parameters:

context - the current web context

Returns:

whether the request is HTTP

isHttps

public static boolean isHttps(WebContext context)

Whether the request is HTTPS.

Parameters:

context - the current web context

Returns:

whether the request is HTTPS