com.attivio.sdk.esb

Class MessageMetadata

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<K,V>

com.attivio.sdk.util.BaseTypesMap<String,Object>

com.attivio.sdk.esb.MessageMetadata

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class MessageMetadata
extends BaseTypesMap<String,Object>
implements Cloneable

Container for arbitrary metadata about a message. Extends LinkedHashMap in order to provide dependable iteration order for serialization purposes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.util.BaseTypesMap

BaseTypesMap.BaseTypesEntry

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CGI_QUERY_STRING_PROPERTY
static String	REQUEST_IP_PROPERTY

Constructor Summary

Constructors

Constructor and Description
MessageMetadata()

Method Summary

Modifier and Type	Method and Description
void	addAll(Properties p) Adds all values from the properties object.
MessageMetadata	clone() Performs a deep clone of this map.
boolean	containsKey(Object key)
boolean	equals(Object other)
Object	get(Object key)
String	getCgiQueryString() Gets the cgi query string.
long	getEstimatedSize()
Object	getProperty(String key) Gets a property.
boolean	getProperty(String key, boolean defaultValue) Gets arbitrary boolean property from the query.
int	getProperty(String key, int defaultValue) Gets arbitrary integer property from the query.
long	getProperty(String key, long defaultValue) Gets arbitrary long property from the query.
String	getProperty(String key, String defaultValue) Gets arbitrary String property from the query.
String	getRequestIp() Gets the request ip.
int	hashCode()
Object	remove(Object key)
void	setCgiQueryString(String value) Sets the cgi query string.
void	setProperty(String key, Object value) Sets a property.
void	setRequestIp(String value) Sets the request ip.
Properties	toProperties() Gets a new Properties object that represents this metadata object.

Methods inherited from class com.attivio.sdk.util.BaseTypesMap

checkType, getEntries, put, putAll, setEntries

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putIfAbsent, remove, replace, replace, size

Field Detail

CGI_QUERY_STRING_PROPERTY

public static final String CGI_QUERY_STRING_PROPERTY

See Also:

Constant Field Values

REQUEST_IP_PROPERTY

public static final String REQUEST_IP_PROPERTY

See Also:

Constant Field Values

Constructor Detail

MessageMetadata

public MessageMetadata()

Method Detail

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class LinkedHashMap<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class HashMap<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class HashMap<String,Object>

getProperty

public Object getProperty(String key)

Gets a property.

Parameters:

key - the key

Returns:

the value

setProperty

public void setProperty(String key,
                        Object value)

Sets a property.

Parameters:

key - the key

value - the value

setCgiQueryString

public void setCgiQueryString(String value)

Sets the cgi query string.

Parameters:

value - the value

getCgiQueryString

public String getCgiQueryString()

Gets the cgi query string.

Returns:

the value

setRequestIp

public void setRequestIp(String value)

Sets the request ip.

Parameters:

value - the value

getRequestIp

public String getRequestIp()

Gets the request ip.

Returns:

the value

toProperties

public Properties toProperties()

Gets a new Properties object that represents this metadata object.

Returns:

the data as a Properties object

getProperty

public String getProperty(String key,
                          String defaultValue)

Gets arbitrary String property from the query.

Parameters:

key - the key

defaultValue - the default value

Returns:

the property value or the default value if not found

getProperty

public boolean getProperty(String key,
                           boolean defaultValue)

Gets arbitrary boolean property from the query.

Parameters:

key - the key

defaultValue - the default value

Returns:

the property value or the default value if not found

getProperty

public int getProperty(String key,
                       int defaultValue)

Gets arbitrary integer property from the query.

Parameters:

key - the key

defaultValue - the default value

Returns:

the property value or the default value if not found

getProperty

public long getProperty(String key,
                        long defaultValue)

Gets arbitrary long property from the query.

Parameters:

key - the key

defaultValue - the default value

Returns:

the property value or the default value if not found

addAll

public void addAll(Properties p)

Adds all values from the properties object.

Parameters:

p - the properties object to populate from

clone

public MessageMetadata clone()

Performs a deep clone of this map.

Overrides:

clone in class BaseTypesMap<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class AbstractMap<String,Object>

equals

public boolean equals(Object other)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class AbstractMap<String,Object>

getEstimatedSize

public long getEstimatedSize()