.. java:import:: io.netty.buffer ByteBuf

.. java:import:: io.netty.handler.codec.http DefaultFullHttpRequest

.. java:import:: io.aalam.common.router RouteMatch

.. java:import:: java.util Map

.. java:import:: java.util List

.. java:import:: java.lang String

.. java:import:: java.util HashSet

HttpRequest.Auth
================

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

.. java:type:: public class Auth
   :outertype: HttpRequest

   The authentication parameters for a request.

Fields
------
appId
^^^^^

.. java:field::  String appId
   :outertype: HttpRequest.Auth

authType
^^^^^^^^

.. java:field::  String authType
   :outertype: HttpRequest.Auth

email
^^^^^

.. java:field::  String email
   :outertype: HttpRequest.Auth

from
^^^^

.. java:field::  String from
   :outertype: HttpRequest.Auth

userId
^^^^^^

.. java:field::  Integer userId
   :outertype: HttpRequest.Auth

Constructors
------------
Auth
^^^^

.. java:constructor:: public Auth(String type)
   :outertype: HttpRequest.Auth

   Authenication parameters will be initialized by the framework. So, the application will never use this constructor

Methods
-------
email
^^^^^

.. java:method:: public String email()
   :outertype: HttpRequest.Auth

   Email of the user requesting

   :return: string email id of the requesting user

from
^^^^

.. java:method:: public String from()
   :outertype: HttpRequest.Auth

   If the URL is requested from other apps or an external source, this method will identify the remote source. If the request is made by internal applications, from will return the app source in the format 'provider_code/app_code'

   :return: String remote requester's name

isAnonymous
^^^^^^^^^^^

.. java:method:: public boolean isAnonymous()
   :outertype: HttpRequest.Auth

   Check if the request is made by an unauthenticated source.

   :return: Boolean, true if request is anonymous else false.

isCookie
^^^^^^^^

.. java:method:: public boolean isCookie()
   :outertype: HttpRequest.Auth

   Check if the request is made by a human user identified by HTTP cookies

   :return: Boolean, true if authenticated using cookie else false.

isExternalServer
^^^^^^^^^^^^^^^^

.. java:method:: public boolean isExternalServer()
   :outertype: HttpRequest.Auth

   Check if the request made from external source

   :return: Boolean, true if request by external source else false.

isInternal
^^^^^^^^^^

.. java:method:: public boolean isInternal()
   :outertype: HttpRequest.Auth

   Check if the request made by other applications

   :return: True if made by other applications else False.

userId
^^^^^^

.. java:method:: public Integer userId()
   :outertype: HttpRequest.Auth

   ID of the user if obtained

   :return: integer value of the user ID