es.ree.eemws.core.utils.iec61968100

Class MessageMetaData

java.lang.Object

es.ree.eemws.core.utils.iec61968100.MessageMetaData

All Implemented Interfaces:

java.io.Serializable

public final class MessageMetaData
extends java.lang.Object
implements java.io.Serializable

Class with the Meta data of the message. Information that is not available in the payload, and it is generated from the context: Received timestamp, user's certificate, etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_DATA_CONTEXT_KEY Key used to store this information in the process context.

Constructor Summary

Constructors

Constructor and Description
MessageMetaData() Creates a new instance of the message metadata.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getCode() Gets the code of the message in the database table.
GenericCodedException	getException() Gets an exception caused during the processing of this message.
java.security.cert.X509Certificate	getHttpCertificate() Gets the user's http X.509 Certificate.
java.lang.String	getMessageType() Gets the message type.
java.lang.String	getOwner() Returns current message's data owner.
java.lang.String	getRejectText() Gets the reject text of the message.
java.lang.String	getRemoteUser() Gets the remote user identification (from http request).
java.util.Calendar	getServerTimestamp() Gets the timestamp when the message is received by the server.
java.security.cert.X509Certificate	getSignatureCertificate() Gets the certificate used in the signature.
EnumMessageStatus	getStatus() Gets the status of the message (OK, FAILED).
java.util.List<java.lang.String>	getUserRoles() Gets the user's list of roles.
boolean	isIgnorable() Returns true if the message must be ignored.
void	setCode(java.lang.Long inCode) Sets the code of the message when it is stored.
void	setException(GenericCodedException ex) Sets an exception caused during the processing of this message.
void	setHttpCertificate(java.security.cert.X509Certificate x509Certificate) Sets the http X.509 Certificate.
void	setIgnorable(boolean ign) Sets if the message must be ignored.
void	setMessageType(java.lang.String type) Sets the message type.
void	setOwner(java.lang.String own) Sets current message's data owner.
void	setRejectText(java.lang.String inRejectText) Sets the reject text of the message.
void	setRemoteUser(java.lang.String inRemoteUser) Sets the remote user identification (from http request).
void	setServerTimestamp(java.util.Calendar date) Sets the timestamp when the message is received by the server.
void	setSignatureCertificate(java.security.cert.X509Certificate x509Certificate) Sets the certificate used for signature.
void	setStatus(EnumMessageStatus inStatus) Sets the status of the message (OK, FAILED).
void	setUserRoles(java.util.List<java.lang.String> inRoles) Sets the user's list of roles.

Methods inherited from class java.lang.Object

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

Field Detail

META_DATA_CONTEXT_KEY

public static final java.lang.String META_DATA_CONTEXT_KEY

Key used to store this information in the process context.

See Also:

Constant Field Values

Constructor Detail

MessageMetaData

public MessageMetaData()

Creates a new instance of the message metadata. Sets the timestamp.

Method Detail

getOwner

public java.lang.String getOwner()

Returns current message's data owner.

Returns:

Current message's data owner.

setOwner

public void setOwner(java.lang.String own)

Sets current message's data owner.

Parameters:

own - Current message's data owner.

getServerTimestamp

public java.util.Calendar getServerTimestamp()

Gets the timestamp when the message is received by the server.

Returns:

Date when the message is received by the server.

setServerTimestamp

public void setServerTimestamp(java.util.Calendar date)

Sets the timestamp when the message is received by the server.

Parameters:

date - Date when the message is received by the server.

getHttpCertificate

public java.security.cert.X509Certificate getHttpCertificate()

Gets the user's http X.509 Certificate.

Returns:

User's http X.509 Certificate.

setHttpCertificate

public void setHttpCertificate(java.security.cert.X509Certificate x509Certificate)

Sets the http X.509 Certificate.

Parameters:

x509Certificate - Http X.509 Certificate.

setSignatureCertificate

public void setSignatureCertificate(java.security.cert.X509Certificate x509Certificate)

Sets the certificate used for signature.

Parameters:

x509Certificate - Certificate used for signature.

getSignatureCertificate

public java.security.cert.X509Certificate getSignatureCertificate()

Gets the certificate used in the signature.

Returns:

Certificate used in the signature.

getRemoteUser

public java.lang.String getRemoteUser()

Gets the remote user identification (from http request).

Returns:

Remote user identification.

setRemoteUser

public void setRemoteUser(java.lang.String inRemoteUser)

Sets the remote user identification (from http request).

Parameters:

inRemoteUser - Remote user identification.

getUserRoles

public java.util.List<java.lang.String> getUserRoles()

Gets the user's list of roles.

Returns:

User's list of roles.

setUserRoles

public void setUserRoles(java.util.List<java.lang.String> inRoles)

Sets the user's list of roles.

Parameters:

inRoles - User's list of roles.

getCode

public java.lang.Long getCode()

Gets the code of the message in the database table.

Returns:

Code of the XML in the database table.

setCode

public void setCode(java.lang.Long inCode)

Sets the code of the message when it is stored.

Parameters:

inCode - Message's code.

getMessageType

public java.lang.String getMessageType()

Gets the message type.

Returns:

Message type.

setMessageType

public void setMessageType(java.lang.String type)

Sets the message type.

Parameters:

type - Message type.

setException

public void setException(GenericCodedException ex)

Sets an exception caused during the processing of this message.

Parameters:

ex - Exception caused during the processing of this message.

getException

public GenericCodedException getException()

Gets an exception caused during the processing of this message.

Returns:

Exception caused during the processing of this message

getStatus

public EnumMessageStatus getStatus()

Gets the status of the message (OK, FAILED).

Returns:

Status of the message.

setStatus

public void setStatus(EnumMessageStatus inStatus)

Sets the status of the message (OK, FAILED).

Parameters:

inStatus - Status of the message.

getRejectText

public java.lang.String getRejectText()

Gets the reject text of the message.

Returns:

Reject text of the message. null if the message was accepted.

setRejectText

public void setRejectText(java.lang.String inRejectText)

Sets the reject text of the message. If a rejection text was already provided the given text will be appended at the end.

Parameters:

inRejectText - Reject text of the message.

isIgnorable

public boolean isIgnorable()

Returns true if the message must be ignored. false otherwise.

Returns:

true if any futher process of this message must be skipped. false otherwise.

setIgnorable

public void setIgnorable(boolean ign)

Sets if the message must be ignored. For instance if the server receives a message whose owner it's not the one associated with the received certificate. Ignored messages are not stored with the rest.

Parameters:

ign - true if the message must be ignored. false otherwise.