Uses of Interface
org.spincast.core.routing.RouteBuilder
-
Uses of RouteBuilder in org.spincast.core.routing
Modifier and TypeMethodDescriptionRouteBuilder.accept
(Set<ContentTypeDefaults> acceptedContentTypes) Sets the acceptedContent-Types
.RouteBuilder.accept
(ContentTypeDefaults... acceptedContentTypes) Sets the acceptedContent-Types
.RouteBuilder.acceptAsString
(String... acceptedContentTypes) Sets the acceptedContent-Types
.RouteBuilder.acceptAsString
(Set<String> acceptedContentTypes) Sets the acceptedContent-Types
.Adds an "after" filter which will only be applied to this particular route.RouteBuilder.ALL()
Adds all HTTP methods as being supported.Router.ALL()
Starts the creation of a route matching any HTTP method, and on any path.Starts the creation of a route matching any HTTP method.RouteBuilder.allRoutingTypes()
This route will be considered for all routing types.Adds a "before" filter which will only be applied to this particular route.RouteBuilder.cache()
Adds cache headers.RouteBuilder.cache
(int seconds) Adds public cache headers.RouteBuilder.cache
(int seconds, boolean isPrivate) Adds cache headers.Adds cache headers.A route may have multiple "classes" to identify and group them.RouteBuilderFactory.create()
Creates a route builder without using a router.Creates a route builder using the specified router.RouteBuilder.DELETE()
AddsDELETE
as a supported HTTP method.Router.DELETE()
Starts the creation of aDELETE
route, for all path.Starts the creation of aDELETE
route.RouteBuilder.exception()
This route will be considered during anException
routing process.RouteBuilder.found()
This route will be considered during aFound
routing process.RouteBuilder.GET()
AddssGET
as a supported HTTP method.Router.GET()
Starts the creation of aGET
route, for all path.Starts the creation of aGET
route.RouteBuilder.HEAD()
AddsHEAD
as a supported HTTP method.Router.HEAD()
Starts the creation of aHEAD
route, for all path.Starts the creation of aHEAD
route.RouteBuilder.html()
Addsapplication/html
as an acceptedContent-Type
.An id that can be used to identify the route.RouteBuilder.json()
Addsapplication/json
as an acceptedContent-Type
.RouteBuilder.methods
(Set<HttpMethod> httpMethods) Adds the specified HTTP methods as being supported.RouteBuilder.methods
(HttpMethod... httpMethods) Adds the specified HTTP methods as being supported.Router.methods
(String path, Set<HttpMethod> httpMethods) Starts the creation of a route matching the specified HTTP methods.Router.methods
(String path, HttpMethod... httpMethods) Starts the creation of a route matching the specified HTTP methods.Router.methods
(Set<HttpMethod> httpMethods) Starts the creation of a route matching the specified HTTP methods and on any path.Router.methods
(HttpMethod... httpMethods) Starts the creation of a route matching the specified HTTP methods and on any path.RouteBuilder.noCache()
Automatically adds "no-cache" headers to the response.RouteBuilder.notFound()
This route will be considered during aNot Found
routing process.RouteBuilder.OPTIONS()
AddsOPTIONS
as a supported HTTP method.Router.OPTIONS()
Starts the creation of aOPTIONS
route, for all path.Starts the creation of aOPTIONS
route.RouteBuilder.PATCH()
AddsPATCH
as a supported HTTP method.Router.PATCH()
Starts the creation of aPATCH
route, for all path.Starts the creation of aPATCH
route.The path of the route.RouteBuilder.pos
(int position) The position of the handler.RouteBuilder.POST()
AddsPOST
as a supported HTTP method.Router.POST()
Starts the creation of aPOST
route, for all path.Starts the creation of aPOST
route.RouteBuilder.PUT()
AddsPUT
as a supported HTTP method.Router.PUT()
Starts the creation of aPUT
route, for all path.Starts the creation of aPUT
route.Skip a "before" and "after" filter for this route.RouteBuilder.skipResourcesRequests()
Won't be applied if the request is for a resource (Route.isStaticResourceRoute()
).Generic method to provide specifications for an endpoint.RouteBuilder.specsIgnore()
When calling this method, the associated route won't be part of the generated specs.RouteBuilder.spicastCoreRouteOrPluginRoute()
This should only by called by *plugins*.RouteBuilder.TRACE()
AddsTRACE
as a supported HTTP method.Router.TRACE()
Starts the creation of aTRACE
route, for all path.Starts the creation of aTRACE
route, at the specified position.RouteBuilder.xml()
Addsapplication/xml
as an acceptedContent-Type
. -
Uses of RouteBuilder in org.spincast.plugins.routing
Modifier and TypeClassDescriptionclass
RouteBuilderDefault<R extends RequestContext<?>,
W extends WebsocketContext<?>> Modifier and TypeMethodDescriptionRouteBuilderDefault.accept
(Set<ContentTypeDefaults> acceptedContentTypes) RouteBuilderDefault.accept
(ContentTypeDefaults... acceptedContentTypes) RouteBuilderDefault.acceptAsString
(String... acceptedContentTypes) RouteBuilderDefault.acceptAsString
(Set<String> acceptedContentTypes) RouteBuilderDefault.ALL()
SpincastRouter.ALL()
RouteBuilderDefault.allRoutingTypes()
RouteBuilderDefault.cache()
RouteBuilderDefault.cache
(int seconds) RouteBuilderDefault.cache
(int seconds, boolean isPrivate) RouteBuilderDefault.DELETE()
SpincastRouter.DELETE()
RouteBuilderDefault.exception()
RouteBuilderDefault.found()
RouteBuilderDefault.GET()
SpincastRouter.GET()
RouteBuilderDefault.HEAD()
SpincastRouter.HEAD()
RouteBuilderDefault.html()
RouteBuilderDefault.json()
RouteBuilderDefault.methods
(Set<HttpMethod> httpMethods) RouteBuilderDefault.methods
(HttpMethod... httpMethods) SpincastRouter.methods
(String path, Set<HttpMethod> httpMethods) SpincastRouter.methods
(String path, HttpMethod... httpMethods) SpincastRouter.methods
(Set<HttpMethod> httpMethods) SpincastRouter.methods
(HttpMethod... httpMethods) RouteBuilderDefault.noCache()
RouteBuilderDefault.notFound()
RouteBuilderDefault.OPTIONS()
SpincastRouter.OPTIONS()
RouteBuilderDefault.PATCH()
SpincastRouter.PATCH()
RouteBuilderDefault.pos
(int position) RouteBuilderDefault.POST()
SpincastRouter.POST()
RouteBuilderDefault.PUT()
SpincastRouter.PUT()
RouteBuilderDefault.skipResourcesRequests()
RouteBuilderDefault.specsIgnore()
RouteBuilderDefault.spicastCoreRouteOrPluginRoute()
RouteBuilderDefault.TRACE()
SpincastRouter.TRACE()
RouteBuilderDefault.xml()
Modifier and TypeMethodDescriptionprotected Class<? extends RouteBuilder>
SpincastRoutingPluginModule.getRouteBuilderImplClass()