Java Doc for ApplicationEvent.java in  » Workflow-Engines » obe-1.0 » org » obe » spi » event » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » obe 1.0 » org.obe.spi.event 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.util.EventObject
      org.obe.spi.event.ApplicationEvent

All known Subclasses:   org.obe.spi.event.WorkflowEvent,
ApplicationEvent
public class ApplicationEvent extends EventObject (Code)
Delivers an external event from a third party application or source. This is OBE's primary asynchronous integration mechanism.
author:
   Adrian Price
See Also:   ApplicationEventBroker
See Also:   ApplicationEventListener


Field Summary
final public static  StringACTION
    
final public static  StringCONTENT_TYPE
    
final protected static  Serializable[]EMPTY_KEYS
    
final protected static  MapEMPTY_MAP
    
final public static  StringEXCEPTION_EVENT
    
final public static  StringSCHEMA
    
final public static  StringTIMEOUT_EVENT
    

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 sourceobject.
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.

Method Summary
public  StringgetAction()
     Returns the name of the JAF command which raised this event.
public  ObjectgetApplication()
     Returns the application context.
public  StringgetContentType()
     Returns the MIME content type of the event data.
public  StringgetEventType()
     Returns the business name for the application event.
public  DategetExpiry()
     Returns the expiry date for the event.
public  Serializable[]getKeys()
     Returns the key values for the payload.
public  MapgetProperties()
     Returns a map of all custom attributes associated with the payload.
public  ObjectgetProperty(String key)
     Returns a custom attribute associated with the payload.
public  StringgetSchema()
     The name of the abstract schema for the payload (the source object).
public  voidsetApplication(Object application)
     Sets the application context.
public  voidsetEventType(String eventType)
     Sets the event type.
Parameters:
  eventType - Event type.
public  voidsetExpiry(Date expiry)
     Sets the expiry date for the event.
public  voidsetKeys(Serializable[] keys)
     Sets the keys for the payload.
public  StringtoString()
    

Field Detail
ACTION
final public static String ACTION(Code)



CONTENT_TYPE
final public static String CONTENT_TYPE(Code)



EMPTY_KEYS
final protected static Serializable[] EMPTY_KEYS(Code)



EMPTY_MAP
final protected static Map EMPTY_MAP(Code)



EXCEPTION_EVENT
final public static String EXCEPTION_EVENT(Code)



SCHEMA
final public static String SCHEMA(Code)



TIMEOUT_EVENT
final public static String TIMEOUT_EVENT(Code)




Constructor Detail
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 sourceobject. 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 sourceobject according to the definition for id.
Parameters:
  contentType - The MIME content type of the sourceobject. 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,




Method Detail
getAction
public String getAction()(Code)
Returns the name of the JAF command which raised this event. JAF command name, null indicates the defaultcommand.



getApplication
public Object getApplication()(Code)
Returns the application context. This object is accessible through the EngineContext.getApplication method. Application context.



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



getEventType
public String getEventType()(Code)
Returns the business name for the application event. This must have been registered in the application event broker by a prior call to ApplicationEventBroker.createEventType . The event type.



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.



setEventType
public void setEventType(String eventType)(Code)
Sets the event type.
Parameters:
  eventType - Event type. Must be a valid business event type asregistered in the ApplicationEventBroker.
throws:
  IllegalArgumentException - if eventType is null.



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.



toString
public String toString()(Code)



Fields inherited from java.util.EventObject
protected transient Object source(Code)(Java Doc)

Methods inherited from java.util.EventObject
public Object getSource()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.