.. java:import:: java.util ArrayList

Mapper
======

.. java:package:: io.aalam.common.router
   :noindex:

.. java:type:: public class Mapper

Fields
------
routeList
^^^^^^^^^

.. java:field::  ArrayList<Route> routeList
   :outertype: Mapper

Constructors
------------
Mapper
^^^^^^

.. java:constructor:: public Mapper()
   :outertype: Mapper

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

Methods
-------
connect
^^^^^^^

.. java:method:: public void connect(String url, String[] methods, Object handler, String action) throws Exception
   :outertype: Mapper

   Connect a URL to the framework's url router.

   :param url: The url path.
   :param methods: Array of method names that apply on this url
   :param handler: Object of the handler class.
   :param action: The name of a public method defined in the handler class that processes the functionality for this url.

connect
^^^^^^^

.. java:method:: public void connect(String url, String[] methods, Object handler, String action, Permissions permissions) throws Exception
   :outertype: Mapper

   Connect a URL to the framework's url router.

   :param url: The url path.
   :param methods: Array of method names that apply on this url
   :param handler: Object of the handler class.
   :param action: The name of a public method defined in the handler class that processes the functionality for this url.
   :param permissions: Permissions object for this URL

   **See also:** :java:ref:`Permissions`

match
^^^^^

.. java:method:: public RouteMatch match(HttpRequest req)
   :outertype: Mapper

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

   :param req: The http request object

subMapper
^^^^^^^^^

.. java:method:: public SubMapper subMapper(Object handler)
   :outertype: Mapper

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

   :param handler: Object of the handler class which has the action methods
   :return: SubMapper Object to a submapper through which one can connect urls with inputting the handler object on every connect call.