net.bpelunit.framework.control.ext
Interface IBPELDeployer


public interface IBPELDeployer

The IBPELDeployer interface represents a BPEL Deployer, i.e. an entity which is responsible for deploying a given BPEL process into an engine, and also for undeploying it. This interface is intended to be implemented by deployers for concrete engine implementations. Please note that to be recognized by BPELUnit, new deployers must be registered in the concrete BPELUnit runner instance (for example, in the command line runner, the deployer must be added to the configuration.xml file, which resides in the BPELUnit configuration directory). For each deployed PUT, a new instance will be created. It is thus safe to store undeployment data in the deployer instance.

Version:
$Id$
Author:
Philip Mayer

Method Summary
 void deploy(java.lang.String testPath, net.bpelunit.framework.model.ProcessUnderTest processUnderTest)
          Deploy the PUT.
 void setConfiguration(java.util.Map<java.lang.String,java.lang.String> options)
          Adds configuration options for this deployment instance.
 void undeploy(java.lang.String testPath, net.bpelunit.framework.model.ProcessUnderTest processUnderTest)
          Undeploy the PUT.
 

Method Detail

deploy

void deploy(java.lang.String testPath,
            net.bpelunit.framework.model.ProcessUnderTest processUnderTest)
            throws net.bpelunit.framework.exception.DeploymentException
Deploy the PUT. This method must block until the PUT is fully deployed and ready to accept incoming calls. In case of an error, a DeploymentException must be thrown.

Parameters:
testPath - path in the file system to the test files
processUnderTest - the PUT
Throws:
net.bpelunit.framework.exception.DeploymentException

undeploy

void undeploy(java.lang.String testPath,
              net.bpelunit.framework.model.ProcessUnderTest processUnderTest)
              throws net.bpelunit.framework.exception.DeploymentException
Undeploy the PUT. This method may return when undeployment is triggered, however it is good practise to only return after the PUT has been fully undeployed. This method may be called by the framework even if deployment did not succeed. In case of an error, a DeploymentException must be thrown.

Parameters:
testPath - path in the file system to the test files
processUnderTest - the PUT
Throws:
net.bpelunit.framework.exception.DeploymentException

setConfiguration

void setConfiguration(java.util.Map<java.lang.String,java.lang.String> options)
Adds configuration options for this deployment instance. The configuration options are loaded from the test suite document. This method is called before any of the other methods.

Parameters:
options - the options