Package org.apache.synapse.deployers
Class LibraryArtifactDeployer
- java.lang.Object
-
- org.apache.axis2.deployment.AbstractDeployer
-
- org.apache.synapse.deployers.AbstractSynapseArtifactDeployer
-
- org.apache.synapse.deployers.LibraryArtifactDeployer
-
- All Implemented Interfaces:
org.apache.axis2.deployment.Deployer
public class LibraryArtifactDeployer extends AbstractSynapseArtifactDeployer
-
-
Field Summary
-
Fields inherited from class org.apache.synapse.deployers.AbstractSynapseArtifactDeployer
cfgCtx, customLogContent, deployerLog
-
-
Constructor Summary
Constructors Constructor Description LibraryArtifactDeployer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
deploy(org.apache.axis2.deployment.repository.util.DeploymentFileData deploymentFileData)
This method is called by the axis2 deployment framework and it performs a synapse artifact specific yet common across all the artifacts, set of tasks and delegate the actual deployment to the respective artifact deployers.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
setDirectory(String directory)
void
setExtension(String extension)
void
undeploy(String fileName)
This is the method called by the axis2 framework for undeployment of the artifacts.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
executeExtendedSynapseHandlerOnArtifactDeployment, executeSynapseHandlerOnArtifactUnDeployment, getServerConfigurationInformation, getServerContextInformation, getSynapseConfiguration, getSynapseEnvironment, handleSynapseArtifactDeploymentError, handleSynapseArtifactDeploymentError, init, setCustomLog, waitForCompletion, writeToFile
-
-
-
-
Method Detail
-
deploy
public void deploy(org.apache.axis2.deployment.repository.util.DeploymentFileData deploymentFileData) throws org.apache.axis2.deployment.DeploymentException
Description copied from class:AbstractSynapseArtifactDeployer
This method is called by the axis2 deployment framework and it performs a synapse artifact specific yet common across all the artifacts, set of tasks and delegate the actual deployment to the respective artifact deployers.- Specified by:
deploy
in interfaceorg.apache.axis2.deployment.Deployer
- Overrides:
deploy
in classAbstractSynapseArtifactDeployer
- Parameters:
deploymentFileData
- file to be used for the deployment- Throws:
org.apache.axis2.deployment.DeploymentException
- in-case of an error in deploying the file- See Also:
AbstractSynapseArtifactDeployer.deploySynapseArtifact(org.apache.axiom.om.OMElement, String,java.util.Properties)
-
undeploy
public void undeploy(String fileName) throws org.apache.axis2.deployment.DeploymentException
Description copied from class:AbstractSynapseArtifactDeployer
This is the method called by the axis2 framework for undeployment of the artifacts. As in the deploy case this performs some common tasks across all the synapse artifacts and fall back to the artifact specific logic of undeployment.- Specified by:
undeploy
in interfaceorg.apache.axis2.deployment.Deployer
- Overrides:
undeploy
in classAbstractSynapseArtifactDeployer
- Parameters:
fileName
- file describing the artifact to be undeployed- Throws:
org.apache.axis2.deployment.DeploymentException
- in case of an error in undeployment- See Also:
AbstractSynapseArtifactDeployer.undeploySynapseArtifact( String)
-
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 classAbstractSynapseArtifactDeployer
- Parameters:
artifactName
- name of the artifact to be undeployed- See Also:
AbstractSynapseArtifactDeployer.undeploy(String)
-
setDirectory
public void setDirectory(String directory)
- Specified by:
setDirectory
in interfaceorg.apache.axis2.deployment.Deployer
- Overrides:
setDirectory
in classAbstractSynapseArtifactDeployer
-
setExtension
public void setExtension(String extension)
- Specified by:
setExtension
in interfaceorg.apache.axis2.deployment.Deployer
- Overrides:
setExtension
in classAbstractSynapseArtifactDeployer
-
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 classAbstractSynapseArtifactDeployer
- Parameters:
artifactConfig
- built element representing the artifact to be deployed loaded from the filefileName
- file name from which this artifact is being loadedproperties
- 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 classAbstractSynapseArtifactDeployer
- Parameters:
artifactConfig
- built element representing the artifact to be deployed loaded from the filefileName
- file name from which this artifact is being loadedexistingArtifactName
- name of the artifact that was being deployed using the updated fileproperties
- bag of properties with the additional information- Returns:
- String artifact name created by the update task
-
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 classAbstractSynapseArtifactDeployer
- Parameters:
artifactName
- name of the artifact to be restored
-
-