<change id="antDeployment">

            <api name="j2eeserver"/>

            <summary>

                Added support for Ant (headless) deployment.

            </summary>

            <version major="1" minor="17"/>

            <date day="4" month="4" year="2006"/>

            <author login="sherold"/>

            <compatibility binary="compatible" source="compatible" semantic="compatible" addition="yes"/>

            <description>

                <p>

                    Ant deployment support allows to generate Ant deployment build

                    scripts that can be used to deploy j2ee modules to the

                    server. The generated deployment build script can run in a headless 

                    mode - without the IDE. The IDE does not even have to be installed.

                </p>

            </description>

            <class package="org.netbeans.modules.j2ee.deployment.devmodules.api" name="AntDeploymentHelper"/>

            <class package="org.netbeans.modules.j2ee.deployment.plugins.api" name="AntDeploymentProvider"/>

            <class package="org.netbeans.modules.j2ee.deployment.plugins.api" name="OptionalDeploymentManagerFactory"/>

        </change>

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.j2ee.deployment.devmodules.api;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import javax.enterprise.deploy.shared.ModuleType;

import org.netbeans.modules.j2ee.deployment.impl.ServerInstance;

import org.netbeans.modules.j2ee.deployment.impl.ServerRegistry;

import org.netbeans.modules.j2ee.deployment.plugins.api.AntDeploymentProvider;

import org.openide.filesystems.FileLock;

import org.openide.filesystems.FileObject;

import org.openide.filesystems.FileUtil;

/**

 * Helps to generate Ant deployment build scripts.

 *

 * @author sherold

 *

 * @since 1.17

 */

public final class AntDeploymentHelper {

    /**

     * 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.

     * <p>

     * The Ant deployment build script requires the following properties to be

     * defined.

     * <ul>

     * <li><code>deploy.ant.properties.file</code> - Path to the server instance 

     * specific deployment properties file, see {@link #getDeploymentPropertiesFile}.

     * <li><code>deploy.ant.archive</code> - The deployable archive.

     * <li><code>deploy.ant.resource.dir</code> - The server resources directory.

     * <li><code>deploy.ant.enabled</code> - The Ant deployment targets should be

     * executed only if this property has been set.

     * </ul>

     * <p>

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

     * <ul>

     * <li><code>-deploy-ant</code> - Deploys the deployable archive defined by the 

     * <code>deploy.ant.archive</code> property. If the deployable archive is a web 

     * module or an enterprise application with a web module the 

     * <code>deploy.ant.client.url</code> property is set by this target.

     * <li><code>-undeploy-ant</code> - Undeploys the deployable archive defined 

     * by the <code>deploy.ant.archive</code> property.

     * </ul>

     *

     * @param file the file to which the deployment build script will be generated.

     *             If the file does not exist, it will be created.

     * @param moduleType the module type the build script should handle. Use the

     *                   constants defined in the {@link org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule}.

     * @param serverInstanceID the server instance for which the build script will

     *                         be generated.

     * @throws IOException if a problem during generating the build script occurs.

     */

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

    throws IOException {

        AntDeploymentProvider provider = null;

        if (serverInstanceID != null) {

            ServerInstance si = ServerRegistry.getInstance().getServerInstance(serverInstanceID);

            if (si != null) {

                provider = si.getAntDeploymentProvider();

            }

        }

        file.createNewFile();

        FileObject fo = FileUtil.toFileObject(file);

        FileLock lock = fo.lock();

        try {

            OutputStream os = fo.getOutputStream(lock);

            try {

                if (provider == null) {

                    InputStream is = ServerInstance.class.getResourceAsStream("resources/default-ant-deploy.xml"); // NOI18N

                    try {

                        FileUtil.copy(is, os);

                    } finally {

                        is.close();

                    }

                } else {

                    provider.writeDeploymentScript(os, moduleType);

                }

            } finally {

                os.close();

            }

        } finally {

            lock.releaseLock();

        }

    }

    /**

     * Returns the server instance specific deployment properties file used by 

     * the deployment build script generated by the {@link #writeDeploymentScript(File,Object,String)}. 

     *

     * @param serverInstanceID specifies the server instance.

     *

     * @return 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.

     */

    public static File getDeploymentPropertiesFile(String serverInstanceID) {

        if (serverInstanceID == null) {

            throw new NullPointerException("The serverInstanceID must not be null"); // NOI18N

        }

        ServerInstance si = ServerRegistry.getInstance().getServerInstance(serverInstanceID);

        if (si == null) {

            return null;

        }

        AntDeploymentProvider sup = si.getAntDeploymentProvider();

        return sup == null ? null : sup.getDeploymentPropertiesFile();

    }

}

<?xml version="1.0" encoding="UTF-8"?>

<project name="ant-deploy" default="-deploy-ant" basedir=".">

    <target name="-deploy-ant" unless="netbeans.home">

        <fail message="Deploy is not supported for the current target server"/>

    </target>

    <target name="-undeploy-ant" unless="netbeans.home">

        <fail message="Undeploy is not supported for the current target server"/>

    </target>

</project>

/*

 *                 Sun Public License Notice

 *

 * The contents of this file are subject to the Sun Public License

 * Version 1.0 (the "License"). You may not use this file except in

 * compliance with the License. A copy of the License is available at

 * http://www.sun.com/

 *

 * The Original Code is NetBeans. The Initial Developer of the Original

 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

 * Microsystems, Inc. All Rights Reserved.

 */

package org.netbeans.modules.j2ee.deployment.plugins.api;

import java.io.File;

import java.io.IOException;

import java.io.OutputStream;

/**

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

 * <p>

 * The j2eeserver uses {@link OptionalDeploymentManagerFactory} to optains an 

 * instance of the AntDeploymentProvider from the server integration plugin.

 *

 * @author sherold

 *

 * @since 1.17

 */

public interface AntDeploymentProvider {

    /**

     * Generates the Ant deployment build script for the given module type to 

     * the specified output stream.

     * <p>

     * See {@link org.netbeans.modules.j2ee.deployment.devmodules.api.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.

     *

     * @param os the output stream the deployment build script should be generated 

     *           to.

     * @param moduleType the module type the build script should handle. Use the

     *                   constants defined in the {@link J2eeModule}.

     * @throws IOException if a problem during generating the build script occurs.

     */

    void writeDeploymentScript(OutputStream os, Object moduleType) throws IOException;

    /**

     * Return the server instance specific deployment properties file used by 

     * the deployment build script generated by the {@link #writeDeploymentScript(OutputStream,Object)}.

     *

     * @return the deployment properties file.

     */

    File getDeploymentPropertiesFile();

}

     * Creates an Ant deployment provider for the specified deployment manager.

     *

     * @param dm deployment manager.

     * @return an instance of the AntDeploymentProvider if Ant deployment

     *         is supported for the specified deployment manager, null otherwise.

     * @since 1.17

     */

    public AntDeploymentProvider getAntDeploymentProvider(DeploymentManager dm) {

        return null;

    }

    /**