| java.lang.Object java.util.EventObject org.obe.spi.event.ApplicationEvent
All known Subclasses: org.obe.spi.event.WorkflowEvent,
Constructor Summary | |
public | ApplicationEvent(Object source, String contentType, String schema, Map properties) Constructs an application event object.
Parameters: source - The source object on which the event occurred. Parameters: contentType - The MIME content type of the source object. | public | ApplicationEvent(Object applicationContext, Object source, String eventType, Serializable[] keys, String contentType, String schema, Map properties, Date expiration) Constructs an application event object.
Parameters: applicationContext - An arbitrary application context. Parameters: source - The source object on which the event occurred. Parameters: eventType - The event type, as registered in theApplicationEventBroker. |
EMPTY_MAP | final protected static Map EMPTY_MAP(Code) | | |
EXCEPTION_EVENT | final public static String EXCEPTION_EVENT(Code) | | |
ApplicationEvent | public ApplicationEvent(Object source, String contentType, String schema, Map properties)(Code) | | Constructs an application event object.
Parameters: source - The source object on which the event occurred. Parameters: contentType - The MIME content type of the source object. Cannot be null . Parameters: schema - The schema for the source object. Cannot benull . Parameters: properties - Additional properties describing the event. Optional. |
ApplicationEvent | public ApplicationEvent(Object applicationContext, Object source, String eventType, Serializable[] keys, String contentType, String schema, Map properties, Date expiration)(Code) | | Constructs an application event object.
Parameters: applicationContext - An arbitrary application context. Parameters: source - The source object on which the event occurred. Parameters: eventType - The event type, as registered in theApplicationEventBroker. Cannot be null . Parameters: keys - The key values, calculated from the source object according to the definition for id . Parameters: contentType - The MIME content type of the source object. Cannot be null . Parameters: schema - The schema for the source object. Cannot benull . Parameters: properties - Additional properties describing the event. Parameters: expiration - The date/time at which this event expires: the systemwill remove the event from storage at that time. If null , |
getAction | public String getAction()(Code) | | Returns the name of the JAF command which raised this event.
JAF command name, null indicates the defaultcommand. |
getContentType | public String getContentType()(Code) | | Returns the MIME content type of the event data. The
content type indicates the type of object in the payload. For
example, an XML document would have a content type of
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.
The MIME content type. See Also: ApplicationEvent.getSchema |
getExpiry | public Date getExpiry()(Code) | | Returns the expiry date for the event.
The expiry date. |
getKeys | public Serializable[] getKeys()(Code) | | Returns the key values for the payload. The application event broker
calculates the key values from the payload by evaluating the key value
expressions in the event type definition.
Key values for the payload. |
getProperties | public Map getProperties()(Code) | | Returns a map of all custom attributes associated with the payload.
Attribute map, keyed on attribute name. See Also: ApplicationEvent.getProperty |
getProperty | public Object getProperty(String key)(Code) | | Returns a custom attribute associated with the payload. Custom
attributes provide additional metadata about the payload.
Parameters: key - The attribute name. The attribute value, if defined. |
getSchema | public String getSchema()(Code) | | The name of the abstract schema for the payload (the source object). The
interpretation depends on the content type. For example, the schema for a
content type of 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.
The abstract schema name. See Also: ApplicationEvent.getContentType |
setApplication | public void setApplication(Object application)(Code) | | Sets the application context.
Parameters: application - The application context. |
setExpiry | public void setExpiry(Date expiry)(Code) | | Sets the expiry date for the event.
Parameters: expiry - Expiry date or null if the event should notbe stored for subsequent consumption. |
setKeys | public void setKeys(Serializable[] keys)(Code) | | Sets the keys for the payload.
Parameters: keys - Event keys. |
|
|