org.netbeans.modules.j2ee.deployment.devmodules.api
Class AntDeploymentHelper

java.lang.Object
  org.netbeans.modules.j2ee.deployment.devmodules.api.AntDeploymentHelper

public final class AntDeploymentHelper
extends Object

Helps to generate Ant deployment build scripts.

Since:

1.18

Constructor Summary

AntDeploymentHelper()

Method Summary

static File	getDeploymentPropertiesFile(String serverInstanceID) Returns the server instance specific deployment properties file used by the deployment build script generated by the writeDeploymentScript(File,Object,String).
static void	writeDeploymentScript(File file, Object moduleType, String serverInstanceID) Generates the Ant deployment build script for the given module type for the specified server instance to the specified file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntDeploymentHelper

public AntDeploymentHelper()

Method Detail

writeDeploymentScript

public static void writeDeploymentScript(File file,
                                         Object moduleType,
                                         String serverInstanceID)
                                  throws IOException

Generates the Ant deployment build script for the given module type for the specified server instance to the specified file. If the specified serverInstanceID is null or no server instance of the specified ID exists a default deployment build script will be generated.

The Ant deployment build script requires the following properties to be defined.

• deploy.ant.properties.file - Path to the server instance specific deployment properties file, see getDeploymentPropertiesFile(java.lang.String).
• deploy.ant.archive - The deployable archive.
• deploy.ant.resource.dir - The server resources directory.
• deploy.ant.enabled - The Ant deployment targets should be executed only if this property has been set.

The Ant deployment build script is bound to provide the following targets.

• -deploy-ant - Deploys the deployable archive defined by the deploy.ant.archive property. If the deployable archive is a web module or an enterprise application with a web module the deploy.ant.client.url property is set by this target.
• -undeploy-ant - Undeploys the deployable archive defined by the deploy.ant.archive property.

Parameters:

file - the file to which the deployment build script will be generated. If the file does not exist, it will be created.

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

serverInstanceID - the server instance for which the build script will be generated.

Throws:

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

getDeploymentPropertiesFile

public static File getDeploymentPropertiesFile(String serverInstanceID)

Returns the server instance specific deployment properties file used by the deployment build script generated by the writeDeploymentScript(File,Object,String).

Parameters:

serverInstanceID - specifies the server instance.

Returns:

the deployment properties file for the specified server instance, if such instance exists and supports Ant deployment, null otherwise.

Throws:

NullPointerException - if the specified serverInstanceID is null.