br.com.caelum.vraptor.http.route

Interface Router

All Known Implementing Classes:

DefaultRouter

public interface Router

Handles different rules in order to translate urls into Resource methods.

Author:

Guilherme Silveira

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Route route) Add a new Route to this Router
java.util.EnumSet<HttpMethod>	allowedMethodsFor(java.lang.String uri)
java.util.List<Route>	allRoutes() Returns a list with all routes
RouteBuilder	builderFor(java.lang.String uri)
ResourceMethod	parse(java.lang.String uri, HttpMethod method, MutableRequest request) Find a ResourceMethod that can handle this request.
<T> java.lang.String	urlFor(java.lang.Class<T> type, java.lang.reflect.Method method, java.lang.Object... params) Retrieves a single url to access the desired method.

Method Detail

add

void add(Route route)

Add a new Route to this Router

Parameters:

route - The route

parse

ResourceMethod parse(java.lang.String uri,
                   HttpMethod method,
                   MutableRequest request)
                     throws ResourceNotFoundException,
                            MethodNotAllowedException,
                            java.lang.IllegalStateException

Find a ResourceMethod that can handle this request.

Throws:

ResourceNotFoundException - when there is no ResourceMethod that can handle this request

MethodNotAllowedException - when there is no ResourceMethod that can handle given URI with given HttpMethod

java.lang.IllegalStateException - when more than one ResourceMethod can handle this request.

urlFor

<T> java.lang.String urlFor(java.lang.Class<T> type,
                          java.lang.reflect.Method method,
                          java.lang.Object... params)

Retrieves a single url to access the desired method.

allRoutes

java.util.List<Route> allRoutes()

Returns a list with all routes

builderFor

RouteBuilder builderFor(java.lang.String uri)

allowedMethodsFor

java.util.EnumSet<HttpMethod> allowedMethodsFor(java.lang.String uri)