org.spincast.plugins.routing

Class SpincastRoute<R extends IRequestContext<?>>

java.lang.Object

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

All Implemented Interfaces:

IRoute<R>

public class SpincastRoute<R extends IRequestContext<?>>
extends Object
implements IRoute<R>

Constructor Summary

Constructors

Constructor and Description
SpincastRoute(String id, Set<HttpMethod> httpMethods, String path, Set<RoutingType> routingTypes, List<IHandler<R>> beforeFilters, IHandler<R> mainHandler, List<IHandler<R>> afterFilters, Set<Integer> positions, Set<String> acceptedContentTypes, Set<String> filterIdsToSkip) Constructor

Method Summary

Modifier and Type	Method and Description
Set<String>	getAcceptedContentTypes() The Content-Types this route accepts (names all lowercased).
List<IHandler<R>>	getAfterFilters() The "after" filters, if any.
List<IHandler<R>>	getBeforeFilters() The "before" filters, if any.
Set<String>	getFilterIdsToSkip() The ids of the filters that should be skipped for this route.
Set<HttpMethod>	getHttpMethods() The HTTP methods this route applies to.
String	getId() The route id.
IHandler<R>	getMainHandler() The main handler.
String	getPath() The route path.
List<Integer>	getPositions() The positions at which this route should be run during a routing process.
Set<RoutingType>	getRoutingTypes() The routing types the route should be considered for.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpincastRoute

public SpincastRoute(@Nullable
                     String id,
                     Set<HttpMethod> httpMethods,
                     String path,
                     Set<RoutingType> routingTypes,
                     @Nullable
                     List<IHandler<R>> beforeFilters,
                     IHandler<R> mainHandler,
                     @Nullable
                     List<IHandler<R>> afterFilters,
                     Set<Integer> positions,
                     @Nullable
                     Set<String> acceptedContentTypes,
                     @Nullable
                     Set<String> filterIdsToSkip)

Constructor

Method Detail

getHttpMethods

public Set<HttpMethod> getHttpMethods()

Description copied from interface: IRoute

The HTTP methods this route applies to.

Specified by:

getHttpMethods in interface IRoute<R extends IRequestContext<?>>

getAcceptedContentTypes

public Set<String> getAcceptedContentTypes()

Description copied from interface: IRoute

The Content-Types this route accepts (names all lowercased).

Specified by:

getAcceptedContentTypes in interface IRoute<R extends IRequestContext<?>>

getId

public String getId()

Description copied from interface: IRoute

The route id.

Specified by:

getId in interface IRoute<R extends IRequestContext<?>>

getPath

public String getPath()

Description copied from interface: IRoute

The route path.

Specified by:

getPath in interface IRoute<R extends IRequestContext<?>>

getRoutingTypes

public Set<RoutingType> getRoutingTypes()

Description copied from interface: IRoute

The routing types the route should be considered for.

Specified by:

getRoutingTypes in interface IRoute<R extends IRequestContext<?>>

getBeforeFilters

public List<IHandler<R>> getBeforeFilters()

Description copied from interface: IRoute

The "before" filters, if any.

Specified by:

getBeforeFilters in interface IRoute<R extends IRequestContext<?>>

getMainHandler

public IHandler<R> getMainHandler()

Description copied from interface: IRoute

The main handler.

Specified by:

getMainHandler in interface IRoute<R extends IRequestContext<?>>

getAfterFilters

public List<IHandler<R>> getAfterFilters()

Description copied from interface: IRoute

The "after" filters, if any.

Specified by:

getAfterFilters in interface IRoute<R extends IRequestContext<?>>

getPositions

public List<Integer> getPositions()

Description copied from interface: IRoute

The positions at which this route should be run during a routing process. It is possible (but uncommon) to have a filter that is run at more than one position. For example, a filter may have to do some work before and after the main handler.

Specified by:

getPositions in interface IRoute<R extends IRequestContext<?>>

getFilterIdsToSkip

public Set<String> getFilterIdsToSkip()

Description copied from interface: IRoute

The ids of the filters that should be skipped for this route.

Specified by:

getFilterIdsToSkip in interface IRoute<R extends IRequestContext<?>>

toString

public String toString()

Overrides:

toString in class Object