org.pac4j.core.exception

Class HttpAction

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.pac4j.core.exception.TechnicalException

org.pac4j.core.exception.HttpAction

All Implemented Interfaces:

java.io.Serializable

public class HttpAction
extends TechnicalException

The extra HTTP action, already performed on the web context.

Since:

1.4.0

Author:

Jerome Leleu

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	code

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpAction(int code)

Method Summary

Modifier and Type	Method and Description
static HttpAction	forbidden(WebContext context) Build a forbidden response.
int	getCode() Return the HTTP code.
static HttpAction	noContent(WebContext context) Build an HTTP No content.
static HttpAction	ok(WebContext context, java.lang.String content) Build an HTTP Ok.
static HttpAction	redirect(WebContext context, java.lang.String url) Build a redirection.
static HttpAction	status(int status, WebContext context) Build a response with status.
java.lang.String	toString()
static HttpAction	unauthorized(WebContext context) Build a basic auth popup credentials.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

code

protected int code

Constructor Detail

HttpAction

protected HttpAction(int code)

Method Detail

status

public static HttpAction status(int status,
                                WebContext context)

Build a response with status.

Parameters:

status - the HTTP status

context - context

Returns:

an HTTP response

redirect

public static HttpAction redirect(WebContext context,
                                  java.lang.String url)

Build a redirection.

Parameters:

context - context

url - url

Returns:

an HTTP redirection

ok

public static HttpAction ok(WebContext context,
                            java.lang.String content)

Build an HTTP Ok.

Parameters:

context - context

content - content

Returns:

an HTTP ok

noContent

public static HttpAction noContent(WebContext context)

Build an HTTP No content.

Parameters:

context - context

Returns:

an HTTP No content

unauthorized

public static HttpAction unauthorized(WebContext context)

Build a basic auth popup credentials.

Parameters:

context - context

Returns:

a basic auth popup credentials

forbidden

public static HttpAction forbidden(WebContext context)

Build a forbidden response.

Parameters:

context - context

Returns:

a forbidden response

getCode

public int getCode()

Return the HTTP code.

Returns:

the HTTP code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable