org.spincast.core.routing

Interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

All Known Subinterfaces:

DefaultRouter

All Known Implementing Classes:

DefaultRouterDefault, SpincastRouter

public interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

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(Route<R> route) Adds a route, directly.
void	addRouteParamPatternAlias(String alias, String pattern) Adds an alias for a path pattern.
void	addStaticResource(StaticResource<R> staticResource) Adds a static resource route, directly.
void	addWebsocketRoute(WebsocketRoute<R,W> websocketRoute) Adds a Websocket route, directly.
RouteBuilder<R>	after() Creates an "after" filter.
RouteBuilder<R>	after(String path) Creates an "after" filter.
RouteBuilder<R>	ALL(String path) Starts the creation of a route matching any HTTP method.
RouteBuilder<R>	before() Creates a "before" filter.
RouteBuilder<R>	before(String path) Creates a "before" filter.
RouteBuilder<R>	beforeAndAfter() Creates a "before" and an "after" filters.
RouteBuilder<R>	beforeAndAfter(String path) 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!)
RouteBuilder<R>	DELETE(String path) Starts the creation of a DELETE route.
StaticResourceBuilder<R>	dir(String url) Start the creation of a static resource directory.
void	exception(Handler<R> handler) Creates a route considered during an "Exception" routing process.
void	exception(String path, Handler<R> handler) Creates a route considered during an "Exception" routing process.
StaticResourceBuilder<R>	file(String url) Start the creation of a static resource file.
RouteBuilder<R>	GET(String path) Starts the creation of a GET route.
List<Route<R>>	getGlobalAfterFiltersRoutes() Gets the global "after" filters.
List<Route<R>>	getGlobalBeforeFiltersRoutes() Gets the global "before" filters.
List<Route<R>>	getMainRoutes() Gets the main routes.
Route<R>	getRoute(String routeId) Gets a route using its routeId.
Map<String,String>	getRouteParamPatternAliases() The path patterns' aliases.
RouteBuilder<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(Handler<R> handler) Creates a route considered during an "Not Found" routing process.
void	notFound(String path, Handler<R> handler) Creates a route considered during an "Not Found" routing process.
RouteBuilder<R>	OPTIONS(String path) Starts the creation of a OPTIONS route.
RouteBuilder<R>	PATCH(String path) Starts the creation of a PATCH route.
RouteBuilder<R>	POST(String path) Starts the creation of a POST route.
RouteBuilder<R>	PUT(String path) Starts the creation of a PUT route.
RedirectRuleBuilder	redirect(String oldPath) Starts the creation of a redirection rule.
void	removeAllRoutes() Removes all routes, except the one Spincast addds automatically (their ids start with "spincast_").
void	removeAllRoutes(boolean removeSpincastRoutesToo) Removes all routes.
void	removeRoute(String routeId) Removes a route using its routeId.
RoutingResult<R>	route(R requestContext) Find the route to use to handle the current request.
RoutingResult<R>	route(R requestContext, RoutingType routingType) Find the route to use to handle the current request, given the specified routing type.
RouteBuilder<R>	SOME(String path, HttpMethod... httpMethods) Starts the creation of a route matching the specified HTTP methods.
RouteBuilder<R>	SOME(String path, Set<HttpMethod> httpMethods) Starts the creation of a route matching the specified HTTP methods.
RouteBuilder<R>	TRACE(String path) Starts the creation of a TRACE route.
WebsocketRouteBuilder<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

RouteBuilder<R> GET(String path)

Starts the creation of a GET route.

POST

RouteBuilder<R> POST(String path)

Starts the creation of a POST route.

PUT

RouteBuilder<R> PUT(String path)

Starts the creation of a PUT route.

DELETE

RouteBuilder<R> DELETE(String path)

Starts the creation of a DELETE route.

OPTIONS

RouteBuilder<R> OPTIONS(String path)

Starts the creation of a OPTIONS route.

TRACE

RouteBuilder<R> TRACE(String path)

Starts the creation of a TRACE route.

HEAD

RouteBuilder<R> HEAD(String path)

Starts the creation of a HEAD route.

PATCH

RouteBuilder<R> PATCH(String path)

Starts the creation of a PATCH route.

ALL

RouteBuilder<R> ALL(String path)

Starts the creation of a route matching any HTTP method.

SOME

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

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

SOME

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

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

before

RouteBuilder<R> before()

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

before

RouteBuilder<R> before(String path)

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

after

RouteBuilder<R> after()

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

after

RouteBuilder<R> after(String path)

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

beforeAndAfter

RouteBuilder<R> beforeAndAfter()

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

beforeAndAfter

RouteBuilder<R> beforeAndAfter(String path)

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

exception

void exception(Handler<R> handler)

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

exception

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

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

notFound

void notFound(Handler<R> handler)

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

notFound

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

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

file

StaticResourceBuilder<R> file(String url)

Start the creation of a static resource file.

Only a GET or a HEAD request will be able to access this resource.

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

StaticResourceBuilder<R> dir(String url)

Start the creation of a static resource directory.

Only a GET or a HEAD request will be able to access the resources below this 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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

SpincastFilters#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:

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

addStaticResource

void addStaticResource(StaticResource<R> staticResource)

Adds a static resource route, directly.

route

RoutingResult<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

RoutingResult<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(Route<R> route)

Adds a route, directly.

removeAllRoutes

void removeAllRoutes()

Removes all routes, except the one Spincast addds automatically (their ids start with "spincast_").

removeAllRoutes

void removeAllRoutes(boolean removeSpincastRoutesToo)

Removes all routes.

Parameters:

removeSpincastRoutesToo - Should the routes added by Spincast be removed too?

removeRoute

void removeRoute(String routeId)

Removes a route using its routeId.

getRoute

Route<R> getRoute(String routeId)

Gets a route using its routeId.

getGlobalBeforeFiltersRoutes

List<Route<R>> getGlobalBeforeFiltersRoutes()

Gets the global "before" filters.

getMainRoutes

List<Route<R>> getMainRoutes()

Gets the main routes.

getGlobalAfterFiltersRoutes

List<Route<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

WebsocketRouteBuilder<R,W> websocket(String path)

Starts the creation of a Websocket route.

addWebsocketRoute

void addWebsocketRoute(WebsocketRoute<R,W> websocketRoute)

Adds a Websocket route, directly.

redirect

RedirectRuleBuilder redirect(String oldPath)

Starts the creation of a redirection rule.

Parameters:

oldPath - The old path that needs to be redirected.