org.imixs.workflow.jee.plugins
Class AbstractPlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin
      org.imixs.workflow.jee.plugins.AbstractPlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

Direct Known Subclasses:

MailPlugin, VersionPlugin

public abstract class AbstractPlugin
extends org.imixs.workflow.plugins.AbstractPlugin

This abstract class implements a basic set of functions for implementing plugins with Interfaces to JEE API

Author:

Ralph Soika

Field Summary

Fields inherited from class org.imixs.workflow.plugins.AbstractPlugin

ctx

Fields inherited from interface org.imixs.workflow.Plugin

PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

Constructor Summary

AbstractPlugin()

Method Summary

abstract void	close(int status)
String	getUserName() determines the current username (callerPrincipal)
void	init(org.imixs.workflow.WorkflowContext actx) Initialize Plugin and get an instance of the EJB Session Context
abstract int	run(org.imixs.workflow.ItemCollection documentContext, org.imixs.workflow.ItemCollection documentActivity)

Methods inherited from class org.imixs.workflow.plugins.AbstractPlugin

formatItemValues, getAbbreviateName, getCommonName, replaceDynamicValues

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

init

public void init(org.imixs.workflow.WorkflowContext actx)
          throws Exception

Initialize Plugin and get an instance of the EJB Session Context

Specified by:

init in interface org.imixs.workflow.Plugin

Overrides:

init in class org.imixs.workflow.plugins.AbstractPlugin

Throws:

Exception

run

public abstract int run(org.imixs.workflow.ItemCollection documentContext,
                        org.imixs.workflow.ItemCollection documentActivity)
                 throws Exception

Throws:

Exception

close

public abstract void close(int status)
                    throws Exception

Throws:

Exception

getUserName

public String getUserName()

determines the current username (callerPrincipal)

Returns: