A B D E F G I M N O P R S T U V W

A

AddDatasourceRequest - Class in org.hawkular.cmdgw.api

Adds a Datasource or a XA Datasource to an Application Server instance given by the inventory path stored in resourcePath field.

AddDatasourceRequest() - Constructor for class org.hawkular.cmdgw.api.AddDatasourceRequest

AddDatasourceResponse - Class in org.hawkular.cmdgw.api

Results of an Add Datasource request.

AddDatasourceResponse() - Constructor for class org.hawkular.cmdgw.api.AddDatasourceResponse

AddJdbcDriverRequest - Class in org.hawkular.cmdgw.api

Adds a JDBC Driver to an Application Server instance given by the inventory path stored in resourcePath field.

AddJdbcDriverRequest() - Constructor for class org.hawkular.cmdgw.api.AddJdbcDriverRequest

AddJdbcDriverResponse - Class in org.hawkular.cmdgw.api

Results of an Add Driver request.

AddJdbcDriverResponse() - Constructor for class org.hawkular.cmdgw.api.AddJdbcDriverResponse

ApiDeserializer - Class in org.hawkular.cmdgw.api

Given the special syntax of "apiName=JSON" this will deserialize the JSON into the appropriate API POJO.

ApiDeserializer() - Constructor for class org.hawkular.cmdgw.api.ApiDeserializer

Authentication - Class in org.hawkular.cmdgw.api

Provides user credentials or security token.

Authentication() - Constructor for class org.hawkular.cmdgw.api.Authentication

AuthMessage - Class in org.hawkular.cmdgw.api

Message properties that are needed for authentication.

AuthMessage() - Constructor for class org.hawkular.cmdgw.api.AuthMessage

B

build() - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

buildWithThrowable(Throwable) - Static method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

D

DeployApplicationRequest - Class in org.hawkular.cmdgw.api

Deploys an application to an Application Server instance given by the inventory path stored in resourcePath field.

DeployApplicationRequest() - Constructor for class org.hawkular.cmdgw.api.DeployApplicationRequest

DeployApplicationResponse - Class in org.hawkular.cmdgw.api

Results of an application deployment request.

DeployApplicationResponse() - Constructor for class org.hawkular.cmdgw.api.DeployApplicationResponse

deserialize(String) - Method in class org.hawkular.cmdgw.api.ApiDeserializer

Deserializes a JSON string in Hawkular format.

deserialize(InputStream) - Method in class org.hawkular.cmdgw.api.ApiDeserializer

Reads a JSON string in Hawkular format that is found in the given input stream and converts the JSON string to a particular message object.

E

EchoRequest - Class in org.hawkular.cmdgw.api

A simple request to echo a string back used for testing connectivity.

EchoRequest() - Constructor for class org.hawkular.cmdgw.api.EchoRequest

EchoResponse - Class in org.hawkular.cmdgw.api

An echo response where the reply should be the message from the echo request.

EchoResponse() - Constructor for class org.hawkular.cmdgw.api.EchoResponse

EventDestination - Interface in org.hawkular.cmdgw.api

Message that gets sent as an event.

ExecuteOperationRequest - Class in org.hawkular.cmdgw.api

A request to execute an operation on a resource given by the inventory path stored in resourcePath field.

ExecuteOperationRequest() - Constructor for class org.hawkular.cmdgw.api.ExecuteOperationRequest

ExecuteOperationResponse - Class in org.hawkular.cmdgw.api

A response describing the results of an operation execution.

ExecuteOperationResponse() - Constructor for class org.hawkular.cmdgw.api.ExecuteOperationResponse

ExportJdrRequest - Class in org.hawkular.cmdgw.api

Exports a JDR from the Application Server instance given by the inventory path stored in resourcePath field.

ExportJdrRequest() - Constructor for class org.hawkular.cmdgw.api.ExportJdrRequest

ExportJdrResponse - Class in org.hawkular.cmdgw.api

Results of the JDR export.

ExportJdrResponse() - Constructor for class org.hawkular.cmdgw.api.ExportJdrResponse

F

fromValue(String) - Static method in enum org.hawkular.cmdgw.api.ResponseStatus

G

GenericErrorResponse - Class in org.hawkular.cmdgw.api

An general error message.

GenericErrorResponse() - Constructor for class org.hawkular.cmdgw.api.GenericErrorResponse

GenericErrorResponseBuilder - Class in org.hawkular.cmdgw.api

GenericErrorResponseBuilder() - Constructor for class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

GenericSuccessResponse - Class in org.hawkular.cmdgw.api

An general success message.

GenericSuccessResponse() - Constructor for class org.hawkular.cmdgw.api.GenericSuccessResponse

getAuthentication() - Method in class org.hawkular.cmdgw.api.AuthMessage

Provides user credentials or security token.

getConnectionUrl() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The JDBC driver connection URL.

getDatasourceName() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The name for this datasource.

getDatasourceName() - Method in class org.hawkular.cmdgw.api.AddDatasourceResponse

The name for this datasource.

getDatasourceProperties() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.

getDestinationFileName() - Method in class org.hawkular.cmdgw.api.DeployApplicationRequest

(Required)

getDestinationFileName() - Method in class org.hawkular.cmdgw.api.DeployApplicationResponse

(Required)

getDestinationSessionId() - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

The ID of a WebSocket Session that is the destination of this message.

getDestinationSessionId() - Method in interface org.hawkular.cmdgw.api.UiSessionDestination

getDriverClass() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The fully qualified name of the JDBC driver class.

getDriverClass() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

getDriverJarName() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

The name of the jar file that should be used when storing the binary data to in the module directory on the server.

getDriverMajorVersion() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

getDriverMinorVersion() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

getDriverName() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration.

getDriverName() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

(Required)

getDriverName() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverResponse

(Required)

getEchoMessage() - Method in class org.hawkular.cmdgw.api.EchoRequest

(Required)

getEnabled() - Method in class org.hawkular.cmdgw.api.DeployApplicationRequest

If true, the deployment will be enabled immediately.

getErrorMessage() - Method in class org.hawkular.cmdgw.api.GenericErrorResponse

(Required)

getFileName() - Method in class org.hawkular.cmdgw.api.ExportJdrResponse

The report's file name to be presented to the client, based on the name generated at the server.

getJndiName() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

the JNDI name for the datasource (Required)

getMessage() - Method in class org.hawkular.cmdgw.api.GenericSuccessResponse

(Required)

getMessage() - Method in class org.hawkular.cmdgw.api.NotificationMessage

(Required)

getMessage() - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

A message that further describes the results of the operation.

getModuleName() - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

The name of the JBoss Module to create or use, such as "org.example.jdbc.driver" (Required)

getOperationName() - Method in class org.hawkular.cmdgw.api.ExecuteOperationRequest

(Required)

getOperationName() - Method in class org.hawkular.cmdgw.api.ExecuteOperationResponse

(Required)

getParameters() - Method in class org.hawkular.cmdgw.api.ExecuteOperationRequest

A simple map of named parameters.

getPassword() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The password used when creating a new connection.

getPassword() - Method in class org.hawkular.cmdgw.api.Authentication

getPersona() - Method in class org.hawkular.cmdgw.api.Authentication

getReply() - Method in class org.hawkular.cmdgw.api.EchoResponse

(Required)

getResourcePath() - Method in interface org.hawkular.cmdgw.api.ResourcePathDestination

getResourcePath() - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

The inventory path to the resource that is targeted by this request.

getResourcePath() - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

The inventory path to the resource that was targeted by the request.

getSecurityDomain() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.

getSenderRequestId() - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

An ID chosen by the sending UI client that should make it possible to associate future responses with this request.

getSenderRequestId() - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

An ID chosen originally by the sending UI client that should make it possible to associate this response with the triggering request.

getSenderRequestId() - Method in interface org.hawkular.cmdgw.api.UiSessionDestination

getSenderRequestId() - Method in interface org.hawkular.cmdgw.api.UiSessionOrigin

getSenderSessionId() - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

UI clients do not need to set this, the server will overwrite this field based on the ID of the present WebSocket session ID.

getSenderSessionId() - Method in interface org.hawkular.cmdgw.api.UiSessionOrigin

getSessionId() - Method in class org.hawkular.cmdgw.api.WelcomeResponse

The ID of a WebSocket Session that the receving client just openened.

getStackTrace() - Method in class org.hawkular.cmdgw.api.GenericErrorResponse

getStatus() - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

A status of a response

getToken() - Method in class org.hawkular.cmdgw.api.Authentication

getUserName() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The user name used when creating a new connection.

getUsername() - Method in class org.hawkular.cmdgw.api.Authentication

getXaDataSourceClass() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The fully qualified name of the javax.sql.XADataSource implementation.

I

isXaDatasource() - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

true if an XA datasource should be added, false otherwise (Required)

isXaDatasource() - Method in class org.hawkular.cmdgw.api.AddDatasourceResponse

true if an XA datasource should be added, false otherwise (Required)

M

MessageUtils - Class in org.hawkular.cmdgw.api

MessageUtils() - Constructor for class org.hawkular.cmdgw.api.MessageUtils

N

NotificationMessage - Class in org.hawkular.cmdgw.api

An general notification message.

NotificationMessage() - Constructor for class org.hawkular.cmdgw.api.NotificationMessage

O

org.hawkular.cmdgw.api - package org.hawkular.cmdgw.api

P

prepareResourcePathResponse(ResourcePathRequest, ResourcePathResponse) - Static method in class org.hawkular.cmdgw.api.MessageUtils

prepareUiSessionDestination(UiSessionOrigin, UiSessionDestination) - Static method in class org.hawkular.cmdgw.api.MessageUtils

R

RemoveDatasourceRequest - Class in org.hawkular.cmdgw.api

Unregisters a Datasource or a XA Datasource that corresponds to the resource given by the resourcePath field.

RemoveDatasourceRequest() - Constructor for class org.hawkular.cmdgw.api.RemoveDatasourceRequest

RemoveDatasourceResponse - Class in org.hawkular.cmdgw.api

Results of an RemoveDatasourceRequest.

RemoveDatasourceResponse() - Constructor for class org.hawkular.cmdgw.api.RemoveDatasourceResponse

RemoveJdbcDriverRequest - Class in org.hawkular.cmdgw.api

Unregisters a JDBC Driver that corresponds to the resource given by the resourcePath field.

RemoveJdbcDriverRequest() - Constructor for class org.hawkular.cmdgw.api.RemoveJdbcDriverRequest

RemoveJdbcDriverResponse - Class in org.hawkular.cmdgw.api

Results of an RemoveJdbcDriverRequest.

RemoveJdbcDriverResponse() - Constructor for class org.hawkular.cmdgw.api.RemoveJdbcDriverResponse

ResourcePathDestination - Interface in org.hawkular.cmdgw.api

ResourcePathRequest - Class in org.hawkular.cmdgw.api

A request targeting a resource given by the resourcePath field.

ResourcePathRequest() - Constructor for class org.hawkular.cmdgw.api.ResourcePathRequest

ResourcePathResponse - Class in org.hawkular.cmdgw.api

Results of a Resource related operation.

ResourcePathResponse() - Constructor for class org.hawkular.cmdgw.api.ResourcePathResponse

ResponseStatus - Enum in org.hawkular.cmdgw.api

S

setAuthentication(Authentication) - Method in class org.hawkular.cmdgw.api.AuthMessage

Provides user credentials or security token.

setConnectionUrl(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The JDBC driver connection URL.

setDatasourceName(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The name for this datasource.

setDatasourceName(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceResponse

The name for this datasource.

setDatasourceProperties(Map<String, String>) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

Either a list of xa-datasource-properties in case this is a XA datasource or otherwise a list of connection-properties for a non-XA datasource.

setDestinationFileName(String) - Method in class org.hawkular.cmdgw.api.DeployApplicationRequest

(Required)

setDestinationFileName(String) - Method in class org.hawkular.cmdgw.api.DeployApplicationResponse

(Required)

setDestinationSessionId(String) - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

The ID of a WebSocket Session that is the destination of this message.

setDestinationSessionId(String) - Method in interface org.hawkular.cmdgw.api.UiSessionDestination

setDriverClass(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The fully qualified name of the JDBC driver class.

setDriverClass(String) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

setDriverJarName(String) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

The name of the jar file that should be used when storing the binary data to in the module directory on the server.

setDriverMajorVersion(Integer) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

setDriverMinorVersion(Integer) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

setDriverName(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

Name of the JDBC driver as available under /subsystem=datasources/jdbc-driver=* in WildFly configuration.

setDriverName(String) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

(Required)

setDriverName(String) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverResponse

(Required)

setEchoMessage(String) - Method in class org.hawkular.cmdgw.api.EchoRequest

(Required)

setEnabled(Boolean) - Method in class org.hawkular.cmdgw.api.DeployApplicationRequest

If true, the deployment will be enabled immediately.

setErrorMessage(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponse

(Required)

setErrorMessage(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setFileName(String) - Method in class org.hawkular.cmdgw.api.ExportJdrResponse

The report's file name to be presented to the client, based on the name generated at the server.

setJndiName(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

the JNDI name for the datasource (Required)

setMessage(String) - Method in class org.hawkular.cmdgw.api.GenericSuccessResponse

(Required)

setMessage(String) - Method in class org.hawkular.cmdgw.api.NotificationMessage

(Required)

setMessage(String) - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

A message that further describes the results of the operation.

setModuleName(String) - Method in class org.hawkular.cmdgw.api.AddJdbcDriverRequest

The name of the JBoss Module to create or use, such as "org.example.jdbc.driver" (Required)

setOperationName(String) - Method in class org.hawkular.cmdgw.api.ExecuteOperationRequest

(Required)

setOperationName(String) - Method in class org.hawkular.cmdgw.api.ExecuteOperationResponse

(Required)

setParameters(Map<String, String>) - Method in class org.hawkular.cmdgw.api.ExecuteOperationRequest

A simple map of named parameters.

setPassword(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The password used when creating a new connection.

setPassword(String) - Method in class org.hawkular.cmdgw.api.Authentication

setPassword(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setPersona(String) - Method in class org.hawkular.cmdgw.api.Authentication

setPersona(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setReply(String) - Method in class org.hawkular.cmdgw.api.EchoResponse

(Required)

setResourcePath(String) - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

The inventory path to the resource that is targeted by this request.

setResourcePath(String) - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

The inventory path to the resource that was targeted by the request.

setSecurityDomain(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The security domain which defines the javax.security.auth.Subject that are used to distinguish connections in the pool.

setSenderRequestId(String) - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

An ID chosen by the sending UI client that should make it possible to associate future responses with this request.

setSenderRequestId(String) - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

An ID chosen originally by the sending UI client that should make it possible to associate this response with the triggering request.

setSenderRequestId(String) - Method in interface org.hawkular.cmdgw.api.UiSessionDestination

setSenderSessionId(String) - Method in class org.hawkular.cmdgw.api.ResourcePathRequest

UI clients do not need to set this, the server will overwrite this field based on the ID of the present WebSocket session ID.

setSenderSessionId(String) - Method in interface org.hawkular.cmdgw.api.UiSessionOrigin

setSessionId(String) - Method in class org.hawkular.cmdgw.api.WelcomeResponse

The ID of a WebSocket Session that the receving client just openened.

setStackTrace(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponse

setStackTrace(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setStatus(ResponseStatus) - Method in class org.hawkular.cmdgw.api.ResourcePathResponse

A status of a response

setThrowable(Throwable) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setToken(String) - Method in class org.hawkular.cmdgw.api.Authentication

setToken(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setUserName(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The user name used when creating a new connection.

setUsername(String) - Method in class org.hawkular.cmdgw.api.Authentication

setUsername(String) - Method in class org.hawkular.cmdgw.api.GenericErrorResponseBuilder

setXaDatasource(boolean) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

true if an XA datasource should be added, false otherwise (Required)

setXaDatasource(boolean) - Method in class org.hawkular.cmdgw.api.AddDatasourceResponse

true if an XA datasource should be added, false otherwise (Required)

setXaDataSourceClass(String) - Method in class org.hawkular.cmdgw.api.AddDatasourceRequest

The fully qualified name of the javax.sql.XADataSource implementation.

T

toHawkularFormat(BasicMessage) - Static method in class org.hawkular.cmdgw.api.ApiDeserializer

Returns a string that encodes the given object as a JSON message but then prefixes that JSON with additional information that a Hawkular client will need to be able to deserialize the JSON.

toHawkularFormat(BasicMessage, InputStream) - Static method in class org.hawkular.cmdgw.api.ApiDeserializer

Returns a BinaryData object (which is a stream) that encodes the given message just like ApiDeserializer.toHawkularFormat(BasicMessage) does but also packages the given input stream as extra data with the JSON message.

toString() - Method in enum org.hawkular.cmdgw.api.ResponseStatus

U

UiSessionDestination - Interface in org.hawkular.cmdgw.api

UiSessionOrigin - Interface in org.hawkular.cmdgw.api

UpdateDatasourceRequest - Class in org.hawkular.cmdgw.api

Updates the Datasource or a XA Datasource given by the inventory path stored in resourcePath field.

UpdateDatasourceRequest() - Constructor for class org.hawkular.cmdgw.api.UpdateDatasourceRequest

UpdateDatasourceResponse - Class in org.hawkular.cmdgw.api

Results of an UpdateDatasourceRequest.

UpdateDatasourceResponse() - Constructor for class org.hawkular.cmdgw.api.UpdateDatasourceResponse

V

valueOf(String) - Static method in enum org.hawkular.cmdgw.api.ResponseStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.hawkular.cmdgw.api.ResponseStatus

Returns an array containing the constants of this enum type, in the order they are declared.

W

WelcomeResponse - Class in org.hawkular.cmdgw.api

Tells the UI client what is his sessionId

WelcomeResponse() - Constructor for class org.hawkular.cmdgw.api.WelcomeResponse

A B D E F G I M N O P R S T U V W