es.ree.eemws.client.get

Class GetMessage

java.lang.Object

es.ree.eemws.client.common.ParentClient

es.ree.eemws.client.get.GetMessage

public final class GetMessage
extends ParentClient

Retrieves the message according to the given parameters (filters).

Constructor Summary

Constructors

Constructor and Description
GetMessage() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
RetrievedMessage	get(java.math.BigInteger code) Gets the message with the given code.
RetrievedMessage	get(java.lang.Long code) Gets the message with the given code.
RetrievedMessage	get(java.util.Map<java.lang.String,java.lang.String> msgOptions) Gets the message using the given parameters.
RetrievedMessage	get(java.lang.String queue) Gets the message from the queue.
RetrievedMessage	get(java.lang.String messageIdentification, java.lang.Integer messageVersion) Gets the message with the given identification and version.
RetrievedMessage	get(java.lang.String messageIdentification, java.lang.Integer messageVersion, java.lang.Long code, java.lang.String queue) Gets the message using the given parameters.

Methods inherited from class es.ree.eemws.client.common.ParentClient

getMessageMetaData, sendMessage, setCertificate, setEndPoint, setEndPoint, setPrivateKey, setSignRequest, setVerifyResponse, validateResponse, validateResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMessage

public GetMessage()

Constructor.

Method Detail

get

public RetrievedMessage get(java.lang.String messageIdentification,
                   java.lang.Integer messageVersion)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message with the given identification and version.

Parameters:

messageIdentification - Message's identification.

messageVersion - Message's version. Can be null if no version applies.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

get

public RetrievedMessage get(java.math.BigInteger code)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message with the given code.

Parameters:

code - Message's code.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

get(Long)

get

public RetrievedMessage get(java.lang.Long code)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message with the given code.

Parameters:

code - Message's code.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

See Also:

get(BigInteger)

get

public RetrievedMessage get(java.lang.String queue)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message from the queue.

Parameters:

queue - Queue value.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

get

public RetrievedMessage get(java.util.Map<java.lang.String,java.lang.String> msgOptions)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message using the given parameters.

Parameters:

msgOptions - List options as a Map which key must be on the EnumFilterElement list.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)

get

public RetrievedMessage get(java.lang.String messageIdentification,
                   java.lang.Integer messageVersion,
                   java.lang.Long code,
                   java.lang.String queue)
                     throws es.ree.eemws.core.utils.operations.get.GetOperationException

Gets the message using the given parameters.

Parameters:

messageIdentification - Message's identification.

messageVersion - Message's version. Can be null if no version applies.

code - Message's code.

queue - Queue value.

Returns:

Response message wrapper with the server's response.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the retrieved message has an invalid format or the application cannot handle it or if the retrieved message has invalid signature or is not valid (has no header, invalid verb, etc.)