es.ree.eemws.client.put

Class PutMessage

java.lang.Object

es.ree.eemws.client.common.ParentClient

es.ree.eemws.client.put.PutMessage

public final class PutMessage
extends ParentClient

Send a message to the server for processing.

Constructor Summary

Constructors

Constructor and Description
PutMessage() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	put(java.lang.StringBuilder xmlMessage) Sends a binary message to the server for further processing.
java.lang.String	put(java.lang.String name, byte[] data) Sends an XML message as binary to the server for further processing (format = null).
java.lang.String	put(java.lang.String name, byte[] data, es.ree.eemws.core.utils.iec61968100.EnumMessageFormat format) Sends a binary message (can be used to send XML as binary) to the server for further processing.
ch.iec.tc57._2011.schema.message.ResponseMessage	putWithResponseMessage(java.lang.StringBuilder xmlMessage) Sends a binary message to the server for further processing.
ch.iec.tc57._2011.schema.message.ResponseMessage	putWithResponseMessage(java.lang.String name, byte[] data) Sends an XML message as binary to the server for further processing (format = null).
ch.iec.tc57._2011.schema.message.ResponseMessage	putWithResponseMessage(java.lang.String name, byte[] data, es.ree.eemws.core.utils.iec61968100.EnumMessageFormat format) Sends a binary message (can be used to send XML as binary) to the server for further processing.

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

PutMessage

public PutMessage()

Constructor.

Method Detail

put

public java.lang.String put(java.lang.String name,
                   byte[] data)
                     throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends an XML message as binary to the server for further processing (format = null).

Parameters:

name - Name of the binary file.

data - Binary content.

Returns:

String with the server's response. null if the response has no payload.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

putWithResponseMessage(String, byte[])

putWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage putWithResponseMessage(java.lang.String name,
                                                                      byte[] data)
                                                                        throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends an XML message as binary to the server for further processing (format = null).

Parameters:

name - Name of the binary file.

data - Binary content.

Returns:

ResponseMessage with the server's response.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

put(String, byte[])

put

public java.lang.String put(java.lang.String name,
                   byte[] data,
                   es.ree.eemws.core.utils.iec61968100.EnumMessageFormat format)
                     throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends a binary message (can be used to send XML as binary) to the server for further processing.

Parameters:

name - Name of the binary file.

data - Binary content.

format - Message's format. Can be null to use default format.

Returns:

String with the server's response. null if the response has no payload.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

putWithResponseMessage(String, byte[], EnumMessageFormat)

putWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage putWithResponseMessage(java.lang.String name,
                                                                      byte[] data,
                                                                      es.ree.eemws.core.utils.iec61968100.EnumMessageFormat format)
                                                                        throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends a binary message (can be used to send XML as binary) to the server for further processing.

Parameters:

name - Name of the binary file.

data - Binary content.

format - Message's format. Can be null to use default format.

Returns:

ResponseMessage with the server's response.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

put(String, byte[], EnumMessageFormat)

put

public java.lang.String put(java.lang.StringBuilder xmlMessage)
                     throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends a binary message to the server for further processing.

Parameters:

xmlMessage - Xml message to be sent.

Returns:

String with the XML response message. null if the response has no payload.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

putWithResponseMessage(StringBuilder)

putWithResponseMessage

public ch.iec.tc57._2011.schema.message.ResponseMessage putWithResponseMessage(java.lang.StringBuilder xmlMessage)
                                                                        throws es.ree.eemws.core.utils.operations.put.PutOperationException

Sends a binary message to the server for further processing.

Parameters:

xmlMessage - Xml message to be sent.

Returns:

ResponseMessage with the server's response.

Throws:

es.ree.eemws.core.utils.operations.put.PutOperationException - 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:

put(StringBuilder)