Class AbstractSynapseArtifactDeployer

    • Field Detail

      • deployerLog

        protected org.apache.commons.logging.Log deployerLog
      • cfgCtx

        protected org.apache.axis2.context.ConfigurationContext cfgCtx
      • customLogContent

        protected String customLogContent
    • Constructor Detail

      • AbstractSynapseArtifactDeployer

        protected AbstractSynapseArtifactDeployer()
    • Method Detail

      • init

        public void init​(org.apache.axis2.context.ConfigurationContext configCtx)
        Initializes the Synapse artifact deployment
        Parameters:
        configCtx - Axis2 ConfigurationContext
      • deploy

        public void deploy​(org.apache.axis2.deployment.repository.util.DeploymentFileData deploymentFileData)
                    throws org.apache.axis2.deployment.DeploymentException
        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 org.apache.axis2.deployment.AbstractDeployer
        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:
        deploySynapseArtifact(org.apache.axiom.om.OMElement, String,java.util.Properties)
      • undeploy

        public void undeploy​(String fileName)
                      throws org.apache.axis2.deployment.DeploymentException
        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 org.apache.axis2.deployment.AbstractDeployer
        Parameters:
        fileName - file describing the artifact to be undeployed
        Throws:
        org.apache.axis2.deployment.DeploymentException - in case of an error in undeployment
        See Also:
        undeploySynapseArtifact( String)
      • setDirectory

        public void setDirectory​(String directory)
      • setExtension

        public void setExtension​(String extension)
      • deploySynapseArtifact

        public abstract 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.
        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:
        deploy( org.apache.axis2.deployment.repository.util.DeploymentFileData)
      • updateSynapseArtifact

        public abstract 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.
        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 abstract void undeploySynapseArtifact​(String artifactName)
        All synapse artifact deployers MUST implement this method and it handles artifact specific undeployment tasks of those artifacts.
        Parameters:
        artifactName - name of the artifact to be undeployed
        See Also:
        undeploy(String)
      • restoreSynapseArtifact

        public abstract 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.
        Parameters:
        artifactName - name of the artifact to be restored
      • getSynapseConfiguration

        protected SynapseConfiguration getSynapseConfiguration()
                                                        throws org.apache.axis2.deployment.DeploymentException
        Throws:
        org.apache.axis2.deployment.DeploymentException
      • getSynapseEnvironment

        protected SynapseEnvironment getSynapseEnvironment()
                                                    throws org.apache.axis2.deployment.DeploymentException
        Throws:
        org.apache.axis2.deployment.DeploymentException
      • getServerConfigurationInformation

        protected ServerConfigurationInformation getServerConfigurationInformation()
                                                                            throws org.apache.axis2.deployment.DeploymentException
        Throws:
        org.apache.axis2.deployment.DeploymentException
      • getServerContextInformation

        protected ServerContextInformation getServerContextInformation()
                                                                throws org.apache.axis2.deployment.DeploymentException
        Throws:
        org.apache.axis2.deployment.DeploymentException
      • writeToFile

        protected void writeToFile​(org.apache.axiom.om.OMElement content,
                                   String fileName)
                            throws Exception
        Throws:
        Exception
      • waitForCompletion

        protected void waitForCompletion()
      • handleSynapseArtifactDeploymentError

        protected void handleSynapseArtifactDeploymentError​(String msg)
      • handleSynapseArtifactDeploymentError

        protected void handleSynapseArtifactDeploymentError​(String msg,
                                                            Exception e)
      • setCustomLog

        public void setCustomLog​(String artifactContainerName,
                                 String tenantId)
      • executeExtendedSynapseHandlerOnArtifactDeployment

        protected void executeExtendedSynapseHandlerOnArtifactDeployment​(String artifactName,
                                                                         String artifactType,
                                                                         String startTime)
                                                                  throws org.apache.axis2.deployment.DeploymentException
        Execute the ExtendedSynapseHandler during the artifact deployment.
        Parameters:
        artifactName - name of the deployed artifact
        artifactType - type of the deployed artifact
        startTime - time the artifact was deployed
        Throws:
        org.apache.axis2.deployment.DeploymentException
      • executeSynapseHandlerOnArtifactUnDeployment

        protected void executeSynapseHandlerOnArtifactUnDeployment​(String artifactName,
                                                                   String artifactType,
                                                                   String unDeployTime)
                                                            throws org.apache.axis2.deployment.DeploymentException
        Execute the ExtendedSynapseHandler during the artifact undeployment.
        Parameters:
        artifactName - name of the undeployed artifact
        artifactType - type of the undeployed artifact
        unDeployTime - time the artifact was undeployed
        Throws:
        org.apache.axis2.deployment.DeploymentException