Package co.arago.hiro.client.rest

Class AuthAPI

java.lang.Object

co.arago.hiro.client.connection.AbstractAPIHandler

co.arago.hiro.client.rest.AuthenticatedAPIHandler

co.arago.hiro.client.rest.AuthAPI

public class AuthAPI
extends AuthenticatedAPIHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthAPI.Builder
static class	AuthAPI.Conf<T extends AuthAPI.Conf<T>>
class	AuthAPI.GetMeAccountCommand	get account information about current token
class	AuthAPI.GetMeAvatarCommand	get avatar of current token's account
class	AuthAPI.GetMeProfileCommand	get profile of current token's account
class	AuthAPI.GetMeRolesCommand	get roles connected to of current token teams
class	AuthAPI.GetMeTeamsCommand	gets the teams connected to current token
class	AuthAPI.PostMeProfileCommand	change profile of current token's account
class	AuthAPI.PutMeAvatarCommand	set avatar of current token's account
class	AuthAPI.PutMePasswordCommand	change password of current token's account

Nested classes/interfaces inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler

AuthenticatedAPIHandler.APIRequestConf<T extends AuthenticatedAPIHandler.APIRequestConf<T,R>,R>, AuthenticatedAPIHandler.SendBodyAPIRequestConf<T extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>,R>, AuthenticatedAPIHandler.SendStreamAPIRequestConf<T extends AuthenticatedAPIHandler.SendStreamAPIRequestConf<T,R>,R>

Field Summary

Fields inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler

apiName, apiPath, apiURI, tokenAPIHandler

Fields inherited from class co.arago.hiro.client.connection.AbstractAPIHandler

httpClientHandler, httpRequestTimeout, maxRetries, rootApiURI, title, userAgent, version, webSocketURI

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthAPI(AuthAPI.Conf<?> builder)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
AuthAPI.GetMeAccountCommand	getMeAccountCommand()	get account information about current token
AuthAPI.GetMeAvatarCommand	getMeAvatarCommand()	get avatar of current token's account
AuthAPI.GetMeProfileCommand	getMeProfileCommand()	get profile of current token's account
AuthAPI.GetMeRolesCommand	getMeRolesCommand()	get roles connected to of current token teams
AuthAPI.GetMeTeamsCommand	getMeTeamsCommand()	gets the teams connected to current token
static AuthAPI.Conf<?>	newBuilder(TokenAPIHandler tokenAPIHandler)	Get a AuthAPI.Builder for AuthAPI.
AuthAPI.PostMeProfileCommand	postMeProfileCommand()	change profile of current token's account
AuthAPI.PutMeAvatarCommand	putMeAvatarCommand(StreamContainer streamContainer)	set avatar of current token's account
AuthAPI.PutMeAvatarCommand	putMeAvatarCommand(java.io.InputStream inputStream)	set avatar of current token's account
AuthAPI.PutMePasswordCommand	putMePasswordCommand()	change password of current token's account

Methods inherited from class co.arago.hiro.client.rest.AuthenticatedAPIHandler

addToHeaders, checkResponse, getEndpointURI

Methods inherited from class co.arago.hiro.client.connection.AbstractAPIHandler

addQueryFragmentAndNormalize, buildApiURI, buildEndpointURI, buildURI, buildWebSocketURI, delete, executeAsyncWithStreamBody, executeAsyncWithStringBody, executeBinary, executeWithStreamBody, executeWithStringBody, get, getBinary, getConf, getHttpLogger, getHttpRequestTimeout, getMaxRetries, getOrBuildClient, getRequestBuilder, getRootApiURI, getUserAgent, getWebSocketURI, patch, patchBinary, post, postBinary, put, putBinary, send, sendAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthAPI

protected AuthAPI(AuthAPI.Conf<?> builder)

Protected constructor. Create this AuthAPI by using its AuthAPI.Builder.

Parameters:

builder - The builder to use.

Method Detail

newBuilder

public static AuthAPI.Conf<?> newBuilder(TokenAPIHandler tokenAPIHandler)

Get a AuthAPI.Builder for AuthAPI.

Parameters:

tokenAPIHandler - The API handler for this websocket.

Returns:

The AuthAPI.Builder for AuthAPI.

getMeAccountCommand

public AuthAPI.GetMeAccountCommand getMeAccountCommand()

get account information about current token

API GET /api/auth/[version]/me/account

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

getMeAvatarCommand

public AuthAPI.GetMeAvatarCommand getMeAvatarCommand()

get avatar of current token's account

API GET /api/auth/[version]/me/avatar

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

putMeAvatarCommand

public AuthAPI.PutMeAvatarCommand putMeAvatarCommand(StreamContainer streamContainer)

set avatar of current token's account

API PUT /api/auth/[version]/me/avatar

Parameters:

streamContainer - The existing StreamContainer. Must not be null.

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

putMeAvatarCommand

public AuthAPI.PutMeAvatarCommand putMeAvatarCommand(java.io.InputStream inputStream)

set avatar of current token's account

API PUT /api/auth/[version]/me/avatar

Parameters:

inputStream - The inputStream for the request body. Must not be null.

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

putMePasswordCommand

public AuthAPI.PutMePasswordCommand putMePasswordCommand()

change password of current token's account

API PUT /api/auth/[version]/me/password

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

getMeProfileCommand

public AuthAPI.GetMeProfileCommand getMeProfileCommand()

get profile of current token's account

API GET /api/auth/[version]/me/profile

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

postMeProfileCommand

public AuthAPI.PostMeProfileCommand postMeProfileCommand()

change profile of current token's account

API POST /api/auth/[version]/me/profile

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

getMeRolesCommand

public AuthAPI.GetMeRolesCommand getMeRolesCommand()

get roles connected to of current token teams

API GET /api/auth/[version]/me/roles

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation

getMeTeamsCommand

public AuthAPI.GetMeTeamsCommand getMeTeamsCommand()

gets the teams connected to current token

API GET /api/auth/[version]/me/teams

Returns:

New instance of the command. Use method "execute()" after all parameters have been set to run the command.

See Also:

API Documentation