Author: heiko.braun(a)jboss.com Date: 2009-03-10 10:34:09 -0400 (Tue, 10 Mar 2009) New Revision: 4216 Modified: jbpm4/branches/hbraun/modules/integration/jboss4/src/main/java/org/jbpm/integration/jboss4/JBPMDeployer.java jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMDeployer.java jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMMetaDataDeployer.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/DeploymentAdaptor.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMService.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMServiceLocator.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessDeploymentRef.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineObjectFactory.java jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineReference.java Log: API docs Modified: jbpm4/branches/hbraun/modules/integration/jboss4/src/main/java/org/jbpm/integration/jboss4/JBPMDeployer.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/jboss4/src/main/java/org/jbpm/integration/jboss4/JBPMDeployer.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/jboss4/src/main/java/org/jbpm/integration/jboss4/JBPMDeployer.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -35,6 +35,11 @@ import java.util.ArrayList; /** + * An AS 4.2.x deployer for jBPM4 process archives. + * Delegates to {@link org.jbpm.integration.spi.DeploymentAdaptor}. + * The deployer retains a {@link org.jbpm.integration.spi.ProcessDeploymentRef} + * for subsequent undeployment calls. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class JBPMDeployer extends SubDeployerSupport Modified: jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMDeployer.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMDeployer.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMDeployer.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -33,13 +33,11 @@ import java.util.List; /** - * Deploys JBPM processes and associates a classloader. - * <p> - * Upon undeployment the existance of the deployment artifact will be checked, - * and if deleted, the process will be removed. - * - * @see org.jbpm.integration.spi.JBPMServiceLocator - * + * An AS 5.0.x deployer for jBPM4 process archives. + * Delegates to {@link org.jbpm.integration.spi.DeploymentAdaptor}. + * The deployer retains a {@link org.jbpm.integration.spi.ProcessDeploymentRef} + * for subsequent undeployment calls. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class JBPMDeployer extends AbstractSimpleVFSRealDeployer<JBPMDeploymentMetaData> Modified: jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMMetaDataDeployer.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMMetaDataDeployer.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/jboss5/src/main/java/org/jbpm/integration/jboss5/JBPMMetaDataDeployer.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -29,6 +29,7 @@ /** * Prepares {@link org.jbpm.integration.spi.JBPMDeploymentMetaData} + * which will be consumed by {@link org.jbpm.integration.jboss5.JBPMDeployer} * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/DeploymentAdaptor.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/DeploymentAdaptor.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/DeploymentAdaptor.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -34,7 +34,7 @@ import java.util.List; /** - * Adopts AS 4 and AS 5 deployer invocation to jBPM invocations. + * Adopts AS 4 and AS 5 deployer invocations to jBPM invocations. * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMService.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMService.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMService.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -24,7 +24,7 @@ import org.jbpm.ProcessEngine; /** - * A JBPM service implementation + * A JBPM service implementation that will be installed into the AS kernel. * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMServiceLocator.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMServiceLocator.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/JBPMServiceLocator.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -24,6 +24,9 @@ import org.jbpm.integration.util.KernelAwareSPIFactory; /** + * Locates a {@link org.jbpm.integration.spi.JBPMService} + * through the {@link org.jbpm.integration.util.KernelAwareSPIFactory} + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class JBPMServiceLocator Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessDeploymentRef.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessDeploymentRef.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessDeploymentRef.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -22,6 +22,8 @@ package org.jbpm.integration.spi; /** + * Retains with a deployer for undeployment calls. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public final class ProcessDeploymentRef Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineObjectFactory.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineObjectFactory.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineObjectFactory.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -31,6 +31,8 @@ import java.util.Hashtable; /** + * Constructs a {@link org.jbpm.ProcessEngine} on the JNDI client side. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class ProcessEngineObjectFactory implements ObjectFactory Modified: jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineReference.java =================================================================== --- jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineReference.java 2009-03-10 14:27:08 UTC (rev 4215) +++ jbpm4/branches/hbraun/modules/integration/spi/src/main/java/org/jbpm/integration/spi/ProcessEngineReference.java 2009-03-10 14:34:09 UTC (rev 4216) @@ -29,6 +29,9 @@ import javax.naming.StringRefAddr; /** + * Stored in JNDI. Will be used to reference a {@link org.jbpm.ProcessEngine} + * when the {@link org.jbpm.integration.spi.ProcessEngineObjectFactory} is invoked. + * * @author Heiko.Braun <heiko.braun(a)jboss.com&gt; */ public class ProcessEngineReference implements Referenceable