Package co.arago.hiro.client.rest

Class AppAPI

java.lang.Object

co.arago.hiro.client.connection.AbstractAPIHandler

co.arago.hiro.client.rest.AuthenticatedAPIHandler

co.arago.hiro.client.rest.AppAPI

public class AppAPI
extends AuthenticatedAPIHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AppAPI.Builder
static class	AppAPI.Conf<T extends AppAPI.Conf<T>>
class	AppAPI.GetApplicationCommand	Get an application
class	AppAPI.GetConfigCommand	Get an application instance config
class	AppAPI.GetContentCommand	Get the content of an application
class	AppAPI.GetDesktopApplicationsCommand	Returns a list of all visible desktop applications
class	AppAPI.GetManifestCommand	Get a manifest of the content of an application

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	AppAPI(AppAPI.Conf<?> builder)	Protected constructor.

Method Summary

Modifier and Type	Method	Description
AppAPI.GetApplicationCommand	getApplicationCommand(java.lang.String ogitId)	Get an application
AppAPI.GetConfigCommand	getConfigCommand()	Get an application instance config
AppAPI.GetContentCommand	getContentCommand(java.lang.String ogitId, java.lang.String... path)	Get the content of an application
AppAPI.GetDesktopApplicationsCommand	getDesktopApplicationsCommand()	Returns a list of all visible desktop applications
AppAPI.GetManifestCommand	getManifestCommand(java.lang.String ogitId)	Get a manifest of the content of an application
static AppAPI.Conf<?>	newBuilder(TokenAPIHandler tokenAPIHandler)	Get a AppAPI.Builder for AppAPI.

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

AppAPI

protected AppAPI(AppAPI.Conf<?> builder)

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

Parameters:

builder - The builder to use.

Method Detail

newBuilder

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

Get a AppAPI.Builder for AppAPI.

Parameters:

tokenAPIHandler - The API handler for this websocket.

Returns:

The AppAPI.Builder for AppAPI.

getApplicationCommand

public AppAPI.GetApplicationCommand getApplicationCommand(java.lang.String ogitId)

Get an application

API GET /api/app/[version]/{ogit\_id}

Parameters:

ogitId - ogit/_id of the app.

Returns:

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

See Also:

API Documentation

getConfigCommand

public AppAPI.GetConfigCommand getConfigCommand()

Get an application instance config

API GET /api/app/[version]/config

Returns:

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

See Also:

API Documentation

getContentCommand

public AppAPI.GetContentCommand getContentCommand(java.lang.String ogitId,
                                                  java.lang.String... path)

Get the content of an application

API GET /api/app/[version]/{ogit/_id}/content/{path}

Parameters:

ogitId - ogit/_id of the app.

path - Path parts for the subcontent.

Returns:

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

See Also:

API Documentation

getManifestCommand

public AppAPI.GetManifestCommand getManifestCommand(java.lang.String ogitId)

Get a manifest of the content of an application

API GET /api/app/[version]/{ogit/_id}/manifest

Parameters:

ogitId - ogit/_id of the app.

Returns:

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

See Also:

API Documentation

getDesktopApplicationsCommand

public AppAPI.GetDesktopApplicationsCommand getDesktopApplicationsCommand()

Returns a list of all visible desktop applications

API GET /api/app/[version]/desktop

Returns:

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

See Also:

API Documentation