|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject org.obe.spi.event.ApplicationEvent
Delivers an external event from a third party application or source. This is OBE's primary asynchronous integration mechanism.
ApplicationEventBroker
,
ApplicationEventListener
,
Serialized FormField Summary | |
static java.lang.String |
ACTION
|
static java.lang.String |
CONTENT_TYPE
|
protected static java.io.Serializable[] |
EMPTY_KEYS
|
protected static java.util.Map |
EMPTY_MAP
|
static java.lang.String |
EXCEPTION_EVENT
|
static java.lang.String |
SCHEMA
|
static java.lang.String |
TIMEOUT_EVENT
|
Fields inherited from class java.util.EventObject |
source |
Constructor Summary | |
ApplicationEvent(java.lang.Object applicationContext,
java.lang.Object source,
java.lang.String eventType,
java.io.Serializable[] keys,
java.lang.String contentType,
java.lang.String schema,
java.util.Map properties,
java.util.Date expiration)
Constructs an application event object. |
|
ApplicationEvent(java.lang.Object source,
java.lang.String contentType,
java.lang.String schema,
java.util.Map properties)
Constructs an application event object. |
Method Summary | |
java.lang.String |
getAction()
Returns the name of the JAF command which raised this event. |
java.lang.Object |
getApplication()
Returns the application context. |
java.lang.String |
getContentType()
Returns the MIME content type of the event data. |
java.lang.String |
getEventType()
Returns the business name for the application event. |
java.util.Date |
getExpiry()
Returns the expiry date for the event. |
java.io.Serializable[] |
getKeys()
Returns the key values for the payload. |
java.util.Map |
getProperties()
Returns a map of all custom attributes associated with the payload. |
java.lang.Object |
getProperty(java.lang.String key)
Returns a custom attribute associated with the payload. |
java.lang.String |
getSchema()
The name of the abstract schema for the payload (the source object). |
void |
setApplication(java.lang.Object application)
Sets the application context. |
void |
setEventType(java.lang.String eventType)
Sets the event type. |
void |
setExpiry(java.util.Date expiry)
Sets the expiry date for the event. |
void |
setKeys(java.io.Serializable[] keys)
Sets the keys for the payload. |
java.lang.String |
toString()
|
Methods inherited from class java.util.EventObject |
getSource |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String CONTENT_TYPE
public static final java.lang.String SCHEMA
public static final java.lang.String ACTION
public static final java.lang.String TIMEOUT_EVENT
public static final java.lang.String EXCEPTION_EVENT
protected static final java.util.Map EMPTY_MAP
protected static final java.io.Serializable[] EMPTY_KEYS
Constructor Detail |
public ApplicationEvent(java.lang.Object source, java.lang.String contentType, java.lang.String schema, java.util.Map properties)
source
- The source object on which the event occurred.contentType
- The MIME content type of the source
object. Cannot be null
.schema
- The schema for the source
object. Cannot be
null
.properties
- Additional properties describing the event. Optional.public ApplicationEvent(java.lang.Object applicationContext, java.lang.Object source, java.lang.String eventType, java.io.Serializable[] keys, java.lang.String contentType, java.lang.String schema, java.util.Map properties, java.util.Date expiration)
applicationContext
- An arbitrary application context.source
- The source object on which the event occurred.eventType
- The event type, as registered in the
ApplicationEventBroker
. Cannot be null
.keys
- The key values, calculated from the source
object according to the definition for id
.contentType
- The MIME content type of the source
object. Cannot be null
.schema
- The schema for the source
object. Cannot be
null
.properties
- Additional properties describing the event.expiration
- The date/time at which this event expires: the system
will remove the event from storage at that time. If null
,Method Detail |
public java.lang.String getAction()
null
indicates the default
command.public java.lang.String getContentType()
text/xml
; an MS-Word document would be
application/msword
, a Java object would use the extension
type application/x-java-object
, and so on.
getSchema()
public java.lang.String getEventType()
ApplicationEventBroker.createEventType(org.obe.client.api.repository.EventTypeMetaData)
.
public void setEventType(java.lang.String eventType)
eventType
- Event type. Must be a valid business event type as
registered in the ApplicationEventBroker
.
java.lang.IllegalArgumentException
- if eventType is null
.public java.lang.String getSchema()
text/xml
would be the URI of the schema
location or the Public or System ID of its DTD; if these are undefined,
the tag name of the document element. The schema for a Java object is
simply its fully qualified class name, or possibly the name of an
interface that it implements.
getContentType()
public java.io.Serializable[] getKeys()
public void setKeys(java.io.Serializable[] keys)
keys
- Event keys.public java.lang.Object getProperty(java.lang.String key)
key
- The attribute name.
public java.util.Map getProperties()
getProperty(java.lang.String)
public java.lang.Object getApplication()
EngineContext.getApplication()
method.
public void setApplication(java.lang.Object application)
application
- The application context.public java.util.Date getExpiry()
public void setExpiry(java.util.Date expiry)
expiry
- Expiry date or null
if the event should not
be stored for subsequent consumption.public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |