Package org.forgerock.openig.handler.router

Class RoutingContext

java.lang.Object

org.forgerock.services.context.AbstractContext

org.forgerock.openig.handler.router.RoutingContext

All Implemented Interfaces:

Context

public class RoutingContext
extends AbstractContext

Context implementation to maintain a record of the route that accepted the request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ROUTE_ID

Fields inherited from class org.forgerock.services.context.AbstractContext

data

Constructor Summary

Constructors

Constructor	Description
RoutingContext(Context parent, String routeId, String routeName)	Create a new instance of a RoutingContext.

Method Summary

Modifier and Type	Method	Description
String	getRouteId()	Get the route ID.
String	getRouteName()	Get the route name.
static String	routeId(Context context)	Return the route ID from the Context if it contains a RoutingContext or the DEFAULT_ROUTE_ID if not found.

Methods inherited from class org.forgerock.services.context.AbstractContext

as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ROUTE_ID

public static final String DEFAULT_ROUTE_ID

See Also:

• Constant Field Values

Constructor Details

RoutingContext

public RoutingContext(Context parent,
 String routeId,
 String routeName)

Create a new instance of a RoutingContext.

Parameters:

parent - the parent context

routeId - the route ID

routeName - the route name

Method Details

getRouteId

public String getRouteId()

Get the route ID.

Returns:

the route ID

getRouteName

public String getRouteName()

Get the route name.

Returns:

the route name

routeId

public static String routeId(Context context)

Return the route ID from the Context if it contains a RoutingContext or the DEFAULT_ROUTE_ID if not found.

Parameters:

context - the Context

Returns:

the route ID from the Context if it contains a RoutingContext or the DEFAULT_ROUTE_ID if not found.