com.attivio.sdk.esb

Class AbstractListMessage<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

com.attivio.sdk.esb.AbstractListMessage<T>

Type Parameters:

T -

All Implemented Interfaces:

PlatformMessage, Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess

Direct Known Subclasses:

DocumentList, MessageList

public abstract class AbstractListMessage<T>
extends ArrayList<T>
implements PlatformMessage

Abstract container for list based messages.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface com.attivio.sdk.esb.PlatformMessage

DEFAULT_MAX_LOG_LENGTH, MESSAGE_DROPPED, MESSAGE_SEND_TIME_PROP, PROP_MAX_LOG_LENGTH

Constructor Summary

Constructors

Constructor and Description
AbstractListMessage() Creates an empty list.
AbstractListMessage(int size) Creates an empty list of a fixed size.

Method Summary

Modifier and Type	Method and Description
void	addMessageHistory(List<MessageHistory> historyList) Adds a list of history.
void	addMessageHistory(MessageHistory msg) Adds a message to the message history.
AbstractListMessage<T>	clone() Clones a message.
protected abstract T	clone(T tmp)
boolean	equals(Object other)
UUID	getClientId() Gets the client to which this message belongs (may have originated with the client or be a response to the client).
long	getEstimatedSize()
List<MessageHistory>	getMessageHistory() Gets the list of components that have processed this message.
MessageId	getMessageId() Gets the message id associated with the message.
MessageMetadata	getMetadata() Gets the message metadata from this message.
Object	getProperty(String key) Gets an arbitrary property for the message.
WorkflowQueue	getWorkflowQueue() Gets the workflow queue.
WorkflowQueue	getWorkflowQueue(boolean createIfNull) Optionally creates a new empty queue if null.
int	hashCode()
boolean	isRedelivered() Returns true if the message (or its originating message) is re-delivered Redelivery is generally due to a failure and subsequent recovery in a fault tolerant system.
void	removeProperty(String key) Removes a property from the message.
void	setClientId(UUID clientId) Sets the client to which this message belongs.
void	setMessageId(MessageId msgId) Sets the message id associated with the message.
void	setProperty(String key, Object value) Sets an arbitrary property for the message.
void	setRedelivered(boolean redelivered) Sets the re-delivered flag.
void	setWorkflowQueue(String... workflows) Sets the workflow queue.
void	setWorkflowQueue(WorkflowQueue workflowQueue) Sets the workflow queue.
String	toMessageString() Gets a string-based representation of the message containing string data only.
String	toString()
String	toStringDetailed()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

AbstractListMessage

public AbstractListMessage()

Creates an empty list.

AbstractListMessage

public AbstractListMessage(int size)

Creates an empty list of a fixed size.

Method Detail

getProperty

public Object getProperty(String key)

Gets an arbitrary property for the message. Some transformations of messages may result in the value being converted to a String.

Specified by:

getProperty in interface PlatformMessage

Parameters:

key - the key

Returns:

property value

setProperty

public void setProperty(String key,
                        Object value)

Sets an arbitrary property for the message. Some transformations of messages may result in the value being converted to a String.

Specified by:

setProperty in interface PlatformMessage

Parameters:

key - the key

value - the value

removeProperty

public void removeProperty(String key)

Removes a property from the message.

Specified by:

removeProperty in interface PlatformMessage

getClientId

public UUID getClientId()

Gets the client to which this message belongs (may have originated with the client or be a response to the client).

Specified by:

getClientId in interface PlatformMessage

Returns:

the client ID

setClientId

public void setClientId(UUID clientId)

Sets the client to which this message belongs.

Specified by:

setClientId in interface PlatformMessage

Parameters:

clientId - the client ID

getMessageId

public MessageId getMessageId()

Gets the message id associated with the message. message ids are used for internal ordering guarantees and may change as the message propagates through the system.

Specified by:

getMessageId in interface PlatformMessage

Returns:

the message ID

setMessageId

public void setMessageId(MessageId msgId)

Sets the message id associated with the message.

Specified by:

setMessageId in interface PlatformMessage

Parameters:

msgId - the message ID

getMetadata

public MessageMetadata getMetadata()

Gets the message metadata from this message.

Specified by:

getMetadata in interface PlatformMessage

Returns:

the message metadata

getMessageHistory

public List<MessageHistory> getMessageHistory()

Gets the list of components that have processed this message. The returned list is unmodifiable.

Specified by:

getMessageHistory in interface PlatformMessage

Returns:

the message history

addMessageHistory

public void addMessageHistory(MessageHistory msg)

Adds a message to the message history.

Specified by:

addMessageHistory in interface PlatformMessage

Parameters:

msg - the message to add

addMessageHistory

public void addMessageHistory(List<MessageHistory> historyList)

Adds a list of history.

Specified by:

addMessageHistory in interface PlatformMessage

Parameters:

historyList -

getWorkflowQueue

public WorkflowQueue getWorkflowQueue()

Gets the workflow queue. Modifying the returned value will change the workflow destinations for the message.

Specified by:

getWorkflowQueue in interface PlatformMessage

Returns:

the workflow queue, may be null.

getWorkflowQueue

public WorkflowQueue getWorkflowQueue(boolean createIfNull)

Optionally creates a new empty queue if null. Modifying the returned value will change the workflow destinations for the message.

Specified by:

getWorkflowQueue in interface PlatformMessage

Parameters:

createIfNull - if true and the queue is not set, creates a new empty queue

Returns:

the workflow queue

setWorkflowQueue

public void setWorkflowQueue(WorkflowQueue workflowQueue)

Sets the workflow queue. wfQueue will be cloned.

Specified by:

setWorkflowQueue in interface PlatformMessage

Parameters:

workflowQueue - the workflow queue

setWorkflowQueue

public void setWorkflowQueue(String... workflows)

Sets the workflow queue. wfQueue will be cloned.

Specified by:

setWorkflowQueue in interface PlatformMessage

Parameters:

workflows - the list of workflows

toString

public String toString()

Overrides:

toString in class AbstractCollection<T>

toStringDetailed

public String toStringDetailed()

toMessageString

public String toMessageString()

Gets a string-based representation of the message containing string data only.

Specified by:

toMessageString in interface PlatformMessage

Returns:

the message string

isRedelivered

public boolean isRedelivered()

Returns true if the message (or its originating message) is re-delivered Redelivery is generally due to a failure and subsequent recovery in a fault tolerant system.

Specified by:

isRedelivered in interface PlatformMessage

Returns:

true if the message is re-delivered

setRedelivered

public void setRedelivered(boolean redelivered)

Sets the re-delivered flag.

Specified by:

setRedelivered in interface PlatformMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Overrides:

hashCode in class AbstractList<T>

equals

public boolean equals(Object other)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Overrides:

equals in class AbstractList<T>

clone

public AbstractListMessage<T> clone()

Clones a message. The message ID is not cloned.

Specified by:

clone in interface PlatformMessage

Overrides:

clone in class ArrayList<T>

Returns:

the cloned index message

clone

protected abstract T clone(T tmp)

getEstimatedSize

public long getEstimatedSize()

Specified by:

getEstimatedSize in interface PlatformMessage