org.openhubframework.openhub.api.entity

Class Response

java.lang.Object

org.openhubframework.openhub.api.entity.SuperEntity<Long>

org.openhubframework.openhub.api.entity.Response

All Implemented Interfaces:

Serializable, HumanReadable, Identifiable<Long>

@Entity
public class Response
extends SuperEntity<Long>

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

Since:

0.4

Author:

Petr Juza

See Also:

Request, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Response()

Method Summary

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) Two entities are equal if their ID is equal.
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.
Instant	getResTimestamp() Gets timestamp when response/failed reason was received back.
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) Sets unique identifier of the entity.
void	setMessage(Message message)
void	setRequest(Request request)
void	setResponse(String response)
void	setResTimestamp(Instant resTimestamp)
String	toHumanString() Returns human readable entity identification with start and end round brackets.
String	toString()

Methods inherited from class org.openhubframework.openhub.api.entity.SuperEntity

hashCode, isNew

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response()

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.

Specified by:

getId in interface Identifiable<Long>

Overrides:

getId in class SuperEntity<Long>

Returns:

unique ID

setId

public void setId(Long id)

Description copied from interface: Identifiable

Sets unique identifier of the entity.

Specified by:

setId in interface Identifiable<Long>

Overrides:

setId in class SuperEntity<Long>

Parameters:

id - unique identifier

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 Instant getResTimestamp()

Gets timestamp when response/failed reason was received back.

Returns:

timestamp

setResTimestamp

public void setResTimestamp(Instant 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)

Description copied from class: SuperEntity

Two entities are equal if their ID is equal.

Overrides:

equals in class SuperEntity<Long>

toString

public String toString()

Overrides:

toString in class SuperEntity<Long>

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

Overrides:

toHumanString in class SuperEntity<Long>

Returns:

entity identification