es.ree.eemws.client.list

Class ListMessages

java.lang.Object

es.ree.eemws.client.common.ParentClient

es.ree.eemws.client.list.ListMessages

public final class ListMessages
extends ParentClient

Obtains a list of available messages according to filters.

Constructor Summary

Constructors

Constructor and Description
ListMessages() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<MessageListEntry>	list(java.util.Date startTime, java.util.Date endTime) Obtains a list of available messages for the client according to a given filter.
java.util.List<MessageListEntry>	list(java.util.Date startTime, java.util.Date endTime, es.ree.eemws.core.utils.iec61968100.EnumIntervalTimeType intervalType) Obtains a list of available messages for the client according to a given filter.
java.util.List<MessageListEntry>	list(java.util.Date startTime, java.util.Date endTime, es.ree.eemws.core.utils.iec61968100.EnumIntervalTimeType intervalType, java.lang.String messageIdentification, java.lang.String msgType, java.lang.String owner) Obtains a list of available messages for the client according to a given filter.
java.util.List<MessageListEntry>	list(java.lang.Long code) Obtains a list of available messages for the client according to a given filter.
java.util.List<MessageListEntry>	list(java.lang.Long code, java.lang.String messageIdentification, java.lang.String msgType, java.lang.String owner) Obtains a list of available messages for the client according to a given filter.
java.util.List<MessageListEntry>	list(java.util.Map<java.lang.String,java.lang.String> msgOptions) Obtains a list of available messages for the client according to a given filter.

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

ListMessages

public ListMessages()

Constructor.

Method Detail

list

public java.util.List<MessageListEntry> list(java.util.Date startTime,
                                    java.util.Date endTime)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

startTime - Specifies that the list of messages returned should only include messages whose end of their Application TimeInterval (Document TimeInterval) or Server Timestamp comes after the provided date.

endTime - Specifies that the list of messages returned should only include messages whose start of their Application TimeInterval or ServerTimestamp (when the message was received or published in the server) comes before the provided date.

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)

list

public java.util.List<MessageListEntry> list(java.util.Date startTime,
                                    java.util.Date endTime,
                                    es.ree.eemws.core.utils.iec61968100.EnumIntervalTimeType intervalType)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

startTime - Specifies that the list of messages returned should only include messages whose end of their Application TimeInterval (Document TimeInterval) or Server Timestamp comes after the provided date.

endTime - Specifies that the list of messages returned should only include messages whose start of their Application TimeInterval or ServerTimestamp (when the message was received or published in the server) comes before the provided date.

intervalType - Indicates whether the StartTime and EndTime refer to Application TimeInterval or to Server Timestamp.

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)

list

public java.util.List<MessageListEntry> list(java.util.Date startTime,
                                    java.util.Date endTime,
                                    es.ree.eemws.core.utils.iec61968100.EnumIntervalTimeType intervalType,
                                    java.lang.String messageIdentification,
                                    java.lang.String msgType,
                                    java.lang.String owner)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

startTime - Specifies that the list of messages returned should only include messages whose end of their Application TimeInterval (Document TimeInterval) or Server Timestamp comes after the provided date.

endTime - Specifies that the list of messages returned should only include messages whose start of their Application TimeInterval or ServerTimestamp (when the message was received or published in the server) comes before the provided date.

intervalType - Indicates whether the StartTime and EndTime refer to Application TimeInterval or to Server Timestamp. Permitted values: "Application" (default), "Server".

messageIdentification - Specifies that the list of messages returned should only include messages whose Message Identification is compliant with the pattern provided in this parameter. ("*" can be used as a wildcard).

msgType - Specifies that the list of messages returned should only include messages of the given type.

owner - Specifies that the list of messages returned should only include messages belonging to the given Owner.

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)

list

public java.util.List<MessageListEntry> list(java.lang.Long code)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

code - Specifies that the list of messages returned should only include messages with an internal identification number higher than the provided code. This means that the list will contain messages that are newer to the given one. For optimization purposes, if this filter is used, only messages available since the 00.00 of D-1 (day before) are guaranteed to be included in the response list

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)

list

public java.util.List<MessageListEntry> list(java.lang.Long code,
                                    java.lang.String messageIdentification,
                                    java.lang.String msgType,
                                    java.lang.String owner)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

code - Specifies that the list of messages returned should only include messages with an internal identification number higher than the provided code. This means that the list will contain messages that are newer to the given one. For optimization purposes, if this filter is used, only messages available since the 00.00 of D-1 (day before) are guaranteed to be included in the response list

messageIdentification - Specifies that the list of messages returned should only include messages whose Message Identification is compliant with the pattern provided in this parameter. ("*" can be used as a wildcard).

msgType - Specifies that the list of messages returned should only include messages of the given type.

owner - Specifies that the list of messages returned should only include messages belonging to the given Owner.

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)

list

public java.util.List<MessageListEntry> list(java.util.Map<java.lang.String,java.lang.String> msgOptions)
                                      throws es.ree.eemws.core.utils.operations.list.ListOperationException

Obtains a list of available messages for the client according to a given filter.

Parameters:

msgOptions - List options as a Map which key must be on the EnumFilterElement list.

Returns:

A list of MessageListEntry elements.

Throws:

es.ree.eemws.core.utils.operations.list.ListOperationException - 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.)