net.kalio.empweb.engine
Class ProcessDefinition

java.lang.Object
  net.kalio.empweb.engine.ProcessDefinition

public class ProcessDefinition
extends java.lang.Object

Title: ProcessDefinition

Description: A Java representation of a transaction pipeline's "process", "rule", or "finally" element. This object's invokeProcess() prepares the call to a Process.execute() and it interprets the different results and exceptions of the Process.execute() and converts everything to suitabble ProcessResult's which are returned to the TransactionEngine.

Copyright: Copyright (c) 2004

Company: Kalio

Version:

1.0

Author:

Barzilai Spinak

Field Summary

(package private) java.lang.String	bundle
(package private) java.lang.String	className
(package private) java.util.LinkedHashMap	defaultLimits
(package private) boolean	enabled
(package private) java.lang.Class	implementingClass
(package private) TransactionPipeline	myTransPipeline
(package private) java.lang.String	name
(package private) java.util.LinkedHashMap	params
(package private) Process	process
(package private) java.lang.String	processType

Constructor Summary

ProcessDefinition(TransactionPipeline owner, org.w3c.dom.Element d)

Method Summary

java.util.Map	getDefaultLimits() Returns a Map of the limits used by this Process, along with their default values
(package private) ProcessResult	invokeProcess(TransactionContext context) Invokes the associated Process' execute method.
boolean	isFinally()
boolean	isProcess()
boolean	isRule()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

myTransPipeline

TransactionPipeline myTransPipeline

processType

java.lang.String processType

name

java.lang.String name

enabled

boolean enabled

bundle

java.lang.String bundle

className

java.lang.String className

implementingClass

java.lang.Class implementingClass

process

Process process

defaultLimits

java.util.LinkedHashMap defaultLimits

params

java.util.LinkedHashMap params

Constructor Detail

ProcessDefinition

public ProcessDefinition(TransactionPipeline owner,
                         org.w3c.dom.Element d)
                  throws XMLConfigurationException,
                         ConfigurationException

Throws:

XMLConfigurationException

ConfigurationException

Method Detail

isRule

public boolean isRule()

isFinally

public boolean isFinally()

isProcess

public boolean isProcess()

getDefaultLimits

public java.util.Map getDefaultLimits()

Returns a Map of the limits used by this Process, along with their default values

invokeProcess

ProcessResult invokeProcess(TransactionContext context)

Invokes the associated Process' execute method. It passes the TransactionContext to the associated Process, adding the parameters and defaultLimits specified in the transaction pipeline XML as java.util.Map's into the TransactionContext.

• If Process.execute() returns null (it shouldn't!), it treats it as a success and it returns a successfull ProcessResult.
• If Process.execute() throws an EngineException it converts it to an unsuccessful ProcessResult with its Msg key and parameters taken from the EngineException and the key's bundle being the one returned by Bundles.getEngine() (usually "core.engine").
• If Process.execute() throws unhandled, general Exception it works similarly as the above case but it uses the "ewengine_Exception" key with the needed parameters (exception type, full class name, method name, source java file and line number).
• If Process.execute() returns a ProcessResult which includes an EngineResult.Msg, it follows the following logic (let's call the Msg "m").

   if ( m.isi18nKey() and m.getBundle() == null) then  // It's a key with no bundle!!
       if (the pipeline's element rule or process specifies bundle "xxx") then
           m.setBundle("xxx")
       else
           // we assume it's an Empweb core process. We need to set a bundle somehow!
           m.setBundle(Bundles.getEngine())
           prefix the key value with the Process' full.Class.Name
       end if
   end if
  
   return the ProcessResult.
   

So this method never returns null and it handles *ALL* possible Exceptions and turns them into a ProcessResult. It should never throw an Exception.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object