atavism.server.engine

Class EnginePlugin.SetPropertyMessage

java.lang.Object

atavism.msgsys.Message

atavism.msgsys.SubjectMessage

atavism.server.messages.OIDNamespaceMessage

atavism.server.engine.EnginePlugin.SetPropertyMessage

All Implemented Interfaces:

INamespaceMessage, java.io.Serializable

Enclosing class:

EnginePlugin

public static class EnginePlugin.SetPropertyMessage
extends OIDNamespaceMessage

Set property message for an sub object in a particular namespace. Capable of setting a single property, or a set of property values.

See Also:

Serialized Form

Field Summary

Fields inherited from class atavism.msgsys.SubjectMessage

oid

Fields inherited from class atavism.msgsys.Message

flags, msgId, msgInstanceOid, msgType, remoteAgent

Constructor Summary

Constructors

Constructor and Description
SetPropertyMessage() No-arg constructor, required by marshalling.
SetPropertyMessage(OID oid, Namespace namespace, java.util.Map<java.lang.String,java.io.Serializable> propMap, java.util.Collection<java.lang.String> removedProps, boolean reqResponse) Constructor for the case that we want to set the values of more than one key.
SetPropertyMessage(OID oid, Namespace namespace, java.lang.String key, java.io.Serializable val, boolean reqResponse) Constructor for the case that we want to set the value of a single key.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Return true of the message contains the key argument; false otherwise
java.io.Serializable	get(java.lang.String key) Deprecated. Use getProperty(String key) instead
java.io.Serializable	getProperty(java.lang.String key) Return the value associated with a key.
java.util.Map<java.lang.String,java.io.Serializable>	getPropMap() Return the property map of keys and values
java.util.Collection<java.lang.String>	getRemovedProperties()
boolean	getRequestResponse() Get whether this message requires a response.
void	put(java.lang.String key, java.io.Serializable val) Deprecated. Use setProperty(String key, Serializable val) instead
void	removeProperty(java.lang.String key) Add (or replace) the key/value pair
java.io.Serializable	setProperty(java.lang.String key, java.io.Serializable val) Add (or replace) the key/value pair
void	setRequestResponse(boolean val) Set whether this message requires a response.
java.lang.String	toString()

Methods inherited from class atavism.server.messages.OIDNamespaceMessage

getNamespace, setNamespace

Methods inherited from class atavism.msgsys.SubjectMessage

getSubject, setSubject

Methods inherited from class atavism.msgsys.Message

getEnqueueTime, getMsgId, getMsgInstanceOid, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgInstanceOid, setMsgType, toBytes, toBytes, toBytes, ToString

Methods inherited from class java.lang.Object

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

Constructor Detail

SetPropertyMessage

public SetPropertyMessage()

No-arg constructor, required by marshalling.

SetPropertyMessage

public SetPropertyMessage(OID oid,
                          Namespace namespace,
                          java.lang.String key,
                          java.io.Serializable val,
                          boolean reqResponse)

Constructor for the case that we want to set the value of a single key.

Parameters:

oid - The oid of the subobject whose key/value pair will be set.

namespace - The namespace containing the subobject

key - The String key

val - The Serializable value

reqResponse - True if the message requires a response; false otherwise

SetPropertyMessage

public SetPropertyMessage(OID oid,
                          Namespace namespace,
                          java.util.Map<java.lang.String,java.io.Serializable> propMap,
                          java.util.Collection<java.lang.String> removedProps,
                          boolean reqResponse)

Constructor for the case that we want to set the values of more than one key.

Parameters:

oid - The oid of the subobject whose key/value pair will be set.

namespace - The namespace containing the subobject.

propMap - The map of keys to values.

removedProps - The set of properties that should be removed.

reqResponse - True if the message requires a response; false otherwise.

Method Detail

get

@Deprecated
public java.io.Serializable get(java.lang.String key)

Deprecated. Use getProperty(String key) instead

Get the value associated with a key.

getProperty

public java.io.Serializable getProperty(java.lang.String key)

Return the value associated with a key.

Parameters:

key - A String key.

Returns:

The Serializable value associated with the key, or null if none exists.

containsKey

public boolean containsKey(java.lang.String key)

Return true of the message contains the key argument; false otherwise

Parameters:

key - The key to look for

Returns:

True if the key is contained in the list of keys; false otherwise.

put

@Deprecated
public void put(java.lang.String key,
                             java.io.Serializable val)

Deprecated. Use setProperty(String key, Serializable val) instead

Associate the value with the key.

setProperty

public java.io.Serializable setProperty(java.lang.String key,
                                        java.io.Serializable val)

Add (or replace) the key/value pair

Parameters:

key - The string key

val - The Serializable value to be put.

Returns:

the previous value associated with the key, or null.

removeProperty

public void removeProperty(java.lang.String key)

Add (or replace) the key/value pair

Parameters:

key - The string key

val - The Serializable value to be put.

getPropMap

public java.util.Map<java.lang.String,java.io.Serializable> getPropMap()

Return the property map of keys and values

Returns:

The property map.

getRemovedProperties

public java.util.Collection<java.lang.String> getRemovedProperties()

setRequestResponse

public void setRequestResponse(boolean val)

Set whether this message requires a response.

Parameters:

val - The boolean value which, if true, indicates that the message requires a response

getRequestResponse

public boolean getRequestResponse()

Get whether this message requires a response.

Returns:

true if the message requires a response.

toString

public java.lang.String toString()

Overrides:

toString in class SubjectMessage