org.spincast.core.config

Class SpincastConstants.RequestScopedVariables

java.lang.Object

org.spincast.core.config.SpincastConstants.RequestScopedVariables

Enclosing class:

SpincastConstants

public static final class SpincastConstants.RequestScopedVariables
extends Object

Request scoped variables that Spincast may set.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCEPTION If an "Exception" route is run, this variable will contain the exception that occured.
static String	FORWARD_ROUTE_EXCEPTION_MESSAGE If a request is forwaded, this is going to be the forwarding message (taken from the ForwardRouteException exception) The associated value is of type: String.
static String	FORWARD_ROUTE_URL When a route is forwarded, this is the new URL.
static String	IS_EXCEPTION_HANDLING If an "Exception" route is run, this variable will be set to true.
static String	IS_NOT_FOUND_ROUTE If a "Not Found" route is run, this variable will be set and its value will be true.
static String	NOT_FOUND_PUBLIC_MESSAGE If a "Not Found" route is run because of a NotFoundException has being thrown, the exception message, if any, is public and will be added using this variable.
static String	ORIGINAL_ROUTING_RESULT This is going to be set to the original routing result, if an "Exception" route or a "Not Found" routing process is started.
static String	ROUTE_FORWARDED_NBR The number of time a request has been forwarded.
static String	ROUTE_HANDLER_MATCH The current route handler match.
static String	ROUTING_RESULT The current routing result.

Constructor Summary

Constructors

Constructor and Description
RequestScopedVariables()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ROUTING_RESULT

public static final String ROUTING_RESULT

The current routing result. The associated value is of type: IRoutingResult<R>.

ROUTE_HANDLER_MATCH

public static final String ROUTE_HANDLER_MATCH

The current route handler match. The associated value is of type: IRouteHandlerMatch<R>.

IS_NOT_FOUND_ROUTE

public static final String IS_NOT_FOUND_ROUTE

If a "Not Found" route is run, this variable will be set and its value will be true. The associated value is of type: boolean.

NOT_FOUND_PUBLIC_MESSAGE

public static final String NOT_FOUND_PUBLIC_MESSAGE

If a "Not Found" route is run because of a NotFoundException has being thrown, the exception message, if any, is public and will be added using this variable. The associated value is of type: String.

IS_EXCEPTION_HANDLING

public static final String IS_EXCEPTION_HANDLING

If an "Exception" route is run, this variable will be set to true. The associated value is of type: boolean.

EXCEPTION

public static final String EXCEPTION

If an "Exception" route is run, this variable will contain the exception that occured. The associated value is of type: Throwable.

ORIGINAL_ROUTING_RESULT

public static final String ORIGINAL_ROUTING_RESULT

This is going to be set to the original routing result, if an "Exception" route or a "Not Found" routing process is started. That way, the route handlers may know what the original route was. The associated value is of type: IRoutingResult<R>.

FORWARD_ROUTE_URL

public static final String FORWARD_ROUTE_URL

When a route is forwarded, this is the new URL. The associated value is of type: String.

FORWARD_ROUTE_EXCEPTION_MESSAGE

public static final String FORWARD_ROUTE_EXCEPTION_MESSAGE

If a request is forwaded, this is going to be the forwarding message (taken from the ForwardRouteException exception) The associated value is of type: String.

ROUTE_FORWARDED_NBR

public static final String ROUTE_FORWARDED_NBR

The number of time a request has been forwarded. The associated value is of type: int.

Constructor Detail

RequestScopedVariables

public RequestScopedVariables()