es.ree.eemws.core.utils.iec61968100

Class MessageUtil

java.lang.Object

es.ree.eemws.core.utils.iec61968100.MessageUtil

public final class MessageUtil
extends java.lang.Object

Miscellaneous utilities to handle messages.

Method Summary

Methods

Modifier and Type	Method and Description
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithBinaryPayload(java.lang.String name, byte[] binary, EnumMessageFormat format) Creates a request message with binary payload.
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithBinaryPayload(java.lang.String name, java.lang.StringBuilder binaryB64, EnumMessageFormat format) Creates a request message with binary payload.
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithCompressedXmlPayload(java.lang.StringBuilder xmlMessage) Creates a request message with compressed xml message.
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithOptions(EnumVerb verb, EnumNoun noun, java.util.Map<java.lang.String,java.lang.String> options) Creates a request message with the given options.
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithOptions(java.lang.String verb, java.lang.String noun, java.util.Map<java.lang.String,java.lang.String> options) Creates a request message with the given options.
static ch.iec.tc57._2011.schema.message.RequestMessage	createRequestWithPayload(java.lang.String verb, java.lang.String noun, java.lang.StringBuilder xmlMessage) Creates a request message with a payload.
static ch.iec.tc57._2011.schema.message.ResponseMessage	createResponseWithBinaryPayload(EnumMessageStatus status, java.lang.String name, byte[] binary, EnumMessageFormat format) Creates a ResponseMessage with a binary content.
static ch.iec.tc57._2011.schema.message.ResponseMessage	createResponseWithBinaryPayload(EnumMessageStatus status, java.lang.String name, java.lang.StringBuilder binaryB64, EnumMessageFormat format) Creates a ResponseMessage with a binary content.
static ch.iec.tc57._2011.schema.message.ResponseMessage	createResponseWithNoPayload(EnumMessageStatus status) Creates an empty response (with no payload).
static ch.iec.tc57._2011.schema.message.ResponseMessage	createResponseWithPayload(EnumNoun noun, EnumMessageStatus status, org.w3c.dom.Element msgPayload) Creates a ResponseMessage with the given parameters and payload.
static ch.iec.tc57._2011.schema.message.ResponseMessage	createResponseWithPayload(java.lang.String noun, EnumMessageStatus status, org.w3c.dom.Element msgPayload) Creates a ResponseMessage with the given parameters and payload.
static java.util.Map<java.lang.String,java.lang.Object>	getRequestMessageOptions(ch.iec.tc57._2011.schema.message.RequestMessage message) Returns a Map with the given RequestMessage options.
static java.util.Map<java.lang.String,java.lang.Object>	getRequestMessageOptionsAllowingErrors(ch.iec.tc57._2011.schema.message.RequestMessage message) Returns a Map with the given RequestMessage options ignoring invalid date format parameters and duplicates.
static java.lang.String	responsePayload2String(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage) Returns the operation response's payload content as a String.
static void	validateMessage(java.lang.StringBuilder stringMessage) Validates against schema the given IEC 61968-100 message.
static void	validateMessage(StringBuilderMessage msg) Validates against schema the given IEC 61968-100 message.

Methods inherited from class java.lang.Object

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

Method Detail

createRequestWithOptions

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithOptions(EnumVerb verb,
                                                                       EnumNoun noun,
                                                                       java.util.Map<java.lang.String,java.lang.String> options)

Creates a request message with the given options.

Parameters:

verb - Request verb

noun - Request noun

options - Options to be included in the request.

Returns:

Request message.

createRequestWithOptions

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithOptions(java.lang.String verb,
                                                                       java.lang.String noun,
                                                                       java.util.Map<java.lang.String,java.lang.String> options)

Creates a request message with the given options.

Parameters:

verb - Request verb

noun - Request noun

options - Options to be included in the request.

Returns:

Request message.

getRequestMessageOptions

public static java.util.Map<java.lang.String,java.lang.Object> getRequestMessageOptions(ch.iec.tc57._2011.schema.message.RequestMessage message)

Returns a Map with the given RequestMessage options. The start time and end time are also included in the map.

Parameters:

message - Request message.

Returns:

a Map with the options that the given RequestMessage has.

getRequestMessageOptionsAllowingErrors

public static java.util.Map<java.lang.String,java.lang.Object> getRequestMessageOptionsAllowingErrors(ch.iec.tc57._2011.schema.message.RequestMessage message)

Returns a Map with the given RequestMessage options ignoring invalid date format parameters and duplicates. The start time and end time are also included in the map.

Parameters:

message - Request message.

Returns:

a Map with the options that the given RequestMessage has.

createRequestWithPayload

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithPayload(java.lang.String verb,
                                                                       java.lang.String noun,
                                                                       java.lang.StringBuilder xmlMessage)
                                                                                throws javax.xml.parsers.ParserConfigurationException,
                                                                                       org.xml.sax.SAXException,
                                                                                       java.io.IOException

Creates a request message with a payload.

Parameters:

verb - Message verb.

noun - Message noun.

xmlMessage - Document payload.

Returns:

Request message.

Throws:

javax.xml.parsers.ParserConfigurationException - If the current configuration does not support xml parsing.

org.xml.sax.SAXException - If the given payload is not well formed.

java.io.IOException - If it is not possible to read the given xml payload.

createRequestWithCompressedXmlPayload

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithCompressedXmlPayload(java.lang.StringBuilder xmlMessage)
                                                                                             throws java.io.IOException

Creates a request message with compressed xml message.

Parameters:

xmlMessage - Xml document (payload) to be transmited.

Returns:

Request message With with the given xml in compressed format.

Throws:

java.io.IOException - If the given xml cannot be compressed.

createRequestWithBinaryPayload

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithBinaryPayload(java.lang.String name,
                                                                             java.lang.StringBuilder binaryB64,
                                                                             EnumMessageFormat format)

Creates a request message with binary payload.

Parameters:

name - Name for binary files. For compressed XML documents this value is not necessary (name will be taken form the xml document during procesing)

binaryB64 - Binary data in B64.

format - Optional value for the binary format. if null XML will be used.

Returns:

Request message With binary data.

createRequestWithBinaryPayload

public static ch.iec.tc57._2011.schema.message.RequestMessage createRequestWithBinaryPayload(java.lang.String name,
                                                                             byte[] binary,
                                                                             EnumMessageFormat format)

Creates a request message with binary payload.

Parameters:

name - Binary name (file name).

binary - Binary data as byte[].

format - Optional value for the binary format. if null XML will be used.

Returns:

Request message With binary data.

createResponseWithPayload

public static ch.iec.tc57._2011.schema.message.ResponseMessage createResponseWithPayload(EnumNoun noun,
                                                                         EnumMessageStatus status,
                                                                         org.w3c.dom.Element msgPayload)

Creates a ResponseMessage with the given parameters and payload.

Parameters:

noun - Header noun.

status - Header status

msgPayload - Message payload

Returns:

a Response message with payload.

createResponseWithPayload

public static ch.iec.tc57._2011.schema.message.ResponseMessage createResponseWithPayload(java.lang.String noun,
                                                                         EnumMessageStatus status,
                                                                         org.w3c.dom.Element msgPayload)

Creates a ResponseMessage with the given parameters and payload.

Parameters:

noun - Header noun.

status - Header status

msgPayload - Message payload

Returns:

a Response message with payload.

createResponseWithNoPayload

public static ch.iec.tc57._2011.schema.message.ResponseMessage createResponseWithNoPayload(EnumMessageStatus status)

Creates an empty response (with no payload). This method is usefull to send back responses to the client when:

No response is expected: For instance, if the user has send an acknowledgement. Server works in asynchronous mode, sending back a response as soon as it receives a message.

Parameters:

status - Response's status OK / FAILED.

Returns:

An empty resopnse.

createResponseWithBinaryPayload

public static ch.iec.tc57._2011.schema.message.ResponseMessage createResponseWithBinaryPayload(EnumMessageStatus status,
                                                                               java.lang.String name,
                                                                               byte[] binary,
                                                                               EnumMessageFormat format)

Creates a ResponseMessage with a binary content.

Parameters:

status - Message status (OK, FAILED)

name - Binary file name.

binary - Binary context as byte[].

format - Binary format. if null EnumMessageFormat.XML is set.

Returns:

ResponseMessage with binary content.

createResponseWithBinaryPayload

public static ch.iec.tc57._2011.schema.message.ResponseMessage createResponseWithBinaryPayload(EnumMessageStatus status,
                                                                               java.lang.String name,
                                                                               java.lang.StringBuilder binaryB64,
                                                                               EnumMessageFormat format)

Creates a ResponseMessage with a binary content.

Parameters:

status - Message status (OK, FAILED)

name - Binary file name.

binaryB64 - Binary context in B64.

format - Binary format. if null EnumMessageFormat.XML is set.

Returns:

ResponseMessage with binary content.

validateMessage

public static void validateMessage(StringBuilderMessage msg)
                            throws org.xml.sax.SAXException

Validates against schema the given IEC 61968-100 message. Note that schema validation has impact on the performance.

Parameters:

msg - A StringBuilderMessage with 61968-100 message.

Throws:

org.xml.sax.SAXException - If the message is not valid against schema.

validateMessage

public static void validateMessage(java.lang.StringBuilder stringMessage)
                            throws org.xml.sax.SAXException

Validates against schema the given IEC 61968-100 message. Note that schema validation has impact on the performance.

Parameters:

stringMessage - A String representation of the xml message

Throws:

org.xml.sax.SAXException - If the message is not valid against schema.

responsePayload2String

public static java.lang.String responsePayload2String(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage)
                                               throws javax.xml.transform.TransformerException,
                                                      javax.xml.parsers.ParserConfigurationException

Returns the operation response's payload content as a String.

Parameters:

responseMessage - Response message received from server.

Returns:

Operation response payload as string. If the servers has returned no payload (for asynchronous communication) null is returned.

Throws:

javax.xml.transform.TransformerException - If the response cannot be transformed as an String.

javax.xml.parsers.ParserConfigurationException - If the response cannot be transformed as an string.