Routing.Rules (Helidon 0.10.4 API)

Type Parameters:

T - the type to be returned by the subclasses (to support fluent API style)

All Known Implementing Classes:

Routing.Builder

Enclosing interface:

Routing
```
public static interface Routing.Rules<T extends Routing.Rules>
```
An API to define HTTP request routing rules.

See Also:

Routing.Builder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`T`	`any(Handler... requestHandlers)`	Routes all requests to provided handler(s).
`T`	`any(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes all requests with corresponding path to provided handler(s).
`T`	`any(java.lang.String pathPattern, Handler... requestHandlers)`	Routes all requests with corresponding path to provided handler(s).
`T`	`anyOf(java.lang.Iterable<Http.RequestMethod> methods, Handler... requestHandlers)`	Routes requests any specified method to provided handler(s).
`T`	`anyOf(java.lang.Iterable<Http.RequestMethod> methods, PathMatcher pathMatcher, Handler... requestHandlers)`	Routes requests with any specified method and corresponding path to provided handler(s).
`T`	`anyOf(java.lang.Iterable<Http.RequestMethod> methods, java.lang.String pathPattern, Handler... requestHandlers)`	Routes requests with any specified method and corresponding path to provided handler(s).
`T`	`delete(Handler... requestHandlers)`	Routes all DELETE requests to provided handler(s).
`T`	`delete(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes DELETE requests with corresponding path to provided handler(s).
`T`	`delete(java.lang.String pathPattern, Handler... requestHandlers)`	Routes DELETE requests with corresponding path to provided handler(s).
`T`	`get(Handler... requestHandlers)`	Routes all GET requests to provided handler(s).
`T`	`get(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes GET requests with corresponding path to provided handler(s).
`T`	`get(java.lang.String pathPattern, Handler... requestHandlers)`	Routes GET requests with corresponding path to provided handler(s).
`T`	`head(Handler... requestHandlers)`	Routes all HEAD requests to provided handler(s).
`T`	`head(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes HEAD requests with corresponding path to provided handler(s).
`T`	`head(java.lang.String pathPattern, Handler... requestHandlers)`	Routes HEAD requests with corresponding path to provided handler(s).
`T`	`onNewWebServer(java.util.function.Consumer<WebServer> webServerConsumer)`	Registers callback on created new `WebServer` instance with this routing.
`T`	`options(Handler... requestHandlers)`	Routes all OPTIONS requests to provided handler(s).
`T`	`options(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes OPTIONS requests with corresponding path to provided handler(s).
`T`	`options(java.lang.String pathPattern, Handler... requestHandlers)`	Routes OPTIONS requests with corresponding path to provided handler(s).
`T`	`post(Handler... requestHandlers)`	Routes all POST requests to provided handler(s).
`T`	`post(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes POST requests with corresponding path to provided handler(s).
`T`	`post(java.lang.String pathPattern, Handler... requestHandlers)`	Routes POST requests with corresponding path to provided handler(s).
`T`	`put(Handler... requestHandlers)`	Routes all PUT requests to provided handler(s).
`T`	`put(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes PUT requests with corresponding path to provided handler(s).
`T`	`put(java.lang.String pathPattern, Handler... requestHandlers)`	Routes PUT requests with corresponding path to provided handler(s).
`T`	`register(Builder<? extends Service>... serviceBuilders)`	Registers builder consumer.
`T`	`register(Service... services)`	Registers builder consumer.
`T`	`register(java.lang.String pathPattern, Builder<? extends Service>... serviceBuilders)`	Registers builder consumer.
`T`	`register(java.lang.String pathPattern, Service... services)`	Registers builder consumer.
`T`	`trace(Handler... requestHandlers)`	Routes all TRACE requests to provided handler(s).
`T`	`trace(PathMatcher pathMatcher, Handler... requestHandlers)`	Routes TRACE requests with corresponding path to provided handler(s).
`T`	`trace(java.lang.String pathPattern, Handler... requestHandlers)`	Routes TRACE requests with corresponding path to provided handler(s).

- Method Detail
  - register
```
T register(Service... services)
```
    Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.
    
    Parameters:
    
    services - services to register
    
    Returns:
    
    Updated routing configuration
  - register
```
T register(Builder<? extends Service>... serviceBuilders)
```
    Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.
    
    Parameters:
    
    serviceBuilders - service builder to register; they will be built as a first step of this method execution
    
    Returns:
    
    Updated routing configuration
  - register
```
T register(java.lang.String pathPattern,
           Service... services)
```
    Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    services - services to register
    
    Returns:
    
    Updated routing configuration
  - register
```
T register(java.lang.String pathPattern,
           Builder<? extends Service>... serviceBuilders)
```
    Registers builder consumer. It enables to separate complex routing definitions to dedicated classes.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    serviceBuilders - service builder to register; they will be built as a first step of this method execution
    
    Returns:
    
    an updated routing configuration
  - get
```
T get(Handler... requestHandlers)
```
    Routes all GET requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - get
```
T get(java.lang.String pathPattern,
      Handler... requestHandlers)
```
    Routes GET requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - get
```
T get(PathMatcher pathMatcher,
      Handler... requestHandlers)
```
    Routes GET requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - put
```
T put(Handler... requestHandlers)
```
    Routes all PUT requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - put
```
T put(java.lang.String pathPattern,
      Handler... requestHandlers)
```
    Routes PUT requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - put
```
T put(PathMatcher pathMatcher,
      Handler... requestHandlers)
```
    Routes PUT requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for a registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - post
```
T post(Handler... requestHandlers)
```
    Routes all POST requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - post
```
T post(java.lang.String pathPattern,
       Handler... requestHandlers)
```
    Routes POST requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - post
```
T post(PathMatcher pathMatcher,
       Handler... requestHandlers)
```
    Routes POST requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - delete
```
T delete(Handler... requestHandlers)
```
    Routes all DELETE requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - delete
```
T delete(java.lang.String pathPattern,
         Handler... requestHandlers)
```
    Routes DELETE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - delete
```
T delete(PathMatcher pathMatcher,
         Handler... requestHandlers)
```
    Routes DELETE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - options
```
T options(Handler... requestHandlers)
```
    Routes all OPTIONS requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - options
```
T options(java.lang.String pathPattern,
          Handler... requestHandlers)
```
    Routes OPTIONS requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - options
```
T options(PathMatcher pathMatcher,
          Handler... requestHandlers)
```
    Routes OPTIONS requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - head
```
T head(Handler... requestHandlers)
```
    Routes all HEAD requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - head
```
T head(java.lang.String pathPattern,
       Handler... requestHandlers)
```
    Routes HEAD requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - head
```
T head(PathMatcher pathMatcher,
       Handler... requestHandlers)
```
    Routes HEAD requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - trace
```
T trace(Handler... requestHandlers)
```
    Routes all TRACE requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - trace
```
T trace(java.lang.String pathPattern,
        Handler... requestHandlers)
```
    Routes TRACE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - trace
```
T trace(PathMatcher pathMatcher,
        Handler... requestHandlers)
```
    Routes TRACE requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - any
```
T any(Handler... requestHandlers)
```
    Routes all requests to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - any
```
T any(java.lang.String pathPattern,
      Handler... requestHandlers)
```
    Routes all requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - any
```
T any(PathMatcher pathMatcher,
      Handler... requestHandlers)
```
    Routes all requests with corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - anyOf
```
T anyOf(java.lang.Iterable<Http.RequestMethod> methods,
        Handler... requestHandlers)
```
    Routes requests any specified method to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    methods - HTTP methods
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - anyOf
```
T anyOf(java.lang.Iterable<Http.RequestMethod> methods,
        java.lang.String pathPattern,
        Handler... requestHandlers)
```
    Routes requests with any specified method and corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    methods - HTTP methods
    
    pathPattern - a URI path pattern. See PathMatcher for pattern syntax reference.
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - anyOf
```
T anyOf(java.lang.Iterable<Http.RequestMethod> methods,
        PathMatcher pathMatcher,
        Handler... requestHandlers)
```
    Routes requests with any specified method and corresponding path to provided handler(s). Request handler can call ServerRequest.next() to continue processing on the next registered handler.
    
    Parameters:
    
    methods - HTTP methods
    
    pathMatcher - define path for registered router
    
    requestHandlers - handlers to tryProcess HTTP request
    
    Returns:
    
    an updated routing configuration
  - onNewWebServer
```
T onNewWebServer(java.util.function.Consumer<WebServer> webServerConsumer)
```
    Registers callback on created new WebServer instance with this routing.
    
    Parameters:
    
    webServerConsumer - a WebServer creation callback
    
    Returns:
    
    updated routing configuration

Interface Routing.Rules<T extends Routing.Rules>

Method Summary

Method Detail

register

register

register

register

get

get

get

put

put

put

post

post

post

delete

delete

delete

options

options

options

head

head

head

trace

trace

trace

any

any

any

anyOf

anyOf

anyOf

onNewWebServer