Package org.apache.axis2.deployment

Interface Deployer

All Known Implementing Classes:

AbstractDeployer, ModuleDeployer, POJODeployer, ServiceDeployer, TransportDeployer

public interface Deployer

This interface is used to provide the custom deployment mechanism , where you can write your own Deployer to process a particular type and make that to a service or a module.

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<DeploymentFileData>	DEFAULT_FILENAME_COMPARATOR	Default comparator that sorts DeploymentFileData by file name in ascending order.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleanup deployment
void	deploy(DeploymentFileData deploymentFileData)	Process a file and add it to the configuration
void	init(ConfigurationContext configCtx)	Initialize the Deployer
void	setDirectory(String directory)	Set the directory
void	setExtension(String extension)	Set the extension to look for TODO: Support multiple extensions?
default void	sort(List<DeploymentFileData> filesToDeploy, int startIndex, int toIndex)	Sorts the sublist of deployment artifacts within [startIndex, toIndex).
void	undeploy(String fileName)	Remove a given file from the configuration

Field Details

DEFAULT_FILENAME_COMPARATOR

static final Comparator<DeploymentFileData> DEFAULT_FILENAME_COMPARATOR

Default comparator that sorts DeploymentFileData by file name in ascending order. Used by the default sort(java.util.List<org.apache.axis2.deployment.repository.util.DeploymentFileData>, int, int) implementation and as the fallback in DeploymentEngine.

Method Details

init

void init(ConfigurationContext configCtx)

Initialize the Deployer

Parameters:

configCtx - our ConfigurationContext

deploy

void deploy(DeploymentFileData deploymentFileData)
     throws DeploymentException

Process a file and add it to the configuration

Parameters:

deploymentFileData - the DeploymentFileData object to deploy

Throws:

DeploymentException - if there is a problem

setDirectory

void setDirectory(String directory)

Set the directory

Parameters:

directory - directory name

setExtension

void setExtension(String extension)

Set the extension to look for TODO: Support multiple extensions?

Parameters:

extension - the file extension associated with this Deployer

undeploy

void undeploy(String fileName)
       throws DeploymentException

Remove a given file from the configuration

Parameters:

fileName - name of item to remove

Throws:

DeploymentException - if there is a problem

cleanup

void cleanup()
      throws DeploymentException

Cleanup deployment

Throws:

DeploymentException - If an error occurs during cleanup

sort

default void sort(List<DeploymentFileData> filesToDeploy,
 int startIndex,
 int toIndex)

Sorts the sublist of deployment artifacts within [startIndex, toIndex). Deployers may override this to apply custom ordering within the subrange. The default implementation sorts by file name in ascending order.

Parameters:

filesToDeploy - the list of DeploymentFileData

startIndex - the start index (inclusive) of the sublist to sort

toIndex - the end index (exclusive) of the sublist to sort