br.com.caelum.vraptor.http.route

Interface Route

All Known Implementing Classes:

FixedMethodStrategy, NoStrategy

public interface Route

An specific route rule.

Author:

Guilherme Silveira

Method Summary

Methods

Modifier and Type	Method and Description
EnumSet<HttpMethod>	allowedMethods()
boolean	canHandle(Class<?> type, Method method) Returns true if this route is able to redirect to this method.
boolean	canHandle(String uri) Returns if this route can handle this URI
String	getOriginalUri() Returns the original uri for this route
int	getPriority() Routes will be ordered according to priority.
ResourceMethod	resourceMethod(MutableRequest request, String uri) Returns the resource method for this specifig rule.
String	urlFor(Class<?> type, Method m, Object... params) Returns the url which invokes this rule with values extracted from this parameter object.

Method Detail

resourceMethod

ResourceMethod resourceMethod(MutableRequest request,
                            String uri)

Returns the resource method for this specifig rule. Also applies the required parameters to this vraptor request. You must call canHandle(String) method, and see if request HTTP method is in allowedMethods() before calling this method.

canHandle

boolean canHandle(String uri)

Returns if this route can handle this URI

allowedMethods

EnumSet<HttpMethod> allowedMethods()

Returns:

all allowed HTTP methods for this Route

urlFor

String urlFor(Class<?> type,
            Method m,
            Object... params)

Returns the url which invokes this rule with values extracted from this parameter object. The object contains getters representing each method's parameter.

canHandle

boolean canHandle(Class<?> type,
                Method method)

Returns true if this route is able to redirect to this method.

getPriority

int getPriority()

Routes will be ordered according to priority. Routes with lower values of priority will be tested first.

Returns:

route priority

getOriginalUri

String getOriginalUri()

Returns the original uri for this route