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.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
key |
|
(required) |
attribute of |
timestamp |
|
|
attribute of |
topic |
|
|
attribute of |
producer |
|
|
attribute of |
TAG |
TYPE |
COUNT |
DESCRIPTION |
---|---|---|---|
|
|
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 |
Event-header properties are available for matching through filters, unlike the contents of the body or payload of the event.
EVENT_CLASS
).In addition to the above, the concrete types of a LocalEvent
each have their own attributes and elements, as described below.
See Send.
Reports the status of a workflow or job.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
status |
|
|
description of state |
Finer-grained status reporting the progress of a particular task or operation.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
progress-type |
|
|
|
message |
|
|
description of the progress status |
Debugging information.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
instance |
|
|
fully qualified name plus hash-code for object which generated this debug statement |
message |
|
|
the actual debug message |
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.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
error |
|
|
description of the error |
File status or information.
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
location |
|
(required) |
URI for the physical location of the file; also added to header as |
logicalName |
|
|
logical id for the file, if any |
dateTime |
|
|
timestamp |
size |
|
0 |
in bytes, usually |
format |
|
|
format information, if any |
status |
|
|
one of |
Arbitrary properties to associate with the event's subject.
TAG |
TYPE |
COUNT |
DESCRIPTION |
---|---|---|---|
|
|
0:N |
property to add to the contents of this event |