es.ree.eemws.client.common

Class ParentClient

java.lang.Object

es.ree.eemws.client.common.ParentClient

Direct Known Subclasses:

GetMessage, ListMessages, PutMessage, QueryData

public abstract class ParentClient
extends java.lang.Object

Parent class for all client's operations.

Constructor Summary

Constructors

Constructor and Description
ParentClient()

Method Summary

Methods

Modifier and Type	Method and Description
es.ree.eemws.core.utils.iec61968100.MessageMetaData	getMessageMetaData() Gets message's metadata.
protected ch.iec.tc57._2011.schema.message.ResponseMessage	sendMessage(ch.iec.tc57._2011.schema.message.RequestMessage message) Sends the given request message to the configured URL.
void	setCertificate(java.security.cert.X509Certificate inCertificate) Sets the certificate to sign the request.
void	setEndPoint(java.lang.String url) Sets the URL of the end point of the web service.
void	setEndPoint(java.net.URL url) Sets the URL of the end point of the web service.
void	setPrivateKey(java.security.PrivateKey inPrivateKey) Sets the private key to sign the request.
void	setSignRequest(boolean flag) Sets whether the request has to be signed.
void	setVerifyResponse(boolean flag) Sets whether the response's signature has to be validated.
protected void	validateResponse(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage, boolean canBeEmpty) Validates the received response.
protected void	validateResponse(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage, java.lang.String expectedNoun) Validates the received response.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParentClient

public ParentClient()

Method Detail

setEndPoint

public final void setEndPoint(java.lang.String url)
                       throws java.net.MalformedURLException

Sets the URL of the end point of the web service.

Parameters:

url - URL of the end point of the web service.

Throws:

java.net.MalformedURLException - if the given address is not valid.

setEndPoint

public final void setEndPoint(java.net.URL url)

Sets the URL of the end point of the web service.

Parameters:

url - URL of the end point of the web service.

setSignRequest

public final void setSignRequest(boolean flag)

Sets whether the request has to be signed.

Parameters:

flag - true if request has to be signed.

setVerifyResponse

public final void setVerifyResponse(boolean flag)

Sets whether the response's signature has to be validated.

Parameters:

flag - true if the response's signature has to be validated.

setCertificate

public final void setCertificate(java.security.cert.X509Certificate inCertificate)

Sets the certificate to sign the request.

Parameters:

inCertificate - Certificate to sign request.

setPrivateKey

public final void setPrivateKey(java.security.PrivateKey inPrivateKey)

Sets the private key to sign the request.

Parameters:

inPrivateKey - Private key to sign the request.

getMessageMetaData

public final es.ree.eemws.core.utils.iec61968100.MessageMetaData getMessageMetaData()

Gets message's metadata. Metadata holds information that is not present neither in the request nor in the response such as certificate information or status.

Returns:

Message's metadata.

sendMessage

protected final ch.iec.tc57._2011.schema.message.ResponseMessage sendMessage(ch.iec.tc57._2011.schema.message.RequestMessage message)
                                                                      throws es.ree.eemws.core.utils.operations.HandlerException

Sends the given request message to the configured URL.

Parameters:

message - Message to send.

Returns:

Response to the message.

Throws:

es.ree.eemws.core.utils.operations.HandlerException - If it is not possible to send the message or if the received response has errors.

validateResponse

protected void validateResponse(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage,
                    java.lang.String expectedNoun)
                         throws es.ree.eemws.core.utils.operations.HandlerException

Validates the received response.

Parameters:

responseMessage - Received response.

expectedNoun - Expected noun, according to the operation.

Throws:

es.ree.eemws.core.utils.operations.HandlerException - If the response is not valid.

validateResponse

protected void validateResponse(ch.iec.tc57._2011.schema.message.ResponseMessage responseMessage,
                    boolean canBeEmpty)
                         throws es.ree.eemws.core.utils.operations.HandlerException

Validates the received response.

Parameters:

responseMessage - Received response.

canBeEmpty - true if the response can be empty.

Throws:

es.ree.eemws.core.utils.operations.HandlerException - If the response is not valid.