<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

java.lang.Integer

null

set by the store when entry is first written

producer

java.lang.String

null

source of the tuple

consumer

java.lang.String

null

destined user of the tuple

typeName0

java.lang.String

null

an arbitrary type name to match

typeName1

java.lang.String

null

an arbitrary type name to match

typeName2

java.lang.String

null

an arbitrary type name to match

typeName3

java.lang.String

null

an arbitrary type name to match

typeName4

java.lang.String

null

an arbitrary type name to match

typeValue0

java.lang.String

null

value of type name 0 to match

typeValue1

java.lang.String

null

value of type name 1 to match

typeValue2

java.lang.String

null

value of type name 2 to match

typeValue3

java.lang.String

null

value of type name 3 to match

typeValue4

java.lang.String

null

value of type name 4 to match

indexName0

java.lang.String

null

an arbitrary index name to match

indexName1

java.lang.String

null

an arbitrary index name to match

indexName2

java.lang.String

null

an arbitrary index name to match

indexName3

java.lang.String

null

an arbitrary index name to match

indexName4

java.lang.String

null

an arbitrary index name to match

indexValue0

java.lang.Integer

null

value of index name 0 to match

indexValue1

java.lang.Integer

null

value of index name 0 to match

indexValue2

java.lang.Integer

null

value of index name 0 to match

indexValue3

java.lang.Integer

null

value of index name 0 to match

indexValue4

java.lang.Integer

null

value of index name 0 to match

payloadType

java.lang.String

null

type (Java class) the serialized payload corresponds to

extensionPoint

java.lang.String

null

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 either ncsa.tools.common.elementType or ncsa.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

java.lang.Long

null

set by the store when entry is first written

timeTaken

java.lang.Long

null

set by the store when entry is taken; setting this to null and passing the entry to the write method will make the tuple available for being taken again

timeCompleted

java.lang.Long

null

setting this and passing the entry to the write method will cause the tuple to be removed from the space

takeIntervalLimit

java.lang.Long

null

the limit on how long this tuple should remain in a given "taken" state

allowedRetries

int

null

number of times it is permitted to retake this tuple

retried

int

null

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

<ran-on>

java.util.Map

0:1

add these compute resources to the list of resources this entry has been (unsuccessfully) executed on

<configuration>

ncsa.tools.common.types.Configuration

0:1

payload object

<user-facing>

ncsa.tools.common.UserFacing

0:1

payload object

<payload>

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 the relativeTag.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.
  • No labels