public class Route extends Object
Class
object
for routes.Modifier and Type | Class and Description |
---|---|
static interface |
Route.After
Execute application logic after a response has been generated by a route handler.
|
static interface |
Route.Before
Decorates a handler and run logic before handler is executed.
|
static interface |
Route.Decorator
Decorates a route handler by running logic before and after route handler.
|
static interface |
Route.Handler
Route handler here is where the application logic lives.
|
Modifier and Type | Field and Description |
---|---|
static Route.Handler |
FAVICON
Favicon handler as a silent 404 error.
|
static Route.Handler |
METHOD_NOT_ALLOWED
Handler for
StatusCode.METHOD_NOT_ALLOWED responses. |
static Route.Handler |
NOT_FOUND
Handler for
StatusCode.NOT_FOUND responses. |
Constructor and Description |
---|
Route(String method,
String pattern,
List<String> pathKeys,
Type returnType,
Route.Handler handler,
Route.Decorator before,
Route.After after,
Renderer renderer,
Map<String,Parser> parsers)
Creates a new route.
|
Route(String method,
String pattern,
Type returnType,
Route.Handler handler,
Route.Decorator before,
Route.After after,
Renderer renderer,
Map<String,Parser> parsers)
Creates a new route.
|
Modifier and Type | Method and Description |
---|---|
Route |
consumes(MediaType... consumes)
Add one or more request types (format) consumed by this route.
|
Route.After |
getAfter()
After decorator or
null . |
Route.Decorator |
getBefore()
Before pipeline or
null . |
List<MediaType> |
getConsumes()
Request types (format) consumed by this route.
|
Object |
getHandle()
Handler instance which might or might not be the same as
getHandler() . |
Route.Handler |
getHandler()
Route handler.
|
String |
getMethod()
HTTP method.
|
List<String> |
getPathKeys()
Path keys.
|
String |
getPattern()
Path pattern.
|
Route.Handler |
getPipeline()
Route pipeline.
|
List<MediaType> |
getProduces()
Response types (format) produces by this route.
|
Renderer |
getRenderer()
Route renderer.
|
Type |
getReturnType()
Return return type.
|
Parser |
parser(MediaType contentType)
Parser for given media type.
|
Route |
produces(MediaType... produces)
Add one or more response types (format) produces by this route.
|
Route |
setConsumes(Collection<MediaType> consumes)
Add one or more request types (format) consumed by this route.
|
Route |
setHandle(Object handle)
Set route handle instance, required when handle is different from
getHandler() . |
Route |
setPipeline(Route.Handler pipeline)
Set route pipeline.
|
Route |
setProduces(Collection<MediaType> produces)
Add one or more response types (format) produces by this route.
|
Route |
setReturnType(Type returnType)
Set route return type.
|
String |
toString() |
public static final Route.Handler NOT_FOUND
StatusCode.NOT_FOUND
responses.public static final Route.Handler METHOD_NOT_ALLOWED
StatusCode.METHOD_NOT_ALLOWED
responses.public static final Route.Handler FAVICON
public Route(@Nonnull String method, @Nonnull String pattern, @Nonnull List<String> pathKeys, @Nonnull Type returnType, @Nonnull Route.Handler handler, @Nullable Route.Decorator before, @Nullable Route.After after, @Nonnull Renderer renderer, @Nonnull Map<String,Parser> parsers)
method
- HTTP method.pattern
- Path pattern.pathKeys
- Path keys.returnType
- Return type.handler
- Route handler.before
- Before pipeline.after
- After pipeline.renderer
- Route renderer.parsers
- Route parsers.public Route(@Nonnull String method, @Nonnull String pattern, @Nonnull Type returnType, @Nonnull Route.Handler handler, @Nullable Route.Decorator before, @Nullable Route.After after, @Nonnull Renderer renderer, @Nonnull Map<String,Parser> parsers)
method
- HTTP method.pattern
- Path pattern.returnType
- Return type.handler
- Route handler.before
- Before pipeline.after
- After pipeline.renderer
- Route renderer.parsers
- Route parsers.@Nonnull public Route.Handler getHandler()
@Nonnull public Route.Handler getPipeline()
@Nonnull public Object getHandle()
getHandler()
.
The handle is required to extract correct metadata.@Nullable public Route.Decorator getBefore()
null
.null
.@Nullable public Route.After getAfter()
null
.null
.public Route setHandle(@Nonnull Object handle)
getHandler()
.handle
- Handle instance.@Nonnull public Route setPipeline(Route.Handler pipeline)
pipeline
- Pipeline.@Nonnull public Route setReturnType(@Nonnull Type returnType)
returnType
- Return type.@Nonnull public List<MediaType> getProduces()
Accept
header. If none matches, we send a StatusCode.NOT_ACCEPTABLE
response.@Nonnull public Route produces(@Nonnull MediaType... produces)
produces
- Produce types.@Nonnull public Route setProduces(@Nonnull Collection<MediaType> produces)
produces
- Produce types.@Nonnull public List<MediaType> getConsumes()
Content-Type
header
is checked against these values. If none matches we send a
StatusCode.UNSUPPORTED_MEDIA_TYPE
exception.@Nonnull public Route consumes(@Nonnull MediaType... consumes)
consumes
- Consume types.@Nonnull public Route setConsumes(@Nonnull Collection<MediaType> consumes)
consumes
- Consume types.@Nonnull public Parser parser(@Nonnull MediaType contentType)
contentType
- Media type.Copyright © 2019. All rights reserved.