io.aalam.common

Class HttpRequest.Auth

java.lang.Object

io.aalam.common.HttpRequest.Auth

Enclosing class:

HttpRequest

public class HttpRequest.Auth
extends Object

The authentication parameters for a request.

Constructor Summary

Constructors

Constructor and Description
Auth(String type) Authenication parameters will be initialized by the framework.

Method Summary

Modifier and Type	Method and Description
String	email() Email of the user requesting
String	from() If the URL is requested from other apps or an external source, this method will identify the remote source.
boolean	isAnonymous() Check if the request is made by an unauthenticated source.
boolean	isCookie() Check if the request is made by a human user identified by HTTP cookies
boolean	isExternalServer() Check if the request made from external source
boolean	isInternal() Check if the request made by other applications
Integer	userId() ID of the user if obtained

Methods inherited from class java.lang.Object

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

Constructor Detail

Auth

public Auth(String type)

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

Method Detail

userId

public Integer userId()

ID of the user if obtained

Returns:

integer value of the user ID

email

public String email()

Email of the user requesting

Returns:

string email id of the requesting user

from

public String from()

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'

Returns:

String remote requester's name

isInternal

public boolean isInternal()

Check if the request made by other applications

Returns:

True if made by other applications else False.

isExternalServer

public boolean isExternalServer()

Check if the request made from external source

Returns:

Boolean, true if request by external source else false.

isCookie

public boolean isCookie()

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

Returns:

Boolean, true if authenticated using cookie else false.

isAnonymous

public boolean isAnonymous()

Check if the request is made by an unauthenticated source.

Returns:

Boolean, true if request is anonymous else false.