org.piangles.gateway.requests

Enum Endpoints

java.lang.Object

java.lang.Enum<Endpoints>

org.piangles.gateway.requests.Endpoints

All Implemented Interfaces:

Serializable, Comparable<Endpoints>

public enum Endpoints
extends Enum<Endpoints>

Enum Constant Summary

Enum Constants

Enum Constant and Description
AutoSuggest
ChangePassword
CreateUserProfile
EndpointMetadata
GenerateResetToken
GetConfiguration
GetLocation
GetUserPreferences
GetUserProfile
KeepSessionAlive
ListEndpoints
Login
Logout
MFAValidation
Ping
SetLocation
SignUp
Subscribe
UpdateUserPreferences
UpdateUserProfile
UserProfileExists

Method Summary

Modifier and Type	Method and Description
static Endpoints	valueOf(String name) Returns the enum constant of this type with the specified name.
static Endpoints[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ListEndpoints

@Description(content="Lists all the endpoints this instance of gateway supports.")
public static final Endpoints ListEndpoints

EndpointMetadata

@Description(content="Given an endpoint, the request processor returns the metadat of that endpoint.")
public static final Endpoints EndpointMetadata

UserProfileExists

@Description(content="Allows to check if a EmailId or PhoneNo is already registered.")
public static final Endpoints UserProfileExists

SignUp

@Description(content="Enables the user to register for the application.")
public static final Endpoints SignUp

Login

@Description(content="Allows the user to login and on succesful login creates a session.")
public static final Endpoints Login

GenerateResetToken

@Description(content="Enables the user to generate a temporary password in the the event the user does not remember the password.")
public static final Endpoints GenerateResetToken

MFAValidation

@Description(content="Allows for Multi-factor Authentication check post Login.")
public static final Endpoints MFAValidation

ChangePassword

@Description(content="Allows the user to change passoword post login.")
public static final Endpoints ChangePassword

Logout

@Description(content="Allows the user to logout and terminates the session.")
public static final Endpoints Logout

Ping

@Description(content="A systematic approach to keep the socket alive.")
public static final Endpoints Ping

KeepSessionAlive

@Description(content="A systematic approach to keep the session alive.")
public static final Endpoints KeepSessionAlive

CreateUserProfile

@Description(content="During registration process this endpoint helps in creation of a basic profile.")
public static final Endpoints CreateUserProfile

UpdateUserProfile

@Description(content="Allows the user to update the details of the profile.")
public static final Endpoints UpdateUserProfile

GetUserProfile

@Description(content="Returns the latest user profile.")
public static final Endpoints GetUserProfile

GetUserPreferences

@Description(content="Returns user preferences that are captured systematically.")
public static final Endpoints GetUserPreferences

UpdateUserPreferences

@Description(content="Updates the user preferences through the course of application usage.")
public static final Endpoints UpdateUserPreferences

GetConfiguration

@Description(content="Returns any configuration required by the client application.")
public static final Endpoints GetConfiguration

Subscribe

@Description(content="Registers the current connection to receive application and system notifications.")
public static final Endpoints Subscribe

AutoSuggest

@Description(content="Given what user typed, this returns back auto/smart suggestions.")
public static final Endpoints AutoSuggest

GetLocation

@Description(content="")
public static final Endpoints GetLocation

SetLocation

@Description(content="")
public static final Endpoints SetLocation

Method Detail

values

public static Endpoints[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Endpoints c : Endpoints.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Endpoints valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null