org.hawkular.cmdgw.api

Class ResourcePathRequest

java.lang.Object

org.hawkular.bus.common.AbstractMessage

org.hawkular.cmdgw.api.AuthMessage

org.hawkular.cmdgw.api.ResourcePathRequest

All Implemented Interfaces:

BasicMessage, FailOnUnknownProperties, ResourcePathDestination, UiSessionOrigin

Direct Known Subclasses:

AddDatasourceRequest, AddJdbcDriverRequest, DeployApplicationRequest, DisableApplicationRequest, EnableApplicationRequest, ExecuteOperationRequest, ExportJdrRequest, RemoveDatasourceRequest, RemoveJdbcDriverRequest, RestartApplicationRequest, StatisticsControlRequest, UndeployApplicationRequest, UpdateCollectionIntervalsRequest

@Generated(value="org.jsonschema2pojo")
public class ResourcePathRequest
extends AuthMessage
implements ResourcePathDestination, UiSessionOrigin

A request targeting a resource given by the resourcePath field. The awkward name of the schema file A1ResourcePathRequest.schema.json is there so that this schema file precedes all other schema files alphabetically. This is required by jsonschema2pojo-maven-plugin that is not resolving the inter-schema dependencies, it just takes files in alphabetical order.

Constructor Summary

Constructors

Constructor and Description
ResourcePathRequest()

Method Summary

Modifier and Type	Method and Description
String	getResourcePath() The inventory path to the resource that is targeted by this request.
String	getSenderRequestId() An ID chosen by the sending UI client that should make it possible to associate future responses with this request.
String	getSenderSessionId() UI clients do not need to set this, the server will overwrite this field based on the ID of the present WebSocket session ID.
void	setResourcePath(String resourcePath) The inventory path to the resource that is targeted by this request.
void	setSenderRequestId(String senderRequestId) An ID chosen by the sending UI client that should make it possible to associate future responses with this request.
void	setSenderSessionId(String senderSessionId) UI clients do not need to set this, the server will overwrite this field based on the ID of the present WebSocket session ID.

Methods inherited from class org.hawkular.cmdgw.api.AuthMessage

getAuthentication, setAuthentication

Methods inherited from class org.hawkular.bus.common.AbstractMessage

buildObjectMapperForDeserialization, buildObjectMapperForSerialization, fromJSON, fromJSON, getCorrelationId, getHeaders, getMessageId, setCorrelationId, setHeaders, setMessageId, toJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.bus.common.BasicMessage

getCorrelationId, getHeaders, getMessageId, setCorrelationId, setHeaders, setMessageId, toJSON

Constructor Detail

ResourcePathRequest

public ResourcePathRequest()

Method Detail

getResourcePath

public String getResourcePath()

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

Specified by:

getResourcePath in interface ResourcePathDestination

Returns:

The resourcePath

setResourcePath

public void setResourcePath(String resourcePath)

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

Parameters:

resourcePath - The resourcePath

getSenderRequestId

public String getSenderRequestId()

An ID chosen by the sending UI client that should make it possible to associate future responses with this request. This ID is supposed to be unique just within the current WebSocket session.

Specified by:

getSenderRequestId in interface UiSessionOrigin

Returns:

The senderRequestId

setSenderRequestId

public void setSenderRequestId(String senderRequestId)

An ID chosen by the sending UI client that should make it possible to associate future responses with this request. This ID is supposed to be unique just within the current WebSocket session.

Parameters:

senderRequestId - The senderRequestId

getSenderSessionId

public String getSenderSessionId()

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

Specified by:

getSenderSessionId in interface UiSessionOrigin

Returns:

The senderSessionId

setSenderSessionId

public void setSenderSessionId(String senderSessionId)

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

Specified by:

setSenderSessionId in interface UiSessionOrigin

Parameters:

senderSessionId - The senderSessionId