org.openhubframework.openhub.api.entity

Class Response

java.lang.Object

org.openhubframework.openhub.api.entity.Response

All Implemented Interfaces:

HumanReadable

@Entity
public class Response
extends Object
implements HumanReadable

Entity for saving response from external system or during internal communication.

Since:

0.4

Author:

Petr Juza

See Also:

Request

Constructor Summary

Constructors

Constructor and Description
Response() Default public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Response	createResponse(Request request, String response, String failedReason, Message msg) Creates a new response.
boolean	equals(Object obj)
String	getFailedReason() Gets reason (SOAP fault, exception, stackTrace, ...) why communication failed.
Long	getId() Gets unique response ID.
Message	getMessage() Gets asynch.
Request	getRequest() Gets corresponding request to this response.
String	getResponse() Gets response.
Date	getResTimestamp() Gets timestamp when response/failed reason was received back.
int	hashCode()
boolean	isFailed() Has been communication failed? If failed then failed reason must be specified.
void	setFailed(boolean failed)
void	setFailedReason(String failedReason)
void	setId(Long id)
void	setMessage(Message message)
void	setRequest(Request request)
void	setResponse(String response)
void	setResTimestamp(Date resTimestamp)
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Response

public Response()

Default public constructor.

Method Detail

createResponse

public static Response createResponse(@Nullable
                      Request request,
                      @Nullable
                      String response,
                      @Nullable
                      String failedReason,
                      @Nullable
                      Message msg)

Creates a new response.

Parameters:

request - the corresponding request to this response; sometimes can happen that it's not possible to find request and even so it's good to save response

response - the response (response or failed reason must not be empty)

failedReason - the failed reason (response or failed reason must not be empty)

msg - the asynchronous message

Returns:

response entity

getId

public Long getId()

Gets unique response ID.

Returns:

unique ID

setId

public void setId(Long id)

getRequest

@Nullable
public Request getRequest()

Gets corresponding request to this response.

Returns:

request

setRequest

public void setRequest(@Nullable
              Request request)

getResponse

@Nullable
public String getResponse()

Gets response. If not specified then getFailedReason() must be filled.

Returns:

response

setResponse

public void setResponse(@Nullable
               String response)

getFailedReason

@Nullable
public String getFailedReason()

Gets reason (SOAP fault, exception, stackTrace, ...) why communication failed.

Returns:

failed reason

setFailedReason

public void setFailedReason(@Nullable
                   String failedReason)

getResTimestamp

public Date getResTimestamp()

Gets timestamp when response/failed reason was received back.

Returns:

timestamp

setResTimestamp

public void setResTimestamp(Date resTimestamp)

isFailed

public boolean isFailed()

Has been communication failed? If failed then failed reason must be specified.

Returns:

true if yes otherwise false

setFailed

public void setFailed(boolean failed)

getMessage

@Nullable
public Message getMessage()

Gets asynch. message.

Returns:

message

setMessage

public void setMessage(@Nullable
              Message message)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toHumanString

public String toHumanString()

Description copied from interface: HumanReadable

Returns human readable entity identification with start and end round brackets.

Specified by:

toHumanString in interface HumanReadable

Returns:

entity identification