atavism.server.engine

Class EnginePlugin.GetPropertyMessage

java.lang.Object

atavism.msgsys.Message

atavism.msgsys.SubjectMessage

atavism.server.messages.OIDNamespaceMessage

atavism.server.engine.EnginePlugin.GetPropertyMessage

All Implemented Interfaces:

INamespaceMessage, java.io.Serializable

Enclosing class:

EnginePlugin

public static class EnginePlugin.GetPropertyMessage
extends OIDNamespaceMessage

Get property message for an sub object in a particular namespace. Capable of getting 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
GetPropertyMessage() No-arg constructor, required by marshalling
GetPropertyMessage(OID oid, Namespace namespace, java.util.List<java.lang.String> keys) GetPropertyMessage constructor for cases where we want the values of a list of keys.
GetPropertyMessage(OID oid, Namespace namespace, java.lang.String key) GetPropertyMessage constructor for cases where we want the value of a single key.

Method Summary

Modifier and Type	Method and Description
void	addKey(java.lang.String key) Add another key to the list of keys for which this message will fetch values.
java.util.List<java.lang.String>	getKeys() Return the list of keys for which this message will fetch values
java.io.Serializable	removeKey(java.io.Serializable key) Remove a key from the list of keys for which this message will fetch values.
java.lang.String	toString() Method to produce a human-readable version of the key list

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

GetPropertyMessage

public GetPropertyMessage()

No-arg constructor, required by marshalling

GetPropertyMessage

public GetPropertyMessage(OID oid,
                          Namespace namespace,
                          java.lang.String key)

GetPropertyMessage constructor for cases where we want the value of a single key.

Parameters:

oid - The oid of the object.

namespace - The Namespace containing the sub-object.

key - The key whose value will be fetched.

GetPropertyMessage

public GetPropertyMessage(OID oid,
                          Namespace namespace,
                          java.util.List<java.lang.String> keys)

GetPropertyMessage constructor for cases where we want the values of a list of keys.

Parameters:

oid - The oid of the object.

namespace - The Namespace containing the sub-object.

keys - The list of keys whose values will be fetched.

Method Detail

toString

public java.lang.String toString()

Method to produce a human-readable version of the key list

Overrides:

toString in class SubjectMessage

addKey

public void addKey(java.lang.String key)

Add another key to the list of keys for which this message will fetch values.

Parameters:

key - The key to be added to the list of keys for which values will be fetched.

removeKey

public java.io.Serializable removeKey(java.io.Serializable key)

Remove a key from the list of keys for which this message will fetch values.

Parameters:

key - The key to be removed from the list of keys for which values will be fetched.

Returns:

The key, if it was previously in the list of keys, else null.

getKeys

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

Return the list of keys for which this message will fetch values

Returns:

The list of keys for which values will be fetched.