<local-event>

Corresponds to the abstract class ncsa.tools.events.types.events.LocalEvent defining an event used in the various ncsa.tools and ncsa.services packages. This is basically a wrapper for event-like information which is not necessarily destined for remote transport but which could be consumed locally/internally; the object is entirely decoupled from any transport APIs or implementations (our preferred implementation is JMS; that layer is handled by a separate plug-in).

A LocalEvent extends the ncsa.tools.events.types.events.LocalEventHeader class, which in turn extends the ncsa.tools.events.types.events.LocalEventBase class shared with the ncsa.tools.events.types.events.LocalEventHeaderComparator class used in the LocalEventFilter.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

key

java.lang.String

(required)

attribute of LocalEventBase: a unique identifier for the subject of the event; usually a string representation of a ParsedLocalEventKey

timestamp

java.lang.Long

null

attribute of LocalEventBase: usually set at the point the event is generated

topic

java.lang.String

null

attribute of LocalEvent: topic under which event is published

producer

java.lang.String

null

attribute of LocalEvent: special identifier (URL) for point of origin; added as a header property (= PRODUCER_URL)

Elements

TAG

TYPE

COUNT

DESCRIPTION

<header-property>

ncsa.tools.common.types.Property

0:N

property types are limited to strings and primitives; the distinction between primitive and wrapper is not maintained in case of translation in and out of the LocalEvent classes.

Event-header properties are available for matching through filters, unlike the contents of the body or payload of the event.

NOTES

  • Header properties are sorted in ascending lexicographic order, so they will always appear in the same position.
  • The fully-qualified class name of the event type is added automatically as a header property (= EVENT_CLASS).
  • The sub-parts of the key (see ParsedLocalEventKey) are automatically added as header properties as well.

In addition to the above, the concrete types of a LocalEvent each have their own attributes and elements, as described below.

Examples

See Send.

<status-event>

Reports the status of a workflow or job.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

status

java.lang.String

null

description of state

<progress-event>

Finer-grained status reporting the progress of a particular task or operation.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

progress-type

java.lang.String

null

boolean, ranged or text (see also StreamSegmentTriggeredAction and FileMetadataTriggeredAction)

message

java.lang.String

null

description of the progress status

<debug-event>

Debugging information.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

instance

java.lang.String

null

fully qualified name plus hash-code for object which generated this debug statement

message

java.lang.String

null

the actual debug message

<error-event>

Error information/exception trace. Full stack-trace reporting is only available internally, but the event can be scripted to be sent with a simple error message.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

error

java.lang.String

null

description of the error

<file-event>

File status or information.

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

location

java.lang.String

(required)

URI for the physical location of the file; also added to header as OBJECT URI property

logicalName

java.lang.String

null

logical id for the file, if any

dateTime

java.lang.String

null

timestamp

size

long

0

in bytes, usually

format

java.lang.String

null

format information, if any

status

java.lang.String

PRODUCED

one of CONSUMED, PRODUCED or TRANSFERRED

<property-event>

Arbitrary properties to associate with the event's subject.

Elements

TAG

TYPE

COUNT

DESCRIPTION

<payload-property>

ncsa.tools.common.types.Property

0:N

property to add to the contents of this event
  • No labels