Uses of Class
co.arago.hiro.client.exceptions.HiroException

Packages that use HiroException

Package	Description
co.arago.hiro.client.connection
co.arago.hiro.client.connection.token
co.arago.hiro.client.exceptions
co.arago.hiro.client.model
co.arago.hiro.client.rest
co.arago.hiro.client.util.httpclient
co.arago.hiro.client.websocket

Uses of HiroException in co.arago.hiro.client.connection

Methods in co.arago.hiro.client.connection that throw HiroException

Modifier and Type	Method	Description
abstract void	AbstractAPIHandler.addToHeaders(HttpHeaderMap headers)	Override this to add authentication tokens.
boolean	AbstractAPIHandler.checkResponse(java.net.http.HttpResponse<java.io.InputStream> httpResponse, int retryCount)	The default way to check responses for errors and extract error messages.
<T extends HiroMessage> T	AbstractAPIHandler.delete(java.lang.Class<T> clazz, java.net.URI uri, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic DELETE method which returns a Map constructed via a JSON body httpResponse.
java.util.concurrent.CompletableFuture<HttpResponseParser>	AbstractAPIHandler.executeAsyncWithStreamBody(java.net.URI uri, java.lang.String method, StreamContainer bodyContainer, HttpHeaderMap headers, java.lang.Long httpRequestTimeout)	Method to communicate asynchronously via InputStreams.
java.util.concurrent.CompletableFuture<HttpResponseParser>	AbstractAPIHandler.executeAsyncWithStringBody(java.net.URI uri, java.lang.String method, java.lang.String body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout)	Method to communicate asynchronously via String body.
HttpResponseParser	AbstractAPIHandler.executeBinary(java.net.URI uri, java.lang.String method, StreamContainer bodyContainer, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Method to communicate via InputStreams.
<T extends HiroMessage> T	AbstractAPIHandler.executeWithStreamBody(java.lang.Class<T> clazz, java.net.URI uri, java.lang.String method, StreamContainer bodyContainer, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic method which returns an object of type HiroMessage constructed via a JSON body httpResponse.
<T extends HiroMessage> T	AbstractAPIHandler.executeWithStringBody(java.lang.Class<T> clazz, java.net.URI uri, java.lang.String method, java.lang.String body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic method which returns an object of type HiroMessage constructed via a JSON body httpResponse.
<T extends HiroMessage> T	AbstractAPIHandler.get(java.lang.Class<T> clazz, java.net.URI uri, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic GET method which returns a Map constructed via a JSON body httpResponse.
java.net.URI	AbstractVersionAPIHandler.getApiURIOf(java.lang.String apiName)	Determine the API URI path for a named API.
HttpResponseParser	AbstractAPIHandler.getBinary(java.net.URI uri, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic GET method which returns an InputStream from the body of the httpResponse.
java.net.http.HttpRequest.Builder	AbstractAPIHandler.getRequestBuilder(java.net.URI uri, HttpHeaderMap headers, java.lang.Long httpRequestTimeout)	Create a HttpRequest.Builder with common options and headers.
VersionResponse	AbstractVersionAPIHandler.getVersionMap()	Returns the current AbstractVersionAPIHandler.versionMap.
<T extends HiroMessage> T	AbstractAPIHandler.patch(java.lang.Class<T> clazz, java.net.URI uri, java.lang.String body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic PATCH method which returns a Map constructed via a JSON body httpResponse.
<T extends HiroMessage> T	AbstractAPIHandler.patchBinary(java.lang.Class<T> clazz, java.net.URI uri, StreamContainer body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic PATCH method which sends an InputStream.
<T extends HiroMessage> T	AbstractAPIHandler.post(java.lang.Class<T> clazz, java.net.URI uri, java.lang.String body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic POST method which returns a Map constructed via a JSON body httpResponse.
<T extends HiroMessage> T	AbstractAPIHandler.postBinary(java.lang.Class<T> clazz, java.net.URI uri, StreamContainer body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic POST method which sends an InputStream.
<T extends HiroMessage> T	AbstractAPIHandler.put(java.lang.Class<T> clazz, java.net.URI uri, java.lang.String body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic PUT method which returns a Map constructed via a JSON body httpResponse.
<T extends HiroMessage> T	AbstractAPIHandler.putBinary(java.lang.Class<T> clazz, java.net.URI uri, StreamContainer body, HttpHeaderMap headers, java.lang.Long httpRequestTimeout, java.lang.Integer maxRetries)	Basic PUT method which sends an InputStream.
protected VersionResponse	AbstractVersionAPIHandler.requestVersionMap()	Get API Versions
java.net.http.HttpResponse<java.io.InputStream>	AbstractAPIHandler.send(java.net.http.HttpRequest httpRequest, java.lang.Integer maxRetries)	Send a HttpRequest synchronously and return the httpResponse

Uses of HiroException in co.arago.hiro.client.connection.token

Methods in co.arago.hiro.client.connection.token that throw HiroException

Modifier and Type	Method	Description
boolean	AbstractRemoteAuthTokenAPIHandler.checkResponse(java.net.http.HttpResponse<java.io.InputStream> httpResponse, int retryCount)	Check for the kind of error.
boolean	TokenAPIHandler.checkResponse(java.net.http.HttpResponse<java.io.InputStream> httpResponse, int retryCount)	The default way to check responses for errors and extract error messages.
DecodedToken	AbstractTokenAPIHandler.decodeToken()	Decode the payload part of the internal token.
DecodedToken	TokenAPIHandler.decodeToken()	Decode the payload part of the internal token.
static DecodedToken	TokenAPIHandler.decodeToken(java.lang.String token)	Decode the payload part of any token.
java.net.URI	TokenAPIHandler.getApiURIOf(java.lang.String apiName)	Determine the API URI path for a named API.
java.net.URI	CodeFlowAuthTokenAPIHandler.getAuthorizeURI()	Generate a URI for a browser to use for the authorization call.
java.lang.String	AbstractRemoteAuthTokenAPIHandler.getToken()	Return the current token.
java.lang.String	TokenAPIHandler.getToken()	Return the current token.
java.net.URI	AbstractRemoteAuthTokenAPIHandler.getURI(java.lang.String path)	Construct my URI.
VersionResponse	TokenAPIHandler.getVersionMap()	Returns the current versionMap.
void	AbstractRemoteAuthTokenAPIHandler.refreshToken()	Refresh an invalid token.
void	AbstractRemoteAuthTokenAPIHandler.refreshToken(java.lang.String organization, java.lang.String organizationId)	Refresh an invalid token.
void	CodeFlowAuthTokenAPIHandler.refreshToken()	Refresh an invalid token.
void	EnvironmentTokenAPIHandler.refreshToken()	Refresh an invalid token.
void	FixedTokenAPIHandler.refreshToken()	Refresh an invalid token.
void	TokenAPIHandler.refreshToken()	Refresh an invalid token.
protected abstract void	AbstractRemoteAuthTokenAPIHandler.requestToken(java.lang.String organization, java.lang.String organizationId)	Obtain a new token from the auth API.
protected void	CodeFlowAuthTokenAPIHandler.requestToken(java.lang.String organization, java.lang.String organizationId)	Obtain a new token from the auth API.
protected void	PasswordAuthTokenAPIHandler.requestToken(java.lang.String organization, java.lang.String organizationId)	Obtain a new token from the auth API.
void	AbstractRemoteAuthTokenAPIHandler.revokeToken()	Revoke a token.
void	AbstractRemoteAuthTokenAPIHandler.revokeToken(java.lang.String tokenHint)	Revoke a token.
void	EnvironmentTokenAPIHandler.revokeToken()	Revoke a token
void	FixedTokenAPIHandler.revokeToken()	Revoke a token
void	TokenAPIHandler.revokeToken()	Revoke a token

Uses of HiroException in co.arago.hiro.client.exceptions

Subclasses of HiroException in co.arago.hiro.client.exceptions

Modifier and Type	Class	Description
class	AuthenticationTokenException	An exception with authentication for HIRO
class	FixedTokenException	Used when tokens are fixed and cannot be refreshed.
class	HiroHttpException	a base exception for HIRO, contains an error code
class	RefreshTokenWebSocketException	Used when tokens expire with error 401.
class	RetryException	Exception to signal a connection retry
class	TokenUnauthorizedException	Used when tokens expire with error 401.
class	UnauthorizedWebSocketException	Used when tokens expire with error 401.
class	WebSocketException	Generic Exception for WebSockets
class	WebSocketMessageException	A base exception for WebSockets.

Uses of HiroException in co.arago.hiro.client.model

Methods in co.arago.hiro.client.model that throw HiroException

Modifier and Type	Method	Description
VersionResponse.VersionEntry	VersionResponse.getVersionEntryOf(java.lang.String apiName)

Uses of HiroException in co.arago.hiro.client.rest

Methods in co.arago.hiro.client.rest that throw HiroException

Modifier and Type	Method	Description
void	AuthenticatedAPIHandler.addToHeaders(HttpHeaderMap headers)	Add Authorization.
boolean	AuthenticatedAPIHandler.checkResponse(java.net.http.HttpResponse<java.io.InputStream> httpResponse, int retryCount)	Checks for TokenUnauthorizedException and HiroHttpException until AbstractAPIHandler.getMaxRetries() is exhausted.
HiroVertexMessage	AppAPI.GetApplicationCommand.execute()
HiroMessage	AppAPI.GetConfigCommand.execute()
HttpResponseParser	AppAPI.GetContentCommand.execute()
HiroVertexListMessage	AppAPI.GetDesktopApplicationsCommand.execute()
HiroMessage	AppAPI.GetManifestCommand.execute()
HiroVertexMessage	AuthAPI.GetMeAccountCommand.execute()
HttpResponseParser	AuthAPI.GetMeAvatarCommand.execute()
HiroVertexMessage	AuthAPI.GetMeProfileCommand.execute()
HiroMessage	AuthAPI.GetMeRolesCommand.execute()
HiroVertexListMessage	AuthAPI.GetMeTeamsCommand.execute()
HiroVertexMessage	AuthAPI.PostMeProfileCommand.execute()
java.lang.String	AuthAPI.PutMeAvatarCommand.execute()
HiroVertexMessage	AuthAPI.PutMePasswordCommand.execute()
abstract R	AuthenticatedAPIHandler.APIRequestConf.execute()
HiroVertexMessage	GraphAPI.CreateEntityCommand.execute()
HiroVertexMessage	GraphAPI.DeleteEntityCommand.execute()
HttpResponseParser	GraphAPI.GetBlobCommand.execute()
HiroVertexMessage	GraphAPI.GetEntityCommand.execute()
DefaultHiroItemListMessage	GraphAPI.GetHistoryCommand.execute()
HiroTimeseriesListMessage	GraphAPI.GetTimeseriesCommand.execute()
HiroMessage	GraphAPI.GetTimeseriesHistoryCommand.execute()
HiroMessage	GraphAPI.PostBlobCommand.execute()
HiroMessage	GraphAPI.PostTimeseriesCommand.execute()
HiroVertexMessage	GraphAPI.PostVerbCommand.execute()
HiroVertexListMessage	GraphAPI.QueryByIdsCommand.execute()
HiroVertexListMessage	GraphAPI.QueryByXidCommand.execute()
HiroVertexListMessage	GraphAPI.QueryGremlinCommand.execute()
HiroVertexListMessage	GraphAPI.QueryTimeseriesCommand.execute()
HiroVertexListMessage	GraphAPI.QueryVerticesCommand.execute()
HiroVertexMessage	GraphAPI.UpdateEntityCommand.execute()
java.net.URI	AuthenticatedAPIHandler.getEndpointURI(URIPath path, URIEncodedData query, java.lang.String fragment)	Construct my URI with query parameters and fragment.

Uses of HiroException in co.arago.hiro.client.util.httpclient

Methods in co.arago.hiro.client.util.httpclient that throw HiroException

Modifier and Type	Method	Description
<T extends HiroMessage> T	HttpResponseParser.createResponseObject(java.lang.Class<T> clazz)	Convert the response into an object.

Uses of HiroException in co.arago.hiro.client.websocket

Methods in co.arago.hiro.client.websocket that throw HiroException

Modifier and Type	Method	Description
void	EventWebSocket.addEventsFilter(EventsFilter filter)
void	EventWebSocket.clearEventsFilter()
protected void	AuthenticatedWebSocketHandler.createWebSocket()	Create new WebSocket.
void	ActionWebSocket.InternalActionListener.onMessage(java.net.http.WebSocket webSocket, HiroMessage message)	Handle incoming action messages.
void	EventWebSocket.removeEventsFilter(java.lang.String filterId)
protected void	AuthenticatedWebSocketHandler.restartWebSocket(boolean refreshToken)	Restarts the websocket by closing the old and creating a new one.
void	AuthenticatedWebSocketHandler.send(java.lang.String message)	Send a message across the websocket.
void	ActionWebSocket.sendActionResult(java.lang.String id, ActionWebSocket.ResultParams resultParams)	Send an ActionHandlerResult using the provided id and a ResultParams structure.
void	ActionWebSocket.sendActionResult(java.lang.String id, java.lang.String result)	Send an ActionHandlerResult using the provided id and result string.
void	AuthenticatedWebSocketHandler.start()
void	EventWebSocket.subscribeScope(java.lang.String scopeId)