Proposal for Workflow Package

(0) Rationale

Modern application architecture and design practices recommend the concept of "composition" (of existing modules and components) in the assembly of an overall application, to maximize the resuse of previously built functionality. However, it is still generally necessary to write original code that "glues" the components together. It would be useful if individuals familiar with the business requirements of their systems could create "scripts" to represent the linkages between components, rather than requiring Java code. The Workflow proposal intends to create support for just such a capability.

Scripted workflows is an idea that can be used in many different application environments and use cases. In particular, a highly desired use is in managing the interaction with web application users, where the transaction being performed requires more than one HTML page to be displayed. However, the Workflow implementation will be strictly layered so that the underlying scripting engine can be used without any reliance on web layer APIs

(1) Scope of the Package

The Workflow project shall create and maintain an engine to manage and execute scripts, codified in XML. The basic engine shall be environment independent, but specialized implementations of the basic engine can adapt the engine to that environment.

One specialized implementation will be included in the Workflow package itself - an adapter to integrate the workflow engine into the web layer, by mapping the Workflow concept of bean scopes into the scopes provided by the Servlet API (request, session, and application). This implementation will be independent of any particular web application framework - it is expected that frameworks will further specialize the web layer implementation in order to integrate the framework's own capabilities and features.

Scripts for the workflow engine will be codified in XML. It shall be possible for specialized implementations to register their own sets of custom Step implementations, under a specific XML namespace, to transparently extend the set of built in Step implementations that is available to workflow engine users.

(1.5) Interaction With Other Packages

Digester relies on:

• Java Development Kit (Version 1.2 or later)
• A JAXP 1.1 implementation
• A SAX 2.0 parser conforming to the JAXP 1.1 APIs
• BeanUtils from Commons - for instrospection information
• Collections from Commons - for object collections
• Digester from Commons - for parsing scripts in XML
• Servlet API - for web integration layer only

(2) Initial Source of the Package

This package represents a new approach to the workflow management process, so no initial codebase has been identified.

The proposed package name for the new component is org.apache.commons.workflow, with subpackages for implementations of the basic interfaces.

(3) Required Jakarta-Commons Resources

• SVN repository - New directory workflow in the jakarta-commons SVN repository.
• Mailing List - Discussions will take place on the general jakarta-commons@jakarta.apache.org mailing list. To help list subscribers identify messages of interest, it is suggested that the message subject of messages about this component be prefixed with [Workflow].
• Bugzilla - New component "Workflow" under the "Commons" product category, with appropriate version identifiers as needed.
• Jyve FAQ - New category "commons-workflow" (when available).

(4) Initial Committers

The initial committers on the Workflow component shall be:

• Craig R. McClanahan
• TBD