org.pac4j.core.exception

Class HttpAction

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.pac4j.core.exception.HttpAction

All Implemented Interfaces:

java.io.Serializable

public class HttpAction
extends java.lang.Exception

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

Method Summary

Modifier and Type	Method and Description
static HttpAction	forbidden(java.lang.String message, WebContext context) Build a forbidden response.
int	getCode() Return the HTTP code.
static HttpAction	ok(java.lang.String message, WebContext context) Build an HTTP Ok without any content.
static HttpAction	ok(java.lang.String message, WebContext context, java.lang.String content) Build an HTTP Ok.
static HttpAction	redirect(java.lang.String message, WebContext context, java.lang.String url) Build a redirection.
static HttpAction	status(java.lang.String message, int status, WebContext context) Build a response with message and status.
java.lang.String	toString()
static HttpAction	unauthorized(java.lang.String message, WebContext context, java.lang.String realmName) Build a basic auth popup credentials.
static HttpAction	unauthorized(java.lang.String message, WebContext context, java.lang.String realmName, java.lang.String url) Build a basic auth popup credentials.
static HttpAction	unauthorizedDigest(java.lang.String message, WebContext context, java.lang.String realmName, java.lang.String qop, java.lang.String nonce) Build a digest auth popup credentials.
static HttpAction	unauthorizedNegotiate(java.lang.String message, WebContext context) Build a response requesting to provide credentials via Kerberos/SPNEGO Negotiate mechanism.

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

Method Detail

status

public static HttpAction status(java.lang.String message,
                                int status,
                                WebContext context)

Build a response with message and status.

Parameters:

message - message

status - the HTTP status

context - context

Returns:

an HTTP response

redirect

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

Build a redirection.

Parameters:

message - message

context - context

url - url

Returns:

an HTTP redirection

ok

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

Build an HTTP Ok without any content.

Parameters:

message - message

context - context

Returns:

an HTTP ok

ok

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

Build an HTTP Ok.

Parameters:

message - message

context - context

content - content

Returns:

an HTTP ok

unauthorized

public static HttpAction unauthorized(java.lang.String message,
                                      WebContext context,
                                      java.lang.String realmName)

Build a basic auth popup credentials.

Parameters:

message - message

context - context

realmName - realm name

Returns:

a basic auth popup credentials

unauthorized

public static HttpAction unauthorized(java.lang.String message,
                                      WebContext context,
                                      java.lang.String realmName,
                                      java.lang.String url)

Build a basic auth popup credentials.

Parameters:

message - message

context - context

realmName - realm name

url - url

Returns:

a basic auth popup credentials

unauthorizedDigest

public static HttpAction unauthorizedDigest(java.lang.String message,
                                            WebContext context,
                                            java.lang.String realmName,
                                            java.lang.String qop,
                                            java.lang.String nonce)

Build a digest auth popup credentials.

Parameters:

message - message

context - context

realmName - realm name

qop - qop

nonce - nonce

Returns:

a digest auth popup credentials

unauthorizedNegotiate

public static HttpAction unauthorizedNegotiate(java.lang.String message,
                                               WebContext context)

Build a response requesting to provide credentials via Kerberos/SPNEGO Negotiate mechanism.

Parameters:

message - message

context - context

Returns:

401 Unauthorized with "WWW-Authenticate: Negotiate"

forbidden

public static HttpAction forbidden(java.lang.String message,
                                   WebContext context)

Build a forbidden response.

Parameters:

message - message

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