br.com.caelum.vraptor.http.route

Class DefaultRouter

java.lang.Object

br.com.caelum.vraptor.http.route.DefaultRouter

All Implemented Interfaces:

Router

@ApplicationScoped
public class DefaultRouter
extends java.lang.Object
implements Router

The default implementation of resource localization rules. It also uses a Path annotation to discover path->method mappings using the supplied ResourceAndMethodLookup.

Author:

Guilherme Silveira

Constructor Summary

Constructors

Constructor and Description
DefaultRouter(RoutesConfiguration config, Proxifier proxifier, TypeFinder finder, Converters converters, ParameterNameProvider nameProvider, Evaluator evaluator)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Route r) You can override this method to get notified by all added routes.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRouter

public DefaultRouter(RoutesConfiguration config,
             Proxifier proxifier,
             TypeFinder finder,
             Converters converters,
             ParameterNameProvider nameProvider,
             Evaluator evaluator)

Method Detail

builderFor

public RouteBuilder builderFor(java.lang.String uri)

Specified by:

builderFor in interface Router

add

public void add(Route r)

You can override this method to get notified by all added routes.

Specified by:

add in interface Router

Parameters:

r - The route

parse

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

Description copied from interface: Router

Find a ResourceMethod that can handle this request.

Specified by:

parse in interface Router

Throws:

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

allowedMethodsFor

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

Specified by:

allowedMethodsFor in interface Router

urlFor

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

Description copied from interface: Router

Retrieves a single url to access the desired method.

Specified by:

urlFor in interface Router

allRoutes

public java.util.List<Route> allRoutes()

Description copied from interface: Router

Returns a list with all routes

Specified by:

allRoutes in interface Router