org.openhubframework.openhub.api.entity

Class Request

java.lang.Object

org.openhubframework.openhub.api.entity.Request

All Implemented Interfaces:

HumanReadable

@Entity
public class Request
extends Object
implements HumanReadable

Entity for saving request with external system or during internal communication.

Request is uniquely identified by its URI and response join ID. Both these attributes helps to join right request and response together.

Since:

0.4

Author:

Petr Juza

See Also:

Response

Constructor Summary

Constructors

Constructor and Description
Request() Default public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Request	createRequest(String uri, String responseJoinId, String request, Message msg) Creates a new request.
boolean	equals(Object obj)
Long	getId() Gets unique request ID.
Message	getMessage() Gets asynch.
Long	getMsgId() Gets message ID (only for asynchronous message).
String	getNormalizedUri() Gets normalized endpoint/target URI.
Date	getReqTimestamp() Gets timestamp when request was send to target URI.
String	getRequest() Gets request content.
Response	getResponse() Gets response to this request.
String	getResponseJoinId() Gets identifier for pairing/joining request and response together.
String	getUri() Gets endpoint/target URI.
int	hashCode()
void	setId(Long id)
void	setMessage(Message message)
void	setMsgId(Long msgId)
void	setReqTimestamp(Date reqTimestamp)
void	setRequest(String request)
void	setResponseJoinId(String responseJoinId) Sets identifier for pairing/joining request and response together.
void	setUri(String uri)
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

Request

public Request()

Default public constructor.

Method Detail

createRequest

public static Request createRequest(String uri,
                    String responseJoinId,
                    String request,
                    @Nullable
                    Message msg)

Creates a new request.

Parameters:

uri - the target URI

responseJoinId - the identifier for pairing/joining request and response together

request - the request (envelope) itself

msg - the message

Returns:

request entity

getId

public Long getId()

Gets unique request ID.

Returns:

unique ID

setId

public void setId(Long id)

getMessage

@Nullable
public Message getMessage()

Gets asynch. message.

Returns:

message

setMessage

public void setMessage(@Nullable
              Message message)

getMsgId

@Nullable
public Long getMsgId()

Gets message ID (only for asynchronous message).

Returns:

message ID

setMsgId

public void setMsgId(@Nullable
            Long msgId)

getResponseJoinId

public String getResponseJoinId()

Gets identifier for pairing/joining request and response together. It can be Message or correlation ID or exchange ID or some ID that is unique with getUri() uri. This attribute helps to associate response to the right request.

Returns:

response join ID

setResponseJoinId

public void setResponseJoinId(String responseJoinId)

Sets identifier for pairing/joining request and response together.

Parameters:

responseJoinId - response join ID

getUri

public String getUri()

Gets endpoint/target URI.

Returns:

URI

setUri

public void setUri(String uri)

getNormalizedUri

public String getNormalizedUri()

Gets normalized endpoint/target URI.

Returns:

URI

getRequest

public String getRequest()

Gets request content.

Returns:

request

setRequest

public void setRequest(String request)

getReqTimestamp

public Date getReqTimestamp()

Gets timestamp when request was send to target URI.

Returns:

timestamp

setReqTimestamp

public void setReqTimestamp(Date reqTimestamp)

getResponse

@Nullable
public Response getResponse()

Gets response to this request.

Returns:

the response

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