org.forgerock.http.servlet

Enum ServletRoutingBase

java.lang.Object

java.lang.Enum<ServletRoutingBase>

org.forgerock.http.servlet.ServletRoutingBase

All Implemented Interfaces:

Serializable, Comparable<ServletRoutingBase>

public enum ServletRoutingBase
extends Enum<ServletRoutingBase>

Determines whether the context path and/or the servlet path will get consumed when routing to the HttpApplication.

Configured by Servlet init-param of HttpFrameworkServlet.ROUTING_BASE_INIT_PARAM_NAME.

By default, if no servlet init-param is set, SERVLET_PATH will be used, meaning that the HttpApplication will be given requests which DO NOT contain any information about the web application configuration. When CONTEXT_PATH is selected the HttpApplication will be given requests which DO contain the relative Servlet context path and therefore will be dependant on the web application configuration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTEXT_PATH Only the context path will be consumed when routing requests to the HttpApplication.
SERVLET_PATH Both the context path and the servlet path will be consumed when routing requests to the HttpApplication.

Method Summary

Modifier and Type	Method and Description
abstract String	extractMatchedUri(javax.servlet.http.HttpServletRequest request) Determines the portion of the request URI that will be matched based on the selected ServletRoutingBase.
static ServletRoutingBase	valueOf(String name) Returns the enum constant of this type with the specified name.
static ServletRoutingBase[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTEXT_PATH

public static final ServletRoutingBase CONTEXT_PATH

Only the context path will be consumed when routing requests to the HttpApplication.

SERVLET_PATH

public static final ServletRoutingBase SERVLET_PATH

Both the context path and the servlet path will be consumed when routing requests to the HttpApplication.

Method Detail

values

public static ServletRoutingBase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ServletRoutingBase c : ServletRoutingBase.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ServletRoutingBase valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

extractMatchedUri

public abstract String extractMatchedUri(javax.servlet.http.HttpServletRequest request)

Determines the portion of the request URI that will be matched based on the selected ServletRoutingBase.

Parameters:

request - The request.

Returns:

The matched portion of the request URI.