<tspace-entry>
A wrapper around ncsa.services.vizier.tspace.TspaceEntry
which allows one to set the payload directly as an XML element.
Apart from the payload, this object expresses a number attributes available for matching. It also stores runtime information, such as timestamps and nodes/resources on which this configuration has already been executed.
Attributes (identifying)
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
id |
|
|
set by the store when entry is first written |
producer |
|
|
source of the tuple |
consumer |
|
|
destined user of the tuple |
typeName0 |
|
|
an arbitrary type name to match |
typeName1 |
|
|
an arbitrary type name to match |
typeName2 |
|
|
an arbitrary type name to match |
typeName3 |
|
|
an arbitrary type name to match |
typeName4 |
|
|
an arbitrary type name to match |
typeValue0 |
|
|
value of type name 0 to match |
typeValue1 |
|
|
value of type name 1 to match |
typeValue2 |
|
|
value of type name 2 to match |
typeValue3 |
|
|
value of type name 3 to match |
typeValue4 |
|
|
value of type name 4 to match |
indexName0 |
|
|
an arbitrary index name to match |
indexName1 |
|
|
an arbitrary index name to match |
indexName2 |
|
|
an arbitrary index name to match |
indexName3 |
|
|
an arbitrary index name to match |
indexName4 |
|
|
an arbitrary index name to match |
indexValue0 |
|
|
value of index name 0 to match |
indexValue1 |
|
|
value of index name 0 to match |
indexValue2 |
|
|
value of index name 0 to match |
indexValue3 |
|
|
value of index name 0 to match |
indexValue4 |
|
|
value of index name 0 to match |
payloadType |
|
|
type (Java class) the serialized payload corresponds to |
extensionPoint |
|
|
extension point id for the extension corresponding to this type |
NOTES
- The manner in which the available name/value pairs is used is completely arbitrary. The fields, however, are ordered, so, for instance, a tuple with typeName0="a", typeValue0="A" will not match a request for typeName1="a", typeValue1="A"; be sure that the fields used in storing the tuple and requesting it correspond. Of course, type names and values can be used in conjunction with the numerical indices; in fact, an entry can have values expressed for any and all of the 22 constraint fields.
- Make sure id is
null
if adding an entry, non-null
if updating, through<tspace-write>
. - The payloadType and extensionPoint attributes are included in case programmatic deserialization of the object requires them. If the entry was added through the Ogrescript
<tspace-write>
task, the extension id will always be eitherncsa.tools.common.elementType
orncsa.tools.ogrescript.ogreTasks
); whenever the wrapper object is used, an attempt will be made to set these values automatically.
Attributes (runtime constraints & state)
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
timeWritten |
|
|
set by the store when entry is first written |
timeTaken |
|
|
set by the store when entry is taken; setting this to |
timeCompleted |
|
|
setting this and passing the entry to the |
takeIntervalLimit |
|
|
the limit on how long this tuple should remain in a given "taken" state |
allowedRetries |
|
|
number of times it is permitted to retake this tuple |
retried |
|
|
number of times this tuple has been taken |
NOTES
When the entry is first written to the Configuration Space store, its timeWritten timestamp is set. Whenever it is taken, the timeTaken timestamp is set; a take match always requires this attribute to be null
(i.e., the timestamp value serves to pin the tuple); setting the value to null
again releases the tuple. Setting timeCompleted to a non-null
value will cause the tuple to be removed from the store. For more information, see <tspace-write>
.
Elements
TAG |
TYPE |
COUNT |
DESCRIPTION |
---|---|---|---|
|
|
0:1 |
add these compute resources to the list of resources this entry has been (unsuccessfully) executed on |
|
|
0:1 |
payload object |
|
|
0:1 |
payload object |
|
must be XML CDATA |
0:1 |
payload object |
NOTES
- The
ranOn
map will be empty on insertion of the entry into the store. An update call to<tspace-write>
will merge any entries in the expressed element with those currently stored. The name of the entry should be the id of the compute resource, and the value should be the current retry count. - The payload objects given to this wrapper are serialized and assigned to the internal payload attribute. It is possible to provide this string directly as the text of a
<payload>
element, as long as it is wrapped as CDATA. With<user-facing>
, use therelativeTag.absoluteTag
syntax for expressing the object type (see 2. XML Tag Name Constraints).ncsa.tools.common.types.Configuration
is envisaged as the most common payload, so this child element may be added in the usual manner.