org.wso2.carbon.deployment.engine

Interface DeploymentService

public interface DeploymentService

User level API's for consuming DeploymentEngine functionality. This will be registered as an OSGI service so that users can reference this in their component.

If the given artifact type is not recognized at DeploymentEngine level or there is no deployer associated with the give artifact type, then these API's will result in unknown artifact type error.

Since:

5.0.0

Method Summary

Modifier and Type	Method and Description
void	deploy(String artifactPath, ArtifactType artifactType) User can call this method externally to deploy an artifact by giving the artifact deployment directory and the path.
void	redeploy(Object key, ArtifactType artifactType) When you want to redeploy/update an artifact, this method can be called by giving the key, which uniquely identifies an artifact in a runtime and the artifact deployment directory.
void	undeploy(Object key, ArtifactType artifactType) When you want to undeploy an artifact, this method can be called by giving the key, which uniquely identifies an artifact in a runtime and the artifact deployment directory.

Method Detail

deploy

void deploy(String artifactPath,
            ArtifactType artifactType)
     throws CarbonDeploymentException

User can call this method externally to deploy an artifact by giving the artifact deployment directory and the path.

Parameters:

artifactPath - path where the artifact resides. This has to be the full qualified path of the artifact

artifactType - the type of the artifact going to be dpeloyed Eg : webapp, dataservice, sequence

Throws:

CarbonDeploymentException - - on error while trying deploy the given artifact info

See Also:

ArtifactType

undeploy

void undeploy(Object key,
              ArtifactType artifactType)
       throws CarbonDeploymentException

When you want to undeploy an artifact, this method can be called by giving the key, which uniquely identifies an artifact in a runtime and the artifact deployment directory.

Parameters:

key - artifact key to uniquely identify an artifact in a runtime Eg: for webapps this can be webapp context such as /foo , /bar, etc for service this can be service name such as EchoService, VersionService, etc

artifactType - the type of the artifact going to be deployed Eg : webapp, dataservice, sequence

Throws:

CarbonDeploymentException - - on error while trying undeploy the given artifact info

See Also:

ArtifactType

redeploy

void redeploy(Object key,
              ArtifactType artifactType)
       throws CarbonDeploymentException

When you want to redeploy/update an artifact, this method can be called by giving the key, which uniquely identifies an artifact in a runtime and the artifact deployment directory.

Parameters:

key - artifact key to uniquely identify an artifact in a runtime Eg: for webapps this can be webapp context such as /foo , /bar, etc for service this can be service name such as EchoService, VersionService, etc

artifactType - the type of the artifact going to be deployed Eg : webapp, dataservice, sequence

Throws:

CarbonDeploymentException - - on error while trying redeploy the given artifact info

See Also:

ArtifactType