RouteBuilder (org.spincast:spincast-framework 0.9.28 API)

java.lang.Object
- org.spincast.plugins.routing.RouteBuilder<R,W>

All Implemented Interfaces:: IRouteBuilder<R>

public class RouteBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>
extends Object
implements IRouteBuilder<R>

Field Summary

Fields
Modifier and Type Field and Description

protected org.slf4j.Logger logger

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

Constructor Summary

Constructors
Constructor and Description
`RouteBuilder(IRouteFactory<R> routeFactory, ISpincastRouterConfig spincastRouterConfig, ISpincastFilters<R> spincastFilters, ISpincastConfig spincastConfig)`
`RouteBuilder(IRouter<R,W> router, IRouteFactory<R> routeFactory, ISpincastRouterConfig spincastRouterConfig, ISpincastFilters<R> spincastFilters, ISpincastConfig spincastConfig)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IRouteBuilder<R>`	`accept(ContentTypeDefaults... acceptedContentTypes)` Sets the accepted `Content-Types`.
`IRouteBuilder<R>`	`accept(Set<ContentTypeDefaults> acceptedContentTypes)` Sets the accepted `Content-Types`.
`IRouteBuilder<R>`	`acceptAsString(Set<String> acceptedContentTypes)` Sets the accepted `Content-Types`.
`IRouteBuilder<R>`	`acceptAsString(String... acceptedContentTypes)` Sets the accepted `Content-Types`.
`IRouteBuilder<R>`	`after(IHandler<R> afterFilter)` Adds an "after" filter which will only be applied to this particular route.
`IRouteBuilder<R>`	`ALL()` Adds all HTTP methods as being supported.
`IRouteBuilder<R>`	`allRoutingTypes()` This route will be considered for all routing types.
`IRouteBuilder<R>`	`before(IHandler<R> beforeFilter)` Adds a "before" filter which will only be applied to this particular route.
`IRouteBuilder<R>`	`cache()` Adds cache headers.
`IRouteBuilder<R>`	`cache(int seconds)` Adds public cache headers.
`IRouteBuilder<R>`	`cache(int seconds, boolean isPrivate)` Adds cache headers.
`IRouteBuilder<R>`	`cache(int seconds, boolean isPrivate, Integer secondsCdn)` Adds cache headers.
`IRoute<R>`	`create(IHandler<R> mainHandler)` Creates and returns the route without adding it to the router.
`IRouteBuilder<R>`	`DELETE()` Adds `DELETE` as a supported HTTP method.
`IRouteBuilder<R>`	`exception()` This route will be considered during an `Exception` routing process.
`IRouteBuilder<R>`	`found()` This route will be considered during a `Found` routing process.
`IRouteBuilder<R>`	`GET()` Addss `GET` as a supported HTTP method.
`Set<String>`	`getAcceptedContentTypes()`
`List<IHandler<R>>`	`getAfterFilters()`
`List<IHandler<R>>`	`getBeforeFilters()`
`protected Integer`	`getCacheCdnSecondsByDefault()`
`protected int`	`getCacheSecondsByDefault()`
`Set<String>`	`getFilterIdsToSkip()`
`Set<HttpMethod>`	`getHttpMethods()`
`String`	`getId()`
`IHandler<R>`	`getMainHandler()`
`String`	`getPath()`
`Set<Integer>`	`getPositions()`
`protected IRouteFactory<R>`	`getRouteFactory()`
`protected IRouter<R,W>`	`getRouter()`
`Set<RoutingType>`	`getRoutingTypes()`
`protected ISpincastConfig`	`getSpincastConfig()`
`protected ISpincastFilters<R>`	`getSpincastFilters()`
`protected ISpincastRouterConfig`	`getSpincastRouterConfig()`
`IRouteBuilder<R>`	`HEAD()` Adds `HEAD` as a supported HTTP method.
`IRouteBuilder<R>`	`html()` Adds `application/html` as an accepted `Content-Type`.
`IRouteBuilder<R>`	`id(String id)` An id that can be used to identify the route.
`protected boolean`	`isCachePrivateByDefault()`
`IRouteBuilder<R>`	`json()` Adds `application/json` as an accepted `Content-Type`.
`IRouteBuilder<R>`	`noCache()` Automatically adds "no-cache" headers to the response.
`IRouteBuilder<R>`	`notFound()` This route will be considered during a `Not Found` routing process.
`IRouteBuilder<R>`	`OPTIONS()` Adds `OPTIONS` as a supported HTTP method.
`IRouteBuilder<R>`	`PATCH()` Adds `PATCH` as a supported HTTP method.
`IRouteBuilder<R>`	`path(String path)` The path of the route.
`IRouteBuilder<R>`	`pos(int position)` The position of the handler.
`IRouteBuilder<R>`	`POST()` Adds `POST` as a supported HTTP method.
`IRouteBuilder<R>`	`PUT()` Adds `PUT` as a supported HTTP method.
`void`	`save(IHandler<R> mainHandler)` Creates the route and saves it to the router.
`IRouteBuilder<R>`	`skip(String filterId)` Skip a "before" and "after" filter for this route.
`IRouteBuilder<R>`	`SOME(HttpMethod... httpMethods)` Adds the specified HTTP methods as being supported.
`IRouteBuilder<R>`	`SOME(Set<HttpMethod> httpMethods)` Adds the specified HTTP methods as being supported.
`IRouteBuilder<R>`	`TRACE()` Adds `TRACE` as a supported HTTP method.
`IRouteBuilder<R>`	`xml()` Adds `application/xml` as an accepted `Content-Type`.

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
  - RouteBuilder
```
public RouteBuilder(IRouteFactory<R> routeFactory,
                    ISpincastRouterConfig spincastRouterConfig,
                    ISpincastFilters<R> spincastFilters,
                    ISpincastConfig spincastConfig)
```
  - RouteBuilder
```
public RouteBuilder(IRouter<R,W> router,
                    IRouteFactory<R> routeFactory,
                    ISpincastRouterConfig spincastRouterConfig,
                    ISpincastFilters<R> spincastFilters,
                    ISpincastConfig spincastConfig)
```
- Method Detail
  - getRouter
```
protected IRouter<R,W> getRouter()
```
  - getRouteFactory
```
protected IRouteFactory<R> getRouteFactory()
```
  - getSpincastRouterConfig
```
protected ISpincastRouterConfig getSpincastRouterConfig()
```
  - getSpincastFilters
```
protected ISpincastFilters<R> getSpincastFilters()
```
  - getSpincastConfig
```
protected ISpincastConfig getSpincastConfig()
```
  - getId
```
public String getId()
```
  - getPath
```
public String getPath()
```
  - getPositions
```
public Set<Integer> getPositions()
```
  - getRoutingTypes
```
public Set<RoutingType> getRoutingTypes()
```
  - getHttpMethods
```
public Set<HttpMethod> getHttpMethods()
```
  - getBeforeFilters
```
public List<IHandler<R>> getBeforeFilters()
```
  - getAfterFilters
```
public List<IHandler<R>> getAfterFilters()
```
  - getMainHandler
```
public IHandler<R> getMainHandler()
```
  - getAcceptedContentTypes
```
public Set<String> getAcceptedContentTypes()
```
  - getFilterIdsToSkip
```
public Set<String> getFilterIdsToSkip()
```
  - id
```
public IRouteBuilder<R> id(String id)
```
    Description copied from interface: IRouteBuilder
    
    An id that can be used to identify the route. Must be unique.
    
    Specified by:
    
    id in interface IRouteBuilder<R extends IRequestContext<?>>
  - pos
```
public IRouteBuilder<R> pos(int position)
```
    Description copied from interface: IRouteBuilder
    
    The position of the handler. If "0", the handler is considered as the *main* handler. Only one main handler per request is run (the first one found)! The main handler is usually where the body of the response is created. A route with a position less than "0" is considered as a "before" filter and will be run before the main handler. A route with a position greater than "0" is considered as an "after" filter and will be run after the main handler. All the matching before and after filters are run, from the lower position to the higher. If two filters have the same position, they will be run in order they have been added to the router. More than one position is allowed. If not specified, "0" is used.
    
    Specified by:
    
    pos in interface IRouteBuilder<R extends IRequestContext<?>>
  - allRoutingTypes
```
public IRouteBuilder<R> allRoutingTypes()
```
    Description copied from interface: IRouteBuilder
    
    This route will be considered for all routing types.
    
    Specified by:
    
    allRoutingTypes in interface IRouteBuilder<R extends IRequestContext<?>>
  - found
```
public IRouteBuilder<R> found()
```
    Description copied from interface: IRouteBuilder
    
    This route will be considered during a Found routing process.
    
    Specified by:
    
    found in interface IRouteBuilder<R extends IRequestContext<?>>
  - notFound
```
public IRouteBuilder<R> notFound()
```
    Description copied from interface: IRouteBuilder
    
    This route will be considered during a Not Found routing process.
    
    Specified by:
    
    notFound in interface IRouteBuilder<R extends IRequestContext<?>>
  - exception
```
public IRouteBuilder<R> exception()
```
    Description copied from interface: IRouteBuilder
    
    This route will be considered during an Exception routing process.
    
    Specified by:
    
    exception in interface IRouteBuilder<R extends IRequestContext<?>>
  - before
```
public IRouteBuilder<R> before(IHandler<R> beforeFilter)
```
    Description copied from interface: IRouteBuilder
    
    Adds a "before" filter which will only be applied to this particular route. If more than one filter is added, they will be run in order they have been added.
    
    Specified by:
    
    before in interface IRouteBuilder<R extends IRequestContext<?>>
  - after
```
public IRouteBuilder<R> after(IHandler<R> afterFilter)
```
    Description copied from interface: IRouteBuilder
    
    Adds an "after" filter which will only be applied to this particular route. If more than one filter is added, they will be run in order they have been added.
    
    Specified by:
    
    after in interface IRouteBuilder<R extends IRequestContext<?>>
  - acceptAsString
```
public IRouteBuilder<R> acceptAsString(String... acceptedContentTypes)
```
    Description copied from interface: IRouteBuilder
    
    Sets the accepted Content-Types. This route will only be considered for requests specifying those Content-Types as being accepted (using the Accept header).
    
    Specified by:
    
    acceptAsString in interface IRouteBuilder<R extends IRequestContext<?>>
  - acceptAsString
```
public IRouteBuilder<R> acceptAsString(Set<String> acceptedContentTypes)
```
    Description copied from interface: IRouteBuilder
    
    Sets the accepted Content-Types. This route will only be considered for requests specifying those Content-Types as being accepted (using the Accept header).
    
    Specified by:
    
    acceptAsString in interface IRouteBuilder<R extends IRequestContext<?>>
  - accept
```
public IRouteBuilder<R> accept(ContentTypeDefaults... acceptedContentTypes)
```
    Description copied from interface: IRouteBuilder
    
    Sets the accepted Content-Types. This route will only be considered for requests specifying those Content-Types as being accepted (using the Accept header).
    
    Specified by:
    
    accept in interface IRouteBuilder<R extends IRequestContext<?>>
  - accept
```
public IRouteBuilder<R> accept(Set<ContentTypeDefaults> acceptedContentTypes)
```
    Description copied from interface: IRouteBuilder
    
    Sets the accepted Content-Types. This route will only be considered for requests specifying those Content-Types as being accepted (using the Accept header).
    
    Specified by:
    
    accept in interface IRouteBuilder<R extends IRequestContext<?>>
  - html
```
public IRouteBuilder<R> html()
```
    Description copied from interface: IRouteBuilder
    
    Adds application/html as an accepted Content-Type.
    
    Specified by:
    
    html in interface IRouteBuilder<R extends IRequestContext<?>>
  - json
```
public IRouteBuilder<R> json()
```
    Description copied from interface: IRouteBuilder
    
    Adds application/json as an accepted Content-Type.
    
    Specified by:
    
    json in interface IRouteBuilder<R extends IRequestContext<?>>
  - xml
```
public IRouteBuilder<R> xml()
```
    Description copied from interface: IRouteBuilder
    
    Adds application/xml as an accepted Content-Type.
    
    Specified by:
    
    xml in interface IRouteBuilder<R extends IRequestContext<?>>
  - path
```
public IRouteBuilder<R> path(String path)
```
    Description copied from interface: IRouteBuilder
    
    The path of the route.
    
    Specified by:
    
    path in interface IRouteBuilder<R extends IRequestContext<?>>
  - GET
```
public IRouteBuilder<R> GET()
```
    Description copied from interface: IRouteBuilder
    
    Addss GET as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    GET in interface IRouteBuilder<R extends IRequestContext<?>>
  - POST
```
public IRouteBuilder<R> POST()
```
    Description copied from interface: IRouteBuilder
    
    Adds POST as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    POST in interface IRouteBuilder<R extends IRequestContext<?>>
  - PUT
```
public IRouteBuilder<R> PUT()
```
    Description copied from interface: IRouteBuilder
    
    Adds PUT as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    PUT in interface IRouteBuilder<R extends IRequestContext<?>>
  - DELETE
```
public IRouteBuilder<R> DELETE()
```
    Description copied from interface: IRouteBuilder
    
    Adds DELETE as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    DELETE in interface IRouteBuilder<R extends IRequestContext<?>>
  - OPTIONS
```
public IRouteBuilder<R> OPTIONS()
```
    Description copied from interface: IRouteBuilder
    
    Adds OPTIONS as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    OPTIONS in interface IRouteBuilder<R extends IRequestContext<?>>
  - TRACE
```
public IRouteBuilder<R> TRACE()
```
    Description copied from interface: IRouteBuilder
    
    Adds TRACE as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    TRACE in interface IRouteBuilder<R extends IRequestContext<?>>
  - HEAD
```
public IRouteBuilder<R> HEAD()
```
    Description copied from interface: IRouteBuilder
    
    Adds HEAD as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    HEAD in interface IRouteBuilder<R extends IRequestContext<?>>
  - PATCH
```
public IRouteBuilder<R> PATCH()
```
    Description copied from interface: IRouteBuilder
    
    Adds PATCH as a supported HTTP method. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. This one will simply be added.
    
    Specified by:
    
    PATCH in interface IRouteBuilder<R extends IRequestContext<?>>
  - ALL
```
public IRouteBuilder<R> ALL()
```
    Description copied from interface: IRouteBuilder
    
    Adds all HTTP methods as being supported. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. By calling this method, all methods will now be suported.
    
    Specified by:
    
    ALL in interface IRouteBuilder<R extends IRequestContext<?>>
  - SOME
```
public IRouteBuilder<R> SOME(Set<HttpMethod> httpMethods)
```
    Description copied from interface: IRouteBuilder
    
    Adds the specified HTTP methods as being supported. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. Those new ones will simply be added.
    
    Specified by:
    
    SOME in interface IRouteBuilder<R extends IRequestContext<?>>
  - SOME
```
public IRouteBuilder<R> SOME(HttpMethod... httpMethods)
```
    Description copied from interface: IRouteBuilder
    
    Adds the specified HTTP methods as being supported. If you started the creation of the route from an IRouter object, you already specified some supported HTTP methods. Those new ones will simply be added.
    
    Specified by:
    
    SOME in interface IRouteBuilder<R extends IRequestContext<?>>
  - save
```
public void save(IHandler<R> mainHandler)
```
    Description copied from interface: IRouteBuilder
    
    Creates the route and saves it to the router. If the creation of the route was not started using an IRouter object, an exception will be thrown.
    
    Specified by:
    
    save in interface IRouteBuilder<R extends IRequestContext<?>>
  - create
```
public IRoute<R> create(IHandler<R> mainHandler)
```
    Description copied from interface: IRouteBuilder
    
    Creates and returns the route without adding it to the router. NOTE : use save(...) instead to save the route to the router at the end of the build process!
    
    Specified by:
    
    create in interface IRouteBuilder<R extends IRequestContext<?>>
  - noCache
```
public IRouteBuilder<R> noCache()
```
    Description copied from interface: IRouteBuilder
    
    Automatically adds "no-cache" headers to the response.
    
    Specified by:
    
    noCache in interface IRouteBuilder<R extends IRequestContext<?>>
  - cache
```
public IRouteBuilder<R> cache()
```
    Description copied from interface: IRouteBuilder
    
    Adds cache headers.
    Uses the default cache configurations, provided by ISpincastConfig
    
    Specified by:
    
    cache in interface IRouteBuilder<R extends IRequestContext<?>>
  - cache
```
public IRouteBuilder<R> cache(int seconds)
```
    Description copied from interface: IRouteBuilder
    
    Adds public cache headers.
    
    Specified by:
    
    cache in interface IRouteBuilder<R extends IRequestContext<?>>
    
    Parameters:
    
    seconds - The number of seconds the resource associated with this route should be cached.
  - cache
```
public IRouteBuilder<R> cache(int seconds,
                              boolean isPrivate)
```
    Description copied from interface: IRouteBuilder
    
    Adds cache headers.
    
    Specified by:
    
    cache in interface IRouteBuilder<R extends IRequestContext<?>>
    
    Parameters:
    
    seconds - The number of seconds the resource associated with this route should be cached.
    
    isPrivate - should the cache be private? (help)
  - cache
```
public IRouteBuilder<R> cache(int seconds,
                              boolean isPrivate,
                              Integer secondsCdn)
```
    Description copied from interface: IRouteBuilder
    
    Adds cache headers.
    
    Specified by:
    
    cache in interface IRouteBuilder<R extends IRequestContext<?>>
    
    Parameters:
    
    seconds - The number of seconds the resource associated with this route should be cached.
    
    isPrivate - should the cache be private? (help)
    
    secondsCdn - The number of seconds the resource associated with this route should be cached by a CDN/proxy. If null, it won't be used.
  - getCacheSecondsByDefault
```
protected int getCacheSecondsByDefault()
```
  - isCachePrivateByDefault
```
protected boolean isCachePrivateByDefault()
```
  - getCacheCdnSecondsByDefault
```
protected Integer getCacheCdnSecondsByDefault()
```
  - skip
```
public IRouteBuilder<R> skip(String filterId)
```
    Description copied from interface: IRouteBuilder
    
    Skip a "before" and "after" filter for this route.
    This is useful when you set a global filter but want to skip it one a specific route only.
    
    Specified by:
    
    skip in interface IRouteBuilder<R extends IRequestContext<?>>

Class RouteBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

RouteBuilder

RouteBuilder

Method Detail

getRouter

getRouteFactory

getSpincastRouterConfig

getSpincastFilters

getSpincastConfig

getId

getPath

getPositions

getRoutingTypes

getHttpMethods

getBeforeFilters

getAfterFilters

getMainHandler

getAcceptedContentTypes

getFilterIdsToSkip

id

pos

allRoutingTypes

found

notFound

exception

before

after

acceptAsString

acceptAsString

accept

accept

html

json

xml

path

GET

POST

PUT

DELETE

OPTIONS

TRACE

HEAD

PATCH

ALL

SOME

SOME

save

create

noCache

cache

cache

cache

cache

getCacheSecondsByDefault

isCachePrivateByDefault

getCacheCdnSecondsByDefault

skip