org.apache.synapse.deployers

Class APIDeployer

java.lang.Object

org.apache.axis2.deployment.AbstractDeployer

org.apache.synapse.deployers.AbstractSynapseArtifactDeployer

org.apache.synapse.deployers.APIDeployer

All Implemented Interfaces:

org.apache.axis2.deployment.Deployer

public class APIDeployer
extends AbstractSynapseArtifactDeployer

Field Summary

Fields inherited from class org.apache.synapse.deployers.AbstractSynapseArtifactDeployer

cfgCtx, deployerLog

Fields inherited from class org.apache.axis2.deployment.AbstractDeployer

deploymentFileDataMap

Constructor Summary

Constructors

Constructor and Description
APIDeployer()

Method Summary

Modifier and Type	Method and Description
String	deploySynapseArtifact(org.apache.axiom.om.OMElement artifactConfig, String fileName, Properties properties) All synapse artifact deployers MUST implement this method and it handles artifact specific deployment tasks of those artifacts.
void	restoreSynapseArtifact(String artifactName) All synapse artifact deployers MUST implement this method and it handles artifact specific restore tasks of those artifacts upon a failure of an update or undeployment.
void	undeploySynapseArtifact(String artifactName) All synapse artifact deployers MUST implement this method and it handles artifact specific undeployment tasks of those artifacts.
String	updateSynapseArtifact(org.apache.axiom.om.OMElement artifactConfig, String fileName, String existingArtifactName, Properties properties) All synapse artifact deployers MUST implement this method and it handles artifact specific update tasks of those artifacts.

Methods inherited from class org.apache.synapse.deployers.AbstractSynapseArtifactDeployer

deploy, getServerConfigurationInformation, getServerContextInformation, getSynapseConfiguration, getSynapseEnvironment, handleSynapseArtifactDeploymentError, handleSynapseArtifactDeploymentError, init, setDirectory, setExtension, undeploy, waitForCompletion, writeToFile

Methods inherited from class org.apache.axis2.deployment.AbstractDeployer

addServiceBuilderExtensions, cleanup, executeServiceBuilderExtensions, getServiceBuilderExtensions

Methods inherited from class java.lang.Object

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

Constructor Detail

APIDeployer

public APIDeployer()

Method Detail

deploySynapseArtifact

public String deploySynapseArtifact(org.apache.axiom.om.OMElement artifactConfig,
                                    String fileName,
                                    Properties properties)

Description copied from class: AbstractSynapseArtifactDeployer

All synapse artifact deployers MUST implement this method and it handles artifact specific deployment tasks of those artifacts.

Specified by:

deploySynapseArtifact in class AbstractSynapseArtifactDeployer

Parameters:

artifactConfig - built element representing the artifact to be deployed loaded from the file

fileName - file name from which this artifact is being loaded

properties - Properties associated with the artifact

Returns:

String artifact name created by the deployment task

See Also:

AbstractSynapseArtifactDeployer.deploy( org.apache.axis2.deployment.repository.util.DeploymentFileData)

updateSynapseArtifact

public String updateSynapseArtifact(org.apache.axiom.om.OMElement artifactConfig,
                                    String fileName,
                                    String existingArtifactName,
                                    Properties properties)

Description copied from class: AbstractSynapseArtifactDeployer

All synapse artifact deployers MUST implement this method and it handles artifact specific update tasks of those artifacts.

Specified by:

updateSynapseArtifact in class AbstractSynapseArtifactDeployer

Parameters:

artifactConfig - built element representing the artifact to be deployed loaded from the file

fileName - file name from which this artifact is being loaded

existingArtifactName - name of the artifact that was being deployed using the updated file

properties - bag of properties with the additional information

Returns:

String artifact name created by the update task

undeploySynapseArtifact

public void undeploySynapseArtifact(String artifactName)

Description copied from class: AbstractSynapseArtifactDeployer

All synapse artifact deployers MUST implement this method and it handles artifact specific undeployment tasks of those artifacts.

Specified by:

undeploySynapseArtifact in class AbstractSynapseArtifactDeployer

Parameters:

artifactName - name of the artifact to be undeployed

See Also:

AbstractSynapseArtifactDeployer.undeploy(String)

restoreSynapseArtifact

public void restoreSynapseArtifact(String artifactName)

Description copied from class: AbstractSynapseArtifactDeployer

All synapse artifact deployers MUST implement this method and it handles artifact specific restore tasks of those artifacts upon a failure of an update or undeployment.

Specified by:

restoreSynapseArtifact in class AbstractSynapseArtifactDeployer

Parameters:

artifactName - name of the artifact to be restored