All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AbstractActionHandlerIdMessage |
|
| AbstractAPIHandler |
Root class with fields and tool methods for all API Handlers
|
| AbstractAPIHandler.Conf<T extends AbstractAPIHandler.Conf<T>> |
The basic configuration for all APIHAndler.
|
| AbstractRemoteAuthTokenAPIHandler |
|
| AbstractRemoteAuthTokenAPIHandler.Conf<T extends AbstractRemoteAuthTokenAPIHandler.Conf<T>> |
|
| AbstractRemoteAuthTokenAPIHandler.TokenInfo |
Extends the TokenResponse with additional data and operations.
|
| AbstractTokenAPIHandler |
|
| AbstractTokenAPIHandler.Conf<T extends AbstractTokenAPIHandler.Conf<T>> |
|
| AbstractTokenRequest |
JSON for a token request.
|
| AbstractVersionAPIHandler |
Handles Version information for HIRO.
|
| AbstractVersionAPIHandler.Conf<T extends AbstractVersionAPIHandler.Conf<T>> |
|
| ActionHandlerAck |
{
"type": "acknowledged",
"id": "id1",
"code": 200,
"message: "..."
}
|
| ActionHandlerCodeMessage |
|
| ActionHandlerConfigChanged |
{
"type": "configChanged"
}
|
| ActionHandlerError |
{
"type": "error",
"code": 400,
"message: "bad request"
}
|
| ActionHandlerIdMessage |
|
| ActionHandlerMessage |
|
| ActionHandlerNack |
{
"type": "negativeAcknowledged",
"id": "id1",
"code": 400,
"message: "bad request"
}
|
| ActionHandlerResult |
{
"type": "sendActionResult",
"id": "id1",
"result": "..."
}
|
| ActionHandlerSubmit |
{
"type": "submitAction",
"id": "id1",
"handler": "handlerId",
"capability": "ExecuteCommand",
"parameters": {},
"timeout": 30000
}
|
| ActionMessageType |
Possible message types for action handler messages
|
| ActionWebSocket |
The handler for Action WebSocket.
|
| ActionWebSocket.Builder |
|
| ActionWebSocket.Conf<T extends ActionWebSocket.Conf<T>> |
|
| ActionWebSocket.ResultParams |
|
| ActionWebSocketListener |
|
| AppAPI |
|
| AppAPI.Builder |
|
| AppAPI.Conf<T extends AppAPI.Conf<T>> |
|
| AuthAPI |
|
| AuthAPI.Builder |
|
| AuthAPI.Conf<T extends AuthAPI.Conf<T>> |
|
| AuthenticatedAPIHandler |
This class is the basis of all authenticated API handlers that make use of the different sections of the HIRO API.
|
| AuthenticatedAPIHandler.APIRequestConf<T extends AuthenticatedAPIHandler.APIRequestConf<T,R>,R> |
The basic configuration for all requests.
|
| AuthenticatedAPIHandler.Conf<T extends AuthenticatedAPIHandler.Conf<T>> |
Configuration interface for all the parameters of an AuthenticatedAPIHandler.
|
| AuthenticatedAPIHandler.SendBodyAPIRequestConf<T extends AuthenticatedAPIHandler.SendBodyAPIRequestConf<T,R>,R> |
The basic configuration for all requests that are sending JSON data.
|
| AuthenticatedAPIHandler.SendStreamAPIRequestConf<T extends AuthenticatedAPIHandler.SendStreamAPIRequestConf<T,R>,R> |
The basic configuration for all requests that upload binary data.
|
| AuthenticatedWebSocketHandler |
Handles websockets.
|
| AuthenticatedWebSocketHandler.Conf<T extends AuthenticatedWebSocketHandler.Conf<T>> |
Configuration interface for all the parameters of an AuthenticatedAPIHandler.
|
| AuthenticatedWebSocketHandler.Status |
|
| AuthenticationTokenException |
An exception with authentication for HIRO
|
| AuthorizeRequest |
|
| ClearEventsMessage |
{
"type": "clear",
"args": {
}
}
|
| CodeFlowAuthTokenAPIHandler |
|
| CodeFlowAuthTokenAPIHandler.Builder |
|
| CodeFlowAuthTokenAPIHandler.Conf<T extends CodeFlowAuthTokenAPIHandler.Conf<T>> |
|
| CodeFlowTokenRequest |
JSON for a token request.
|
| ContentHeaderHandler |
Decodes / Encodes the headers Content-Type and Content-Length.
|
| DecodedToken |
Data structure of the encoded JSON payload of a HIRO token
|
| DecodedToken.Data |
|
| DefaultHiroItemListMessage |
Represents a HIRO list of items.
|
| DefaultHttpClientHandler |
Class for API httpRequests that contains a HttpClient and a HttpLogger.
|
| DefaultHttpClientHandler.Builder |
|
| DefaultHttpClientHandler.Conf<T extends DefaultHttpClientHandler.Conf<T>> |
|
| DefaultHttpClientHandler.DefaultProxySpec |
A simple data class for a proxy
|
| EncodedURIMessage |
This interface defines a default method to create an EncodedForm String from this object.
|
| EnvironmentTokenAPIHandler |
|
| EnvironmentTokenAPIHandler.Builder |
|
| EnvironmentTokenAPIHandler.Conf<T extends EnvironmentTokenAPIHandler.Conf<T>> |
|
| EventRegisterMessage |
|
| EventsFilter |
|
| EventsMessage |
An incoming events message from the events-ws.
Example:
|
| EventUnregisterMessage |
|
| EventUnregisterMessage.FilterId |
|
| EventWebSocket |
The handler for Event WebSocket.
|
| EventWebSocket.Builder |
|
| EventWebSocket.Conf<T extends EventWebSocket.Conf<T>> |
|
| EventWebSocketListener |
|
| FixedTokenAPIHandler |
|
| FixedTokenAPIHandler.Builder |
|
| FixedTokenAPIHandler.Conf<T extends FixedTokenAPIHandler.Conf<T>> |
|
| FixedTokenException |
Used when tokens are fixed and cannot be refreshed.
|
| GraphAPI |
|
| GraphAPI.Builder |
|
| GraphAPI.Conf<T extends GraphAPI.Conf<T>> |
|
| GraphAPI.QueryBodyConf<T extends GraphAPI.QueryBodyConf<T,R>,R> |
A config class that contains common parameters for all Graph Queries.
|
| GraphConnectionHandler |
Basic connection to the HIRO Graph without any authentication.
|
| GraphConnectionHandler.Builder |
|
| GraphConnectionHandler.Conf<T extends GraphConnectionHandler.Conf<T>> |
|
| HexUtil |
|
| HiroError |
Handles error responses from HIRO of the format.
|
| HiroError.HiroErrorEntry |
|
| HiroException |
a base exception for HIRO, contains an error code
|
| HiroHttpException |
a base exception for HIRO, contains an error code
|
| HiroItemListMessage<T extends HiroJsonMap> |
Represents a HIRO list of items.
|
| HiroJsonMap |
This is a generic model class that collects all keys and values of a JSON object in HiroJsonMap.fieldsMap. |
| HiroMessage |
|
| HiroStandardListener |
|
| HiroTimeseriesListMessage |
|
| HiroTimeseriesListMessage.TimeseriesEntry |
|
| HiroVertexListMessage |
|
| HiroVertexMessage |
Contains data of a HIRO vertex.
|
| HttpClientHandler |
Interface for a class that contains a HttpClient and a HttpLogger.
|
| HttpClientHandler.ConfTemplate<T extends HttpClientHandler.ConfTemplate<T>> |
Interface for the configuration parameters of a HttpClientHandler.
|
| HttpClientHandler.ProxySpec |
|
| HttpHeaderMap |
A map for HttpHeaders.
|
| HttpLogger |
This handles logging of HttpRequests and HttpResults.
|
| HttpResponseParser |
Contains the httpResult and decodes the headers Content-Type and Content-Length for further
information about that stream.
|
| JsonMessage |
This interface defines a default method to create a JSON String from this object.
|
| MetaValueList |
Implementation of a meta value from HIRO attributes in vertices.
|
| MetaValueList.MetaValueField |
|
| MultiValueMap |
A special map that contains a string as key and a list of string as value.
|
| PasswordAuthTokenAPIHandler |
|
| PasswordAuthTokenAPIHandler.Builder |
|
| PasswordAuthTokenAPIHandler.Conf<T extends PasswordAuthTokenAPIHandler.Conf<T>> |
|
| PasswordTokenRequest |
JSON for a token request.
|
| PkceUtil |
|
| RefreshTokenWebSocketException |
Used when tokens expire with error 401.
|
| RetryException |
Exception to signal a connection retry
|
| SpecificWebSocketListener |
Interface for internal WebSocket listeners of different WebSocket protocols.
|
| StreamContainer |
Contains the inputStream for the body and decodes the headers Content-Type and Content-Length for further
information about that stream.
|
| SubscribeScopeMessage |
|
| TokenAPIHandler |
|
| TokenRefreshMessage |
|
| TokenRefreshMessage.Token |
|
| TokenRefreshRequest |
JSON for a token refresh request.
|
| TokenResponse |
The token response from the auth API
|
| TokenRevokeRequest |
JSON for a token revoke request.
Deprecated:
|
| TokenUnauthorizedException |
Used when tokens expire with error 401.
|
| ToMap |
|
| UnauthorizedWebSocketException |
Used when tokens expire with error 401.
|
| URIEncodedData |
A map for http query parameters.
|
| URIPath |
Simple builder class for URI paths.
|
| URLPartEncoder |
|
| VersionResponse |
The response to a version GET request against "/api/version".
|
| VersionResponse.VersionEntry |
|
| WebSocketException |
Generic Exception for WebSockets
|
| WebSocketMessageException |
A base exception for WebSockets.
|