Package com.codingchili.core.protocol

Class Route<T>

java.lang.Object

com.codingchili.core.protocol.Route<T>

Type Parameters:

T - type of the handler to handle the route.

public class Route<T>
extends Object

Models a route in the Protocol.

Constructor Summary

Constructors

Constructor	Description
Route()	Empty constructor for serialization support, the handler is not serialized.
Route(String route)
Route(String route, RequestHandler<T> handler)
Route(String route, RequestHandler<T> handler, RoleType... role)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
RequestHandler<T>	getHandler()
Map<String,String>	getModel()
RoleType[]	getRoles()
String	getRoute()
int	hashCode()
Route<T>	setDescription(String description)
Route<T>	setHandler(RequestHandler<T> handler)
Route<T>	setModel(Map<String,String> model)
Route<T>	setRoles(Role... roles)
Route<T>	setRoute(String route)
Route<T>	setTemplate(Class<?> template)

Methods inherited from class java.lang.Object

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

Constructor Details

Route

public Route()

Empty constructor for serialization support, the handler is not serialized.

Route

public Route(String route)

Parameters:

route - Route(String, RequestHandler, RoleType...)

Route

public Route(String route,
 RequestHandler<T> handler)

Parameters:

route - Route(String, RequestHandler, RoleType...)

handler - Route(String, RequestHandler, RoleType...)

Route

public Route(String route,
 RequestHandler<T> handler,
 RoleType... role)

Parameters:

route - a text representation of where this route is mounted at, relative to the target handler.

handler - the handler to be invoked when the route matches an incoming request.

role - a set of roles that have access to this route.

Method Details

getRoute

public String getRoute()

setRoute

public Route<T> setRoute(String route)

Parameters:

route - Route(String, RequestHandler, RoleType...)

Returns:

fluent

getDescription

public String getDescription()

Returns:

a description of this route.

setDescription

public Route<T> setDescription(String description)

Parameters:

description - a text description of this route.

Returns:

fluent

getRoles

public RoleType[] getRoles()

Returns:

a list of roles that are authorized to invoke the endpoint.

setRoles

public Route<T> setRoles(Role... roles)

Parameters:

roles - a list of roles that are allowed access to this api.

Returns:

fluent

getHandler

public RequestHandler<T> getHandler()

Returns:

the handler that is invoked by the request processor when the request route matches this route in the protocol.

setHandler

public Route<T> setHandler(RequestHandler<T> handler)

Parameters:

handler - see getHandler()

Returns:

fluent.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setTemplate

public Route<T> setTemplate(Class<?> template)

Parameters:

template - the class template to generate a text description of.

Returns:

fluent

setModel

public Route<T> setModel(Map<String,String> model)

Parameters:

model - a map of key value pairs as attribute name and type, describes the input/output of the api method.

Returns:

fluent

getModel

public Map<String,String> getModel()

Returns:

a text representation of the object graph that the route expect as input.