org.netbeans.modules.j2ee.deployment.plugins.spi
Interface AntDeploymentProvider

public interface AntDeploymentProvider

This interface represents a "provider" for the Ant deployment.

The j2eeserver uses OptionalDeploymentManagerFactory to optains an instance of the AntDeploymentProvider from the server integration plugin.

Since:

1.18

Method Summary

File	getDeploymentPropertiesFile() Return the server instance specific deployment properties file used by the deployment build script generated by the writeDeploymentScript(OutputStream,Object).
void	writeDeploymentScript(OutputStream os, Object moduleType) Generates the Ant deployment build script for the given module type to the specified output stream.

Method Detail

writeDeploymentScript

void writeDeploymentScript(OutputStream os,
                           Object moduleType)
                           throws IOException

Generates the Ant deployment build script for the given module type to the specified output stream.

See AntDeploymentHelper.writeDeploymentScript(File,Object,String) for what targets and properties is the Ant deployment build script required to define and what predefined properties it might use.

Parameters:

os - the output stream the deployment build script should be generated to.

moduleType - the module type the build script should handle. Use the constants defined in the J2eeModule.

Throws:

IOException - if a problem during generating the build script occurs.

getDeploymentPropertiesFile

File getDeploymentPropertiesFile()

Return the server instance specific deployment properties file used by the deployment build script generated by the writeDeploymentScript(OutputStream,Object).

Returns:

the deployment properties file.