org.pac4j.core.exception

Class RequiresHttpAction

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.pac4j.core.exception.RequiresHttpAction

All Implemented Interfaces:

Serializable

public class RequiresHttpAction
extends Exception

This exception is thrown when an additionnal HTTP action (redirect, basic auth...) is required.

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	RequiresHttpAction(String message, int code)

Method Summary

Modifier and Type	Method and Description
static RequiresHttpAction	forbidden(String message, WebContext context) Build a forbidden response.
int	getCode() Return the HTTP code.
static RequiresHttpAction	ok(String message, WebContext context) Build an HTTP Ok.
static RequiresHttpAction	ok(String message, WebContext context, String content) Build an HTTP Ok.
static RequiresHttpAction	redirect(String message, WebContext context, String url) Build a redirection.
String	toString()
static RequiresHttpAction	unauthorized(String message, WebContext context, String realmName) 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

RequiresHttpAction

protected RequiresHttpAction(String message,
                             int code)

Method Detail

redirect

public static RequiresHttpAction redirect(String message,
                                          WebContext context,
                                          String url)

Build a redirection.

Parameters:

message - message

context - context

url - url

Returns:

an HTTP redirection

ok

public static RequiresHttpAction ok(String message,
                                    WebContext context)

Build an HTTP Ok.

Parameters:

message - message

context - context

Returns:

an HTTP ok

ok

public static RequiresHttpAction ok(String message,
                                    WebContext context,
                                    String content)

Build an HTTP Ok.

Parameters:

message - message

context - context

content - content

Returns:

an HTTP ok

unauthorized

public static RequiresHttpAction unauthorized(String message,
                                              WebContext context,
                                              String realmName)

Build a basic auth popup credentials.

Parameters:

message - message

context - context

realmName - realm name

Returns:

a basic auth popup credentials

forbidden

public static RequiresHttpAction forbidden(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 String toString()

Overrides:

toString in class Throwable