er.rest.routes

Class ERXRoute

java.lang.Object

er.rest.routes.ERXRoute

public class ERXRoute
extends Object

ERXRoute encapsulates a URL path with matching values inside of it. For instance, the route "/company/{company:Company}/employees/{Person}/name/{name:String}" would yield an objects(..) dictionary with a Company EO mapped to the key "company," a Person EO mapped to the key "Person" and a String mapped to the key "name". ERXRoutes do not enforce any security -- they simply represent a way to map URL patterns onto objects.

Author:

mschrag

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXRoute.Key ERXRoute.Key encapsulates a key name and an expected value type.
static class	ERXRoute.Method
static class	ERXRoute.RouteParameterMethod

Field Summary

Fields

Modifier and Type	Field and Description
static ERXRoute.Key	ActionKey
static ERXRoute.Key	ControllerKey

Constructor Summary

Constructors

Constructor and Description
ERXRoute(String entityName, String urlPattern) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, Class<? extends ERXRouteController> controller) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, Class<? extends ERXRouteController> controller, String action) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, ERXRoute.Method method) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, ERXRoute.Method method, Class<? extends ERXRouteController> controller) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, ERXRoute.Method method, Class<? extends ERXRouteController> controller, String action) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, ERXRoute.Method method, String controller) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, ERXRoute.Method method, String controller, String action) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, String controller) Constructs a new route with the given URL pattern.
ERXRoute(String entityName, String urlPattern, String controller, String action) Constructs a new route with the given URL pattern.

Method Summary

Modifier and Type	Method and Description
void	_clearCaches() Clears any caches that may exist on ERXRoutes (probably only useful to JRebel, to clear the route parameter method cache).
String	action()
Class<? extends ERXRouteController>	controller() Returns the controller class for this route.
String	entityName() Returns the entity name of the target of this route (can be null).
NSDictionary<ERXRoute.Key,String>	keys(String url, ERXRoute.Method method) Returns the route keys for the given URL.
static NSDictionary<ERXRoute.Key,Object>	keysWithObjects(NSDictionary<ERXRoute.Key,String> keys, ERXRestContext context) Returns a dictionary mapping the route's keys to their resolved objects.
NSDictionary<ERXRoute.Key,Object>	keysWithObjects(String url, ERXRoute.Method method, ERXRestContext context) Returns a dictionary mapping the route's keys to their resolved objects.
ERXRoute.Method	method() Returns the method of this request.
NSDictionary<String,Object>	objects(NSDictionary<ERXRoute.Key,String> keys, ERXRestContext context) Returns a dictionary mapping the route's key names to their resolved objects.
NSDictionary<String,Object>	objects(String url, ERXRoute.Method method, ERXRestContext context) Returns a dictionary mapping the route's key names to their resolved objects.
Pattern	routePattern() Returns the Pattern used to match this route.
void	setMethod(ERXRoute.Method method) Sets the method of this request.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ControllerKey

public static final ERXRoute.Key ControllerKey

ActionKey

public static final ERXRoute.Key ActionKey

Constructor Detail

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                ERXRoute.Method method)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

method - the request method

ERXRoute

public ERXRoute(String entityName,
                String urlPattern)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                String controller)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

controller - the default controller class name

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                ERXRoute.Method method,
                String controller)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

method - the request method

controller - the default controller class name

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                Class<? extends ERXRouteController> controller)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

controller - the default controller class

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                ERXRoute.Method method,
                Class<? extends ERXRouteController> controller)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

method - the request method

controller - the default controller class

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                String controller,
                String action)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

controller - the default controller class name

action - the action name

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                ERXRoute.Method method,
                String controller,
                String action)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

method - the request method

controller - the default controller class name

action - the action name

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                Class<? extends ERXRouteController> controller,
                String action)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

controller - the default controller class

action - the action name

ERXRoute

public ERXRoute(String entityName,
                String urlPattern,
                ERXRoute.Method method,
                Class<? extends ERXRouteController> controller,
                String action)

Constructs a new route with the given URL pattern.

Parameters:

entityName - the name of the entity this route points to

urlPattern - the URL pattern to use

method - the request method

controller - the default controller class

action - the action name

Method Detail

entityName

public String entityName()

Returns the entity name of the target of this route (can be null).

Returns:

the entity name of the target of this route

controller

public Class<? extends ERXRouteController> controller()

Returns the controller class for this route.

Returns:

the controller class for this route

action

public String action()

Returns:

the controller action name for this route.

routePattern

public Pattern routePattern()

Returns the Pattern used to match this route.

Returns:

the Pattern used to match this route

method

public ERXRoute.Method method()

Returns the method of this request.

Returns:

the method of this request

setMethod

public void setMethod(ERXRoute.Method method)

Sets the method of this request.

Parameters:

method - the method of this request

_clearCaches

public void _clearCaches()

Clears any caches that may exist on ERXRoutes (probably only useful to JRebel, to clear the route parameter method cache).

keys

public NSDictionary<ERXRoute.Key,String> keys(String url,
                                              ERXRoute.Method method)

Returns the route keys for the given URL.

Parameters:

url - the URL to parse

method - the request method

keysWithObjects

public NSDictionary<ERXRoute.Key,Object> keysWithObjects(String url,
                                                         ERXRoute.Method method,
                                                         ERXRestContext context)

Returns a dictionary mapping the route's keys to their resolved objects.

Parameters:

url - the URL to process

method - the request method

context - the delegate to use to, for instance, fault EO's with (or null to not fault EO's)

Returns:

a dictionary mapping the route's keys to their resolved objects

objects

public NSDictionary<String,Object> objects(String url,
                                           ERXRoute.Method method,
                                           ERXRestContext context)

Returns a dictionary mapping the route's key names to their resolved objects.

Parameters:

url - the URL to process

method - the request method

context - the delegate to use to, for instance, fault EO's with (or null to not fault EO's)

Returns:

a dictionary mapping the route's key names to their resolved objects

keysWithObjects

public static NSDictionary<ERXRoute.Key,Object> keysWithObjects(NSDictionary<ERXRoute.Key,String> keys,
                                                                ERXRestContext context)

Returns a dictionary mapping the route's keys to their resolved objects.

Parameters:

keys - the parsed keys to process

context - the delegate to use to, for instance, fault EO's with (or null to not fault EO's)

Returns:

a dictionary mapping the route's keys to their resolved objects

objects

public NSDictionary<String,Object> objects(NSDictionary<ERXRoute.Key,String> keys,
                                           ERXRestContext context)

Returns a dictionary mapping the route's key names to their resolved objects.

Parameters:

keys - the parsed keys to process

context - the delegate to use to, for instance, fault EO's with (or null to not fault EO's)

Returns:

a dictionary mapping the route's key names to their resolved objects

toString

public String toString()

Overrides:

toString in class Object