org.spincast.plugins.routing

Class SpincastRoutingRequestContextAddon<R extends RequestContext<R>>

java.lang.Object

org.spincast.plugins.routing.SpincastRoutingRequestContextAddon<R>

All Implemented Interfaces:

RoutingRequestContextAddon<R>

public class SpincastRoutingRequestContextAddon<R extends RequestContext<R>>
extends Object
implements RoutingRequestContextAddon<R>

Constructor Summary

Constructors

Constructor and Description
SpincastRoutingRequestContextAddon(R requestContext)

Method Summary

Modifier and Type	Method and Description
RouteHandlerMatch<R>	getCurrentRouteHandlerMatch() The current route handler being run (may be a filter) and its associated information.
protected RouteHandlerMatch<R>	getCurrentRouteMatch()
int	getPosition() The current route handler position.
protected R	getRequestContext()
RoutingResult<R>	getRoutingResult() The routing result for the current request, as returned by the router.
boolean	isExceptionRoute() Are we currently on an "Exception" routing type?
boolean	isForwarded() Is the current route forwarded?
boolean	isNotFoundRoute() Are we currently on a "Not Found" routing type?

Methods inherited from class java.lang.Object

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

Constructor Detail

SpincastRoutingRequestContextAddon

@Inject
public SpincastRoutingRequestContextAddon(R requestContext)

Method Detail

getRequestContext

protected R getRequestContext()

getCurrentRouteMatch

protected RouteHandlerMatch<R> getCurrentRouteMatch()

getPosition

public int getPosition()

Description copied from interface: RoutingRequestContextAddon

The current route handler position. If < 0 : is a "before" handler. If == 0 : is the main handler. If > 0 : is an "after" handler.

Specified by:

getPosition in interface RoutingRequestContextAddon<R extends RequestContext<R>>

getCurrentRouteHandlerMatch

public RouteHandlerMatch<R> getCurrentRouteHandlerMatch()

Description copied from interface: RoutingRequestContextAddon

The current route handler being run (may be a filter) and its associated information.

Specified by:

getCurrentRouteHandlerMatch in interface RoutingRequestContextAddon<R extends RequestContext<R>>

getRoutingResult

public RoutingResult<R> getRoutingResult()

Description copied from interface: RoutingRequestContextAddon

The routing result for the current request, as returned by the router.

Specified by:

getRoutingResult in interface RoutingRequestContextAddon<R extends RequestContext<R>>

isNotFoundRoute

public boolean isNotFoundRoute()

Description copied from interface: RoutingRequestContextAddon

Are we currently on a "Not Found" routing type?

Specified by:

isNotFoundRoute in interface RoutingRequestContextAddon<R extends RequestContext<R>>

isExceptionRoute

public boolean isExceptionRoute()

Description copied from interface: RoutingRequestContextAddon

Are we currently on an "Exception" routing type?

Specified by:

isExceptionRoute in interface RoutingRequestContextAddon<R extends RequestContext<R>>

isForwarded

public boolean isForwarded()

Description copied from interface: RoutingRequestContextAddon

Is the current route forwarded?

Specified by:

isForwarded in interface RoutingRequestContextAddon<R extends RequestContext<R>>