LibraryArtifactDeployer (Apache Synapse 3.0.1 API)
JavaScript is disabled on your browser.
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method
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, deployerLog
Fields inherited from class org.apache.axis2.deployment.AbstractDeployer
deploymentFileDataMap
Constructor Summary
Constructors 
Constructor and Description
LibraryArtifactDeployer() 
Method Summary
All Methods Instance Methods Concrete Methods 
Modifier and Type
Method and 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
getServerConfigurationInformation, getServerContextInformation, getSynapseConfiguration, getSynapseEnvironment, handleSynapseArtifactDeploymentError, handleSynapseArtifactDeploymentError, init, 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
LibraryArtifactDeployer
public LibraryArtifactDeployer()
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 interface org.apache.axis2.deployment.Deployer
Overrides:
deploy in class AbstractSynapseArtifactDeployer
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 interface org.apache.axis2.deployment.Deployer
Overrides:
undeploy in class AbstractSynapseArtifactDeployer
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 class AbstractSynapseArtifactDeployer
Parameters:
artifactName - name of the artifact to be undeployed
See Also:
AbstractSynapseArtifactDeployer.undeploy(String)
setDirectory
public void setDirectory(String directory)
Specified by:
setDirectory in interface org.apache.axis2.deployment.Deployer
Overrides:
setDirectory in class AbstractSynapseArtifactDeployer
setExtension
public void setExtension(String extension)
Specified by:
setExtension in interface org.apache.axis2.deployment.Deployer
Overrides:
setExtension in class AbstractSynapseArtifactDeployer
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
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
Skip navigation links
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
Prev Class
Next Class
Frames
No Frames
All Classes
Summary: 
Nested | 
Field | 
Constr | 
Method
Detail: 
Field | 
Constr | 
Method
Copyright © 2005-2017 Apache Software Foundation. All Rights Reserved.