org.hawkular.cmdgw.api

Class ResourcePathResponse

java.lang.Object

org.hawkular.bus.common.AbstractMessage

org.hawkular.cmdgw.api.AuthMessage

org.hawkular.cmdgw.api.ResourcePathResponse

All Implemented Interfaces:

BasicMessage, FailOnUnknownProperties, UiSessionDestination

Direct Known Subclasses:

AddDatasourceResponse, AddJdbcDriverResponse, DeployApplicationResponse, DisableApplicationResponse, EnableApplicationResponse, ExecuteOperationResponse, ExportJdrResponse, RemoveDatasourceResponse, RemoveJdbcDriverResponse, RestartApplicationResponse, StatisticsControlResponse, UndeployApplicationResponse, UpdateDatasourceResponse

@Generated(value="org.jsonschema2pojo")
public class ResourcePathResponse
extends AuthMessage
implements UiSessionDestination

Results of a Resource related operation. The awkward name of the schema file A2ResourcePathResponse.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
ResourcePathResponse()

Method Summary

Modifier and Type	Method and Description
String	getDestinationSessionId() The ID of a WebSocket Session that is the destination of this message.
String	getMessage() A message that further describes the results of the operation.
String	getResourcePath() The inventory path to the resource that was targeted by the request.
String	getSenderRequestId() An ID chosen originally by the sending UI client that should make it possible to associate this response with the triggering request.
ServerRefreshIndicator	getServerRefreshIndicator() If the server needs to be refreshed in order to fully apply recent changes, this tells you what needs to be done.
ResponseStatus	getStatus() A status of a response
void	setDestinationSessionId(String destinationSessionId) The ID of a WebSocket Session that is the destination of this message.
void	setMessage(String message) A message that further describes the results of the operation.
void	setResourcePath(String resourcePath) The inventory path to the resource that was targeted by the request.
void	setSenderRequestId(String senderRequestId) An ID chosen originally by the sending UI client that should make it possible to associate this response with the triggering request.
void	setServerRefreshIndicator(ServerRefreshIndicator serverRefreshIndicator) If the server needs to be refreshed in order to fully apply recent changes, this tells you what needs to be done.
void	setStatus(ResponseStatus status) A status of a response

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

ResourcePathResponse

public ResourcePathResponse()

Method Detail

getResourcePath

public String getResourcePath()

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

Returns:

The resourcePath

setResourcePath

public void setResourcePath(String resourcePath)

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

Parameters:

resourcePath - The resourcePath

getSenderRequestId

public String getSenderRequestId()

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

Specified by:

getSenderRequestId in interface UiSessionDestination

Returns:

The senderRequestId

setSenderRequestId

public void setSenderRequestId(String senderRequestId)

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

Specified by:

setSenderRequestId in interface UiSessionDestination

Parameters:

senderRequestId - The senderRequestId

getDestinationSessionId

public String getDestinationSessionId()

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

Specified by:

getDestinationSessionId in interface UiSessionDestination

Returns:

The destinationSessionId

setDestinationSessionId

public void setDestinationSessionId(String destinationSessionId)

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

Specified by:

setDestinationSessionId in interface UiSessionDestination

Parameters:

destinationSessionId - The destinationSessionId

getStatus

public ResponseStatus getStatus()

A status of a response

Returns:

The status

setStatus

public void setStatus(ResponseStatus status)

A status of a response

Parameters:

status - The status

getMessage

public String getMessage()

A message that further describes the results of the operation.

Returns:

The message

setMessage

public void setMessage(String message)

A message that further describes the results of the operation.

Parameters:

message - The message

getServerRefreshIndicator

public ServerRefreshIndicator getServerRefreshIndicator()

If the server needs to be refreshed in order to fully apply recent changes, this tells you what needs to be done. This is helpful when an operation or attribute change requires a reload or restart of the server.

Returns:

The serverRefreshIndicator

setServerRefreshIndicator

public void setServerRefreshIndicator(ServerRefreshIndicator serverRefreshIndicator)

If the server needs to be refreshed in order to fully apply recent changes, this tells you what needs to be done. This is helpful when an operation or attribute change requires a reload or restart of the server.

Parameters:

serverRefreshIndicator - The serverRefreshIndicator