com.evrythng.java.wrapper.service

Class AuthService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.AuthService

public class AuthService
extends EvrythngServiceBase

Methods for the authentication API. End point /auth. Implemented by thng-access module.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_AUTH
static String	PATH_AUTH_ALL
static String	PATH_AUTH_ALL_LOGOUT
static String	PATH_AUTH_EVRYTHNG
static String	PATH_AUTH_EVRYTHNG_THNG
static String	PATH_AUTH_EVRYTHNG_THNGS
static String	PATH_AUTH_EVRYTHNG_USER_VALIDATE
static String	PATH_AUTH_EVRYTHNG_USERS

Constructor Summary

Constructors

Constructor and Description
AuthService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<Map<String,String>>	authLogouter() Logout.
EvrythngApiBuilder.Builder<Credentials>	evrythngUserAuthenticator(Credentials credentials) Authenticate a user.
EvrythngApiBuilder.Builder<Credentials>	evrythngUserCreator(User user) Register a new User in the system.
EvrythngApiBuilder.Builder<Credentials>	evrythngUserValidator(String userId, String activationCode) Activate a user.
EvrythngApiBuilder.Builder<Boolean>	thngRegistrationDeleter(String thngId) Deletes credentials of a thng.
EvrythngApiBuilder.Builder<ThngCredentials>	thngRegistrationReader(String thngId) Retrieves credentials of a thng.
EvrythngApiBuilder.Builder<ThngCredentials>	thngRegistrator(String thngId) Create credentials for a thng.

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_AUTH

public static final String PATH_AUTH

See Also:

Constant Field Values

PATH_AUTH_EVRYTHNG

public static final String PATH_AUTH_EVRYTHNG

See Also:

Constant Field Values

PATH_AUTH_EVRYTHNG_USERS

public static final String PATH_AUTH_EVRYTHNG_USERS

See Also:

Constant Field Values

PATH_AUTH_EVRYTHNG_USER_VALIDATE

public static final String PATH_AUTH_EVRYTHNG_USER_VALIDATE

See Also:

Constant Field Values

PATH_AUTH_ALL

public static final String PATH_AUTH_ALL

See Also:

Constant Field Values

PATH_AUTH_ALL_LOGOUT

public static final String PATH_AUTH_ALL_LOGOUT

See Also:

Constant Field Values

PATH_AUTH_EVRYTHNG_THNGS

public static final String PATH_AUTH_EVRYTHNG_THNGS

See Also:

Constant Field Values

PATH_AUTH_EVRYTHNG_THNG

public static final String PATH_AUTH_EVRYTHNG_THNG

See Also:

Constant Field Values

Constructor Detail

AuthService

public AuthService(ApiManager apiManager)

Method Detail

evrythngUserCreator

public EvrythngApiBuilder.Builder<Credentials> evrythngUserCreator(User user)
                                                            throws EvrythngClientException

Register a new User in the system.

POST "/auth/evrythng/users"

Parameters:

user - User instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

evrythngUserValidator

public EvrythngApiBuilder.Builder<Credentials> evrythngUserValidator(String userId,
                                                                     String activationCode)
                                                              throws EvrythngClientException

Activate a user. The activation code must match the one received during the registration process.

POST "/auth/evrythng/users/%s/validate"

Parameters:

userId - user id

activationCode - activation code

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

evrythngUserAuthenticator

public EvrythngApiBuilder.Builder<Credentials> evrythngUserAuthenticator(Credentials credentials)
                                                                  throws EvrythngClientException

Authenticate a user. Based on the email + password pair. Engine provides the ApiKey of a successfully authenticated user.

POST "/auth/evrythng"

Parameters:

credentials - Credentials instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

authLogouter

public EvrythngApiBuilder.Builder<Map<String,String>> authLogouter()
                                                            throws EvrythngClientException

Logout. Invalidate user's key.

POST "/auth/all/logout"

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngRegistrator

public EvrythngApiBuilder.Builder<ThngCredentials> thngRegistrator(String thngId)
                                                            throws EvrythngClientException

Create credentials for a thng. Engine provides the ApiKey of an registered thng.

POST "/auth/evrythng/thngs"

Parameters:

thngId - thng id to provide credentials to

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngRegistrationDeleter

public EvrythngApiBuilder.Builder<Boolean> thngRegistrationDeleter(String thngId)
                                                            throws EvrythngClientException

Deletes credentials of a thng. Engine revokes access of an registered thng.

DELETE "/auth/evrythng/thngs/%s"

Parameters:

thngId - thng id to revoke credentials

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngRegistrationReader

public EvrythngApiBuilder.Builder<ThngCredentials> thngRegistrationReader(String thngId)
                                                                   throws EvrythngClientException

Retrieves credentials of a thng.

GET "/auth/evrythng/thngs/%s"

Parameters:

thngId - the id of the thng whose credentials will be retrieved

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException