Package oracle.fabric.common
Interface BusinessEvent
public interface BusinessEvent
An in-memory representation of a Business Event. Each event has a name which is represented
as a QName. The (optional) body of the event is an XML fragment. It also has named headers. Each
header can have multiple values.
The schema for event bodies and description of its headers are described in an XML Event Description
Language (EDL).
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringEvent Context.static final StringDurability of event subscription.static final StringFlag indicates if the event is published by EDN Bus.static final StringStandard header name.static final StringLocal name of event.static final StringMode of event.static final Stringstatic final StringNamespace of event.static final StringOwner of event.static final StringStandard header name.static final Stringstatic final StringPersistent delivery mode of event.static final StringEvent priority for deliverystatic final intDefault (normal) event delivery priority value.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringEvent's published time.static final StringSource of event.static final StringTim of Live of event.static final String -
Method Summary
Modifier and TypeMethodDescriptiongetAsDoc()Return the event as a DOM document.getBody()Get the XML body of the event.Get the payload body as serialized XML text.The name of the Event.Get all the properties of this event.getProperty(String name) Get a single value for a header.
-
Field Details
-
NAME
- See Also:
-
EVENT_ID
Standard header name. The "id" of an event will be unique and will be set when the event is sent.- See Also:
-
PARENT_ID
Standard header name. The "parent id" of an even is the "id" of the event being processed when this event was published or raised -- if there was one.- See Also:
-
PRIORITY
Event priority for delivery- See Also:
-
PUBLISHED_TIME
Event's published time.- See Also:
-
OWNER
Owner of event.- See Also:
-
SOURCE
Source of event.- See Also:
-
CONTEXT
Event Context.- See Also:
-
MODE
Mode of event.- See Also:
-
NAMESPACE
Namespace of event.- See Also:
-
LOCAL_NAME
Local name of event.- See Also:
-
TIME_TO_LIVE
Tim of Live of event.- See Also:
-
PERSISTENT
Persistent delivery mode of event.- See Also:
-
DURABLE
Durability of event subscription.- See Also:
-
EDN_BUS_PUBLISHED
Flag indicates if the event is published by EDN Bus. value: true/false when true - the event is published by EDN Bus when false - the event is NOT published by EDN Bus, e.g. by EDN java client, EDN PL/SQL client, etc. when the property not present - false is assumed.- See Also:
-
PROPERTY_ECID
- See Also:
-
PROPERTY_PARENT_COMPONENT_INSTANCE_ID
- See Also:
-
PROPERTY_CONVERSATION_ID
- See Also:
-
PROPERTY_COMPOSITE_INSTANCE_ID
- See Also:
-
COMPOSITE_INSTANCE_CREATED_TIME
- See Also:
-
TRACKING_IS_EDN_EVENT
- See Also:
-
PAYLOAD_NAME
- See Also:
-
PRIORITY_NORMAL
static final int PRIORITY_NORMALDefault (normal) event delivery priority value.- See Also:
-
-
Method Details
-
getEventName
QName getEventName()The name of the Event. This will correspond to the name given in the event's EDL.- Returns:
- The name of the event
-
getProperty
Get a single value for a header. If the header has multiple values, the result of this method is a random one.- Parameters:
name- - property name- Returns:
- A value for the given header name or null if there are no values for this header
-
getProperties
Get all the properties of this event.- Returns:
- all the properties of this event.
-
getBody
Element getBody()Get the XML body of the event. Since the body is optional, this value may be null.- Returns:
- The body payload as DOM element.
-
getBodyAsText
String getBodyAsText()Get the payload body as serialized XML text. Since the body is optional, this value may be null.- Returns:
- The body payload as text.
-
getAsDoc
Document getAsDoc()Return the event as a DOM document.- Returns:
- the event as a DOM document.
-