org.spincast.plugins.routing

Class SpincastRouter<R extends RequestContext<?>,W extends WebsocketContext<?>>

java.lang.Object

org.spincast.plugins.routing.SpincastRouter<R,W>

All Implemented Interfaces:

Router<R,W>

Direct Known Subclasses:

DefaultRouterDefault

public class SpincastRouter<R extends RequestContext<?>,W extends WebsocketContext<?>>
extends Object
implements Router<R,W>

Spincast router

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Fields inherited from interface org.spincast.core.routing.Router

DEFAULT_ROUTE_PATH

Constructor Summary

Constructors

Constructor and Description
SpincastRouter(SpincastRouterDeps<R,W> spincastRouterDeps)

Method Summary

Modifier and Type	Method and Description
protected void	addDefaultFilters()
void	addRoute(Route<R> route)
void	addRouteParamPatternAlias(String alias, String pattern)
void	addStaticResource(StaticResource<R> staticResource)
void	addWebsocketRoute(WebsocketRoute<R,W> websocketRoute)
RouteBuilder<R>	ALL()
RouteBuilder<R>	ALL(String path)
void	cors()
void	cors(Set<String> allowedOrigins)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods)
void	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds)
void	cors(String path)
void	cors(String path, Set<String> allowedOrigins)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods)
void	cors(String path, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, Set<HttpMethod> allowedMethods, int maxAgeInSeconds)
protected RouteHandlerMatch<R>	createHandlerMatchForBeforeOrAfterFilter(RouteHandlerMatch<R> mainRouteHandlerMatch, Handler<R> beforeOrAfterMethod, int position) Creates a new match for a "before" or "after" handler specific to a route.
protected Route<R>	createHttpRouteFromWebsocketRoute(WebsocketRoute<R,W> websocketRoute)
protected RouteHandlerMatch<R>	createNoMatchingParamsHandlerMatch(Route<R> route, String id, Handler<R> handler, int position) Creates an handler match with no matching params.
protected List<RouteHandlerMatch<R>>	createRegularHandlerMatches(RoutingType routingType, Route<R> route, HttpMethod httpMethod, List<String> acceptedContentTypes, URL url, int position) Get the matches (filters and main handle) if the route matches the URL and HTTP method, or returns NULL otherwise.
protected RoutingResult<R>	createRoutingResult(List<RouteHandlerMatch<R>> routeHandlerMatches)
RouteBuilder<R>	DELETE()
RouteBuilder<R>	DELETE(String path)
StaticResourceBuilder<R>	dir(String url)
void	exception(Handler<R> handler)
void	exception(String path, Handler<R> handler)
StaticResourceBuilder<R>	file(String url)
RouteBuilder<R>	GET()
RouteBuilder<R>	GET(String path)
protected Dictionary	getDictionary()
protected Map<Integer,List<Route<R>>>	getGlobalAfterFiltersPerPosition()
List<Route<R>>	getGlobalAfterFiltersRoutes()
protected Map<Integer,List<Route<R>>>	getGlobalBeforeFiltersPerPosition()
List<Route<R>>	getGlobalBeforeFiltersRoutes()
List<Route<R>>	getMainRoutes()
protected Pattern	getPattern(String patternStr)
protected String	getPatternFromAlias(String alias) Get a path pattern from its alias.
protected RedirectRuleBuilderFactory<R,W>	getRedirectRuleBuilderFactory()
Route<R>	getRoute(String routeId)
protected RouteBuilderFactory<R,W>	getRouteBuilderFactory()
protected RouteFactory<R>	getRouteFactory()
protected RouteHandlerMatchFactory<R>	getRouteHandlerMatchFactory()
protected Set<String>	getRouteIdsPrefixToKeepByDefaultWhenRemovingAll() The route with ids starting with those prefixes won't be removed by default when removeAllRoutes() is called without the "delete all" parameter.
Map<String,String>	getRouteParamPatternAliases()
protected Server	getServer()
protected SpincastConfig	getSpincastConfig()
protected SpincastFilters<R>	getSpincastFilters()
protected SpincastRouterConfig	getSpincastRouterConfig()
protected SpincastRoutingUtils	getSpincastRoutingUtils()
protected StaticResourceBuilderFactory<R,W>	getStaticResourceBuilderFactory()
protected StaticResourceFactory<R>	getStaticResourceFactory()
protected WebsocketRouteBuilderFactory<R,W>	getWebsocketRouteBuilderFactory()
protected WebsocketRouteHandlerFactory<R,W>	getWebsocketRouteHandlerFactory()
RouteBuilder<R>	HEAD()
RouteBuilder<R>	HEAD(String path)
void	httpAuth(String pathPrefix, String realmName)
protected void	init()
protected boolean	isCreateStaticResourceOnDisk()
protected boolean	isRouteMatchAcceptedContentType(Route<R> route, List<String> requestContentTypes)
protected boolean	isRouteMatchHttpMethod(Route<R> route, HttpMethod httpMethod) Validate if a route matches the given HTTP method.
protected boolean	isRoutingTypeMatch(RoutingType routingType, Route<R> route)
void	notFound(Handler<R> handler)
void	notFound(String path, Handler<R> handler)
RouteBuilder<R>	OPTIONS()
RouteBuilder<R>	OPTIONS(String path)
RouteBuilder<R>	PATCH()
RouteBuilder<R>	PATCH(String path)
RouteBuilder<R>	POST()
RouteBuilder<R>	POST(String path)
RouteBuilder<R>	PUT()
RouteBuilder<R>	PUT(String path)
RedirectRuleBuilder	redirect(String oldPath)
void	removeAllRoutes()
void	removeAllRoutes(boolean removeSpincastRoutesToo)
void	removeRoute(String routeId)
RoutingResult<R>	route(R requestContext)
RoutingResult<R>	route(R requestContext, RoutingType routingType)
RoutingResult<R>	route(R requestContext, String fullUrl, RoutingType routingType)
RouteBuilder<R>	SOME(HttpMethod... httpMethods)
RouteBuilder<R>	SOME(Set<HttpMethod> httpMethods)
RouteBuilder<R>	SOME(String path, HttpMethod... httpMethods)
RouteBuilder<R>	SOME(String path, Set<HttpMethod> httpMethods)
protected boolean	startsWithAnyOf(String id, Set<String> prefixes)
RouteBuilder<R>	TRACE()
RouteBuilder<R>	TRACE(String path)
protected void	validateId(String id)
protected void	validatePath(String path) Validate the path of a route.
protected Map<String,String>	validatePath(String routePath, URL url) Validate if url matches the path of the route and if so, returns the parsed parameters, if any.
protected void	validation()
WebsocketRouteBuilder<R,W>	websocket(String path)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

SpincastRouter

@Inject
public SpincastRouter(SpincastRouterDeps<R,W> spincastRouterDeps)

Method Detail

init

@Inject
protected void init()

validation

protected void validation()

addDefaultFilters

protected void addDefaultFilters()

getSpincastRouterConfig

protected SpincastRouterConfig getSpincastRouterConfig()

getRouteFactory

protected RouteFactory<R> getRouteFactory()

getSpincastConfig

protected SpincastConfig getSpincastConfig()

getDictionary

protected Dictionary getDictionary()

getServer

protected Server getServer()

getSpincastFilters

protected SpincastFilters<R> getSpincastFilters()

getRouteBuilderFactory

protected RouteBuilderFactory<R,W> getRouteBuilderFactory()

getRedirectRuleBuilderFactory

protected RedirectRuleBuilderFactory<R,W> getRedirectRuleBuilderFactory()

getWebsocketRouteBuilderFactory

protected WebsocketRouteBuilderFactory<R,W> getWebsocketRouteBuilderFactory()

getWebsocketRouteHandlerFactory

protected WebsocketRouteHandlerFactory<R,W> getWebsocketRouteHandlerFactory()

getStaticResourceBuilderFactory

protected StaticResourceBuilderFactory<R,W> getStaticResourceBuilderFactory()

getRouteHandlerMatchFactory

protected RouteHandlerMatchFactory<R> getRouteHandlerMatchFactory()

getStaticResourceFactory

protected StaticResourceFactory<R> getStaticResourceFactory()

getSpincastRoutingUtils

protected SpincastRoutingUtils getSpincastRoutingUtils()

getPattern

protected Pattern getPattern(String patternStr)

getRouteParamPatternAliases

public Map<String,String> getRouteParamPatternAliases()

Specified by:

getRouteParamPatternAliases in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

getRoute

public Route<R> getRoute(String routeId)

Specified by:

getRoute in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

getGlobalBeforeFiltersPerPosition

protected Map<Integer,List<Route<R>>> getGlobalBeforeFiltersPerPosition()

getGlobalBeforeFiltersRoutes

public List<Route<R>> getGlobalBeforeFiltersRoutes()

Specified by:

getGlobalBeforeFiltersRoutes in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

getGlobalAfterFiltersPerPosition

protected Map<Integer,List<Route<R>>> getGlobalAfterFiltersPerPosition()

getGlobalAfterFiltersRoutes

public List<Route<R>> getGlobalAfterFiltersRoutes()

Specified by:

getGlobalAfterFiltersRoutes in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

getMainRoutes

public List<Route<R>> getMainRoutes()

Specified by:

getMainRoutes in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

addRoute

public void addRoute(Route<R> route)

Specified by:

addRoute in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

validateId

protected void validateId(String id)

validatePath

protected void validatePath(String path)

Validate the path of a route. Throws an exception if not valide.

removeAllRoutes

public void removeAllRoutes()

Specified by:

removeAllRoutes in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

removeAllRoutes

public void removeAllRoutes(boolean removeSpincastRoutesToo)

Specified by:

removeAllRoutes in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

getRouteIdsPrefixToKeepByDefaultWhenRemovingAll

protected Set<String> getRouteIdsPrefixToKeepByDefaultWhenRemovingAll()

The route with ids starting with those prefixes won't be removed by default when removeAllRoutes() is called without the "delete all" parameter.

startsWithAnyOf

protected boolean startsWithAnyOf(String id,
                                  Set<String> prefixes)

removeRoute

public void removeRoute(String routeId)

Specified by:

removeRoute in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

route

public RoutingResult<R> route(R requestContext)

Specified by:

route in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

route

public RoutingResult<R> route(R requestContext,
                              RoutingType routingType)

Specified by:

route in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

route

public RoutingResult<R> route(R requestContext,
                              String fullUrl,
                              RoutingType routingType)

isRoutingTypeMatch

protected boolean isRoutingTypeMatch(RoutingType routingType,
                                     Route<R> route)

createRoutingResult

protected RoutingResult<R> createRoutingResult(List<RouteHandlerMatch<R>> routeHandlerMatches)

createRegularHandlerMatches

protected List<RouteHandlerMatch<R>> createRegularHandlerMatches(RoutingType routingType,
                                                                 Route<R> route,
                                                                 HttpMethod httpMethod,
                                                                 List<String> acceptedContentTypes,
                                                                 URL url,
                                                                 int position)

Get the matches (filters and main handle) if the route matches the URL and HTTP method, or returns NULL otherwise.

isRouteMatchAcceptedContentType

protected boolean isRouteMatchAcceptedContentType(Route<R> route,
                                                  List<String> requestContentTypes)

createNoMatchingParamsHandlerMatch

protected RouteHandlerMatch<R> createNoMatchingParamsHandlerMatch(Route<R> route,
                                                                  String id,
                                                                  Handler<R> handler,
                                                                  int position)

Creates an handler match with no matching params.

createHandlerMatchForBeforeOrAfterFilter

protected RouteHandlerMatch<R> createHandlerMatchForBeforeOrAfterFilter(RouteHandlerMatch<R> mainRouteHandlerMatch,
                                                                        Handler<R> beforeOrAfterMethod,
                                                                        int position)

Creates a new match for a "before" or "after" handler specific to a route. THis measn keeping the same informations as the main handler.

isRouteMatchHttpMethod

protected boolean isRouteMatchHttpMethod(Route<R> route,
                                         HttpMethod httpMethod)

Validate if a route matches the given HTTP method.

validatePath

protected Map<String,String> validatePath(String routePath,
                                          URL url)

Validate if url matches the path of the route and if so, returns the parsed parameters, if any. Returns NULL if there is no match.

getPatternFromAlias

protected String getPatternFromAlias(String alias)

Get a path pattern from its alias.

Returns:

the pattern or NULL if not found.

addRouteParamPatternAlias

public void addRouteParamPatternAlias(String alias,
                                      String pattern)

Specified by:

addRouteParamPatternAlias in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

GET

public RouteBuilder<R> GET()

Specified by:

GET in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

GET

public RouteBuilder<R> GET(String path)

Specified by:

GET in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

POST

public RouteBuilder<R> POST()

Specified by:

POST in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

POST

public RouteBuilder<R> POST(String path)

Specified by:

POST in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

PUT

public RouteBuilder<R> PUT()

Specified by:

PUT in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

PUT

public RouteBuilder<R> PUT(String path)

Specified by:

PUT in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

DELETE

public RouteBuilder<R> DELETE()

Specified by:

DELETE in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

DELETE

public RouteBuilder<R> DELETE(String path)

Specified by:

DELETE in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

OPTIONS

public RouteBuilder<R> OPTIONS()

Specified by:

OPTIONS in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

OPTIONS

public RouteBuilder<R> OPTIONS(String path)

Specified by:

OPTIONS in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

TRACE

public RouteBuilder<R> TRACE()

Specified by:

TRACE in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

TRACE

public RouteBuilder<R> TRACE(String path)

Specified by:

TRACE in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

HEAD

public RouteBuilder<R> HEAD()

Specified by:

HEAD in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

HEAD

public RouteBuilder<R> HEAD(String path)

Specified by:

HEAD in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

PATCH

public RouteBuilder<R> PATCH()

Specified by:

PATCH in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

PATCH

public RouteBuilder<R> PATCH(String path)

Specified by:

PATCH in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

ALL

public RouteBuilder<R> ALL()

Specified by:

ALL in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

ALL

public RouteBuilder<R> ALL(String path)

Specified by:

ALL in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

SOME

public RouteBuilder<R> SOME(HttpMethod... httpMethods)

Specified by:

SOME in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

SOME

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

Specified by:

SOME in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

SOME

public RouteBuilder<R> SOME(Set<HttpMethod> httpMethods)

Specified by:

SOME in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

SOME

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

Specified by:

SOME in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

exception

public void exception(Handler<R> handler)

Specified by:

exception in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

exception

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

Specified by:

exception in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

notFound

public void notFound(Handler<R> handler)

Specified by:

notFound in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

notFound

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

Specified by:

notFound in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

public void cors()

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

public void cors(Set<String> allowedOrigins)

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

public void cors(String path)

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

cors

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

Specified by:

cors in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

file

public StaticResourceBuilder<R> file(String url)

Specified by:

file in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

dir

public StaticResourceBuilder<R> dir(String url)

Specified by:

dir in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

addStaticResource

public void addStaticResource(StaticResource<R> staticResource)

Specified by:

addStaticResource in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

isCreateStaticResourceOnDisk

protected boolean isCreateStaticResourceOnDisk()

httpAuth

public void httpAuth(String pathPrefix,
                     String realmName)

Specified by:

httpAuth in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

websocket

public WebsocketRouteBuilder<R,W> websocket(String path)

Specified by:

websocket in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

addWebsocketRoute

public void addWebsocketRoute(WebsocketRoute<R,W> websocketRoute)

Specified by:

addWebsocketRoute in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>

createHttpRouteFromWebsocketRoute

protected Route<R> createHttpRouteFromWebsocketRoute(WebsocketRoute<R,W> websocketRoute)

redirect

public RedirectRuleBuilder redirect(String oldPath)

Specified by:

redirect in interface Router<R extends RequestContext<?>,W extends WebsocketContext<?>>