org.wso2.carbon.deployment.engine

Interface Deployer

public interface Deployer

This interface is used to provide the custom deployment mechanism in carbon, where you can write your own Deployer to process a particular ArtifactType

A developer who wants write a deployer to process an artifact in carbon and add it to a runtime configuration, should implement this. The implementation should then be registered as an OSGi service using the Deployer interface for the DeploymentEngine to find and add to the configuration

Since:

5.0.0

Method Summary

Modifier and Type	Method and Description
Object	deploy(Artifact artifact) Process a deployable artifact and add it to the relevant runtime configuration.
ArtifactType	getArtifactType() Returns the type of the artifact that the deployer is capable of deploying.
URL	getLocation() Returns the deploy directory location associated with the deployer.
void	init() Initialize the Deployer.
void	undeploy(Object key) Remove a given artifact from the relevant runtime configuration.
Object	update(Artifact artifact) Updates a already deployed artifact and update its relevant runtime configuration.

Method Detail

init

void init()

Initialize the Deployer.

This will contain all the code that need to be called when the deployer is initialized

deploy

Object deploy(Artifact artifact)
       throws CarbonDeploymentException

Process a deployable artifact and add it to the relevant runtime configuration.

Parameters:

artifact - the Artifact object to deploy

Returns:

returns a key to uniquely identify an artifact within a runtime

Throws:

CarbonDeploymentException - - when an error occurs while doing the deployment

undeploy

void undeploy(Object key)
       throws CarbonDeploymentException

Remove a given artifact from the relevant runtime configuration.

Parameters:

key - the key of the deployed artifact used for undeploying it from the relevant runtime

Throws:

CarbonDeploymentException - - when an error occurs while running the undeployment

update

Object update(Artifact artifact)
       throws CarbonDeploymentException

Updates a already deployed artifact and update its relevant runtime configuration.

Parameters:

artifact - the Artifact object to deploy

Returns:

returns a key to uniquely identify an artifact within a runtime

Throws:

CarbonDeploymentException - - when an error occurs while doing the deployment

getLocation

URL getLocation()

Returns the deploy directory location associated with the deployer.

It can be relative to CARBON_HOME or an abosolute path Eg : webapps, dataservices, sequences or /dev/wso2/deployment/repository/ or file:/dev/wso2/deployment/repository/

Returns:

deployer directory location

getArtifactType

ArtifactType getArtifactType()

Returns the type of the artifact that the deployer is capable of deploying. Eg : webapp, dataservice

Returns:

ArtifactType object which contains info about the artifact type

See Also:

ArtifactType