org.spincast.core.routing

Interface IRouter<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

All Known Subinterfaces:

IDefaultRouter

All Known Implementing Classes:

DefaultRouter, SpincastRouter

public interface IRouter<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

The router.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ROUTE_PATH The default path used when Spincast creates routes by itself.

Method Summary

Modifier and Type	Method and Description
void	addRoute(IRoute<R> route) Adds a route, directly.
void	addRouteParamPatternAlias(String alias, String pattern) Adds an alias for a path pattern.
void	addStaticResource(IStaticResource<R> staticResource) Adds a static resource route, directly.
void	addWebsocketRoute(IWebsocketRoute<R,W> websocketRoute) Adds a Websocket route, directly.
void	after(IHandler<R> handler) Creates an "after" filter.
void	after(String path, IHandler<R> handler) Creates an "after" filter.
IRouteBuilder<R>	ALL(String path) Starts the creation of a route matching any HTTP method.
void	before(IHandler<R> handler) Creates a "before" filter.
void	before(String path, IHandler<R> handler) Creates a "before" filter.
void	beforeAndAfter(IHandler<R> handler) Creates a "before" and an "after" filters.
void	beforeAndAfter(String path, IHandler<R> handler) Creates a "before" and an "after" filters.
void	cors() Enables Cross-Origin Resource Sharing (Cors) on all matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds) Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)
void	cors(String path) Enables Cross-Origin Resource Sharing (Cors) on all requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds) Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)
IRouteBuilder<R>	DELETE(String path) Starts the creation of a DELETE route.
IStaticResourceBuilder<R>	dir(String url) Start the creation of a static resource directory.
void	exception(IHandler<R> handler) Creates a route considered during an "Exception" routing process.
void	exception(String path, IHandler<R> handler) Creates a route considered during an "Exception" routing process.
IStaticResourceBuilder<R>	file(String url) Start the creation of a static resource file.
IRouteBuilder<R>	GET(String path) Starts the creation of a GET route.
List<IRoute<R>>	getGlobalAfterFiltersRoutes() Gets the global "after" filters.
List<IRoute<R>>	getGlobalBeforeFiltersRoutes() Gets the global "before" filters.
List<IRoute<R>>	getMainRoutes() Gets the main routes.
IRoute<R>	getRoute(String routeId) Gets a route using its routeId.
Map<String,String>	getRouteParamPatternAliases() The path patterns' aliases.
IRouteBuilder<R>	HEAD(String path) Starts the creation of a HEAD route.
void	httpAuth(String pathPrefix, String realmName) Creates HTTP authentication protection (realm) for the specified path prefix.
void	notFound(IHandler<R> handler) Creates a route considered during an "Not Found" routing process.
void	notFound(String path, IHandler<R> handler) Creates a route considered during an "Not Found" routing process.
IRouteBuilder<R>	OPTIONS(String path) Starts the creation of a OPTIONS route.
IRouteBuilder<R>	PATCH(String path) Starts the creation of a PATCH route.
IRouteBuilder<R>	POST(String path) Starts the creation of a POST route.
IRouteBuilder<R>	PUT(String path) Starts the creation of a PUT route.
void	removeAllRoutes() Removes all routes.
void	removeRoute(String routeId) Removes a route using its routeId.
IRoutingResult<R>	route(R requestContext) Find the route to use to handle the current request.
IRoutingResult<R>	route(R requestContext, RoutingType routingType) Find the route to use to handle the current request, given the specified routing type.
IRouteBuilder<R>	SOME(String path, HttpMethod... httpMethods) Starts the creation of a route matching the specified HTTP methods.
IRouteBuilder<R>	SOME(String path, Set<HttpMethod> httpMethods) Starts the creation of a route matching the specified HTTP methods.
IRouteBuilder<R>	TRACE(String path) Starts the creation of a TRACE route.
IWebsocketRouteBuilder<R,W>	websocket(String path) Starts the creation of a Websocket route.

Field Detail

DEFAULT_ROUTE_PATH

static final String DEFAULT_ROUTE_PATH

The default path used when Spincast creates routes by itself.

See Also:

Constant Field Values

Method Detail

GET

IRouteBuilder<R> GET(String path)

Starts the creation of a GET route.

POST

IRouteBuilder<R> POST(String path)

Starts the creation of a POST route.

PUT

IRouteBuilder<R> PUT(String path)

Starts the creation of a PUT route.

DELETE

IRouteBuilder<R> DELETE(String path)

Starts the creation of a DELETE route.

OPTIONS

IRouteBuilder<R> OPTIONS(String path)

Starts the creation of a OPTIONS route.

TRACE

IRouteBuilder<R> TRACE(String path)

Starts the creation of a TRACE route.

HEAD

IRouteBuilder<R> HEAD(String path)

Starts the creation of a HEAD route.

PATCH

IRouteBuilder<R> PATCH(String path)

Starts the creation of a PATCH route.

ALL

IRouteBuilder<R> ALL(String path)

Starts the creation of a route matching any HTTP method.

SOME

IRouteBuilder<R> SOME(String path,
                      Set<HttpMethod> httpMethods)

Starts the creation of a route matching the specified HTTP methods.

SOME

IRouteBuilder<R> SOME(String path,
                      HttpMethod... httpMethods)

Starts the creation of a route matching the specified HTTP methods.

before

void before(IHandler<R> handler)

Creates a "before" filter. Synonym of : ALL("/*{path}").pos(-1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

before

void before(String path,
            IHandler<R> handler)

Creates a "before" filter. Synonym of : ALL(path).pos(-1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

after

void after(IHandler<R> handler)

Creates an "after" filter. Synonym of : ALL("/*{path}").pos(1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

after

void after(String path,
           IHandler<R> handler)

Creates an "after" filter. Synonym of : ALL(path).pos(1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

beforeAndAfter

void beforeAndAfter(IHandler<R> handler)

Creates a "before" and an "after" filters. Synonym of : ALL("/*{path}").pos(-1).save(handler) and ALL("/*{path}").pos(1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

beforeAndAfter

void beforeAndAfter(String path,
                    IHandler<R> handler)

Creates a "before" and an "after" filters. Synonym of : ALL(path).pos(-1).save(handler) and ALL(path).pos(1).save(handler) and with the Routing types as returned by ISpincastRouterConfig#getFilterDefaultRoutingTypes()

exception

void exception(IHandler<R> handler)

Creates a route considered during an "Exception" routing process. Synonym of : ALL("/*{path}").exception().save(handler)

exception

void exception(String path,
               IHandler<R> handler)

Creates a route considered during an "Exception" routing process. Synonym of : ALL(path).exception().save(handler)

notFound

void notFound(IHandler<R> handler)

Creates a route considered during an "Not Found" routing process. Synonym of : ALL("/*{path}").notFound().save(handler)

notFound

void notFound(String path,
              IHandler<R> handler)

Creates a route considered during an "Not Found" routing process. Synonym of : ALL(path).notFound().save(handler)

file

IStaticResourceBuilder<R> file(String url)

Start the creation of a static resource file. No "before" and "after" filters will be applied to those, since the request won't even reach the framework.

Parameters:

url - The url which will trigger the output of this static resource.

dir

IStaticResourceBuilder<R> dir(String url)

Start the creation of a static resource directory. No "before" and "after" filters will be applied to those, since the request won't even reach the framework.

Parameters:

url - The url which will trigger the output of this static resource.

cors

void cors()

Enables Cross-Origin Resource Sharing (Cors) on all matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context)

cors

void cors(Set<String> allowedOrigins)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins)

cors

void cors(Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeReadt)

cors

void cors(Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)

cors

void cors(Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)

cors

void cors(Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies,
          Set<HttpMethod> allowedMethods)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods)

cors

void cors(Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies,
          Set<HttpMethod> allowedMethods,
          int maxAgeInSeconds)

Enables Cross-Origin Resource Sharing (Cors) on matching requests (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds)

cors

void cors(String path)

Enables Cross-Origin Resource Sharing (Cors) on all requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context)

cors

void cors(String path,
          Set<String> allowedOrigins)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins)

cors

void cors(String path,
          Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)

cors

void cors(String path,
          Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)

cors

void cors(String path,
          Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)

cors

void cors(String path,
          Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies,
          Set<HttpMethod> allowedMethods)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods)

cors

void cors(String path,
          Set<String> allowedOrigins,
          Set<String> extraHeadersAllowedToBeRead,
          Set<String> extraHeadersAllowedToBeSent,
          boolean allowCookies,
          Set<HttpMethod> allowedMethods,
          int maxAgeInSeconds)

Enables Cross-Origin Resource Sharing (Cors) on requests matching the specified path (except the static resources, for whom cors has to be activated directly!)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds)

addStaticResource

void addStaticResource(IStaticResource<R> staticResource)

Adds a static resource route, directly.

route

IRoutingResult<R> route(R requestContext)

Find the route to use to handle the current request. The result contains all handlers to use.

Returns:

the routing result or null if no route matches.

route

IRoutingResult<R> route(R requestContext,
                        RoutingType routingType)

Find the route to use to handle the current request, given the specified routing type. The result contains all handlers to use.

Returns:

the routing result or null if no route matches.

addRoute

void addRoute(IRoute<R> route)

Adds a route, directly.

removeAllRoutes

void removeAllRoutes()

Removes all routes.

removeRoute

void removeRoute(String routeId)

Removes a route using its routeId.

getRoute

IRoute<R> getRoute(String routeId)

Gets a route using its routeId.

getGlobalBeforeFiltersRoutes

List<IRoute<R>> getGlobalBeforeFiltersRoutes()

Gets the global "before" filters.

getMainRoutes

List<IRoute<R>> getMainRoutes()

Gets the main routes.

getGlobalAfterFiltersRoutes

List<IRoute<R>> getGlobalAfterFiltersRoutes()

Gets the global "after" filters.

addRouteParamPatternAlias

void addRouteParamPatternAlias(String alias,
                               String pattern)

Adds an alias for a path pattern. For example, the path of a route may be "/${param1:<XXX>}" : here "XXX" is the alias for the regular expression pattern to use.

getRouteParamPatternAliases

Map<String,String> getRouteParamPatternAliases()

The path patterns' aliases. Themap is mutable.

httpAuth

void httpAuth(String pathPrefix,
              String realmName)

Creates HTTP authentication protection (realm) for the specified path prefix.

websocket

IWebsocketRouteBuilder<R,W> websocket(String path)

Starts the creation of a Websocket route.

addWebsocketRoute

void addWebsocketRoute(IWebsocketRoute<R,W> websocketRoute)

Adds a Websocket route, directly.