es.ree.eemws.client.get

Class RetrievedMessage

java.lang.Object

es.ree.eemws.client.get.RetrievedMessage

public final class RetrievedMessage
extends java.lang.Object

Payload response message wrapper.

Constructor Summary

Constructors

Constructor and Description
RetrievedMessage()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBinaryPayload() Returns this message binary content.
java.lang.String	getFileName() Returns this message file name.
java.lang.String	getPrettyPayload() Returns a pretty print version of this message string (xml) content.
ch.iec.tc57._2011.schema.message.ResponseMessage	getResponseMessage() Returns the response message (whole reply from the get operation).
java.lang.String	getStringPayload() Returns this message string (xml) content.
boolean	isBinary() Returns whether the message is binary.
void	setMessage(ch.iec.tc57._2011.schema.message.ResponseMessage response) Sets this class payload or binary values from a ResponseMessage object.
void	setMsgIdentification(java.lang.String messageIdentification) Sets this message identification in order to create a proper file name identification.
void	setMsgVersion(java.lang.String messageVersion) Sets this message version in order to create a proper file name identification.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetrievedMessage

public RetrievedMessage()

Method Detail

isBinary

public boolean isBinary()

Returns whether the message is binary. Note that XML that are received as binary are internally converted to String.

Returns:

true for binary messages.

getFileName

public java.lang.String getFileName()

Returns this message file name. If the message was retrieved as binary, the filename will be the value of the reply's ID value. Otherwise, the get's filter parameters will be used.

Returns:

This message file name. null if the QUEUE method was used and the returned message has no ID value.

setMsgIdentification

public void setMsgIdentification(java.lang.String messageIdentification)

Sets this message identification in order to create a proper file name identification.

Parameters:

messageIdentification - Get filter's message identification.

setMsgVersion

public void setMsgVersion(java.lang.String messageVersion)

Sets this message version in order to create a proper file name identification. This method is called after setMsgIdentification(String) only if the version applies.

Parameters:

messageVersion - Get filter's message version.

getBinaryPayload

public byte[] getBinaryPayload()

Returns this message binary content.

Returns:

This message binary content. null if there is no binary content.

getStringPayload

public java.lang.String getStringPayload()

Returns this message string (xml) content.

Returns:

This message string content. null if there is no payload.

getPrettyPayload

public java.lang.String getPrettyPayload()

Returns a pretty print version of this message string (xml) content.

Returns:

A pretty print (formatted) version of this message string content. null if there is no string payload.

getResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage getResponseMessage()

Returns the response message (whole reply from the get operation).

Returns:

Reply of the get operation.

setMessage

public void setMessage(ch.iec.tc57._2011.schema.message.ResponseMessage response)
                throws es.ree.eemws.core.utils.operations.get.GetOperationException

Sets this class payload or binary values from a ResponseMessage object.

Parameters:

response - ResponseMessage object with payload or binary values.

Throws:

es.ree.eemws.core.utils.operations.get.GetOperationException - If the BINARY response has an invalid format or if it cannot be unzipped.