io.aalam.common.router

Class Mapper

java.lang.Object

io.aalam.common.router.Mapper

public class Mapper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Mapper.SubMapper Submapper class for the mapper object.

Constructor Summary

Constructors

Constructor and Description
Mapper() The constructor will be used only by the framework.

Method Summary

Modifier and Type	Method and Description
void	connect(String url, String[] methods, Object handler, String action) Connect a URL to the framework's url router.
void	connect(String url, String[] methods, Object handler, String action, Permissions permissions) Connect a URL to the framework's url router.
RouteMatch	match(HttpRequest req) This method is used by the framework.
Mapper.SubMapper	subMapper(Object handler) Returns a new sub mapper object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Mapper

public Mapper()

The constructor will be used only by the framework. The application using this library has no direct use by initializing a Mapper object.

Method Detail

subMapper

public Mapper.SubMapper subMapper(Object handler)

Returns a new sub mapper object. This can avoid adding handler to every mapper connect call.

Parameters:

handler - Object of the handler class which has the action methods

Returns:

SubMapper Object to a submapper through which one can connect urls with inputting the handler object on every connect call.

connect

public void connect(String url,
                    String[] methods,
                    Object handler,
                    String action)
             throws Exception

Connect a URL to the framework's url router.

Parameters:

url - The url path.

methods - Array of method names that apply on this url

handler - Object of the handler class.

action - The name of a public method defined in the handler class that processes the functionality for this url.

Throws:

Exception

connect

public void connect(String url,
                    String[] methods,
                    Object handler,
                    String action,
                    Permissions permissions)
             throws Exception

Connect a URL to the framework's url router.

Parameters:

url - The url path.

methods - Array of method names that apply on this url

handler - Object of the handler class.

action - The name of a public method defined in the handler class that processes the functionality for this url.

permissions - Permissions object for this URL

Throws:

Exception

See Also:

Permissions

match

public RouteMatch match(HttpRequest req)

This method is used by the framework. The application has no direct use in calling this method.

Parameters:

req - The http request object