<change>

            <api name="extexecution_api"/>

            <summary>New SPI for improved external process termination</summary>

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

            <date day="1" month="7" year="2008"/>

            <author login="mkleint"/>

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

            <description>

            </description>

            <class package="org.netbeans.spi.extexecution.destroy" name="DestroyUtils"/>

            <class package="org.netbeans.spi.extexecution.destroy" name="ProcessDestroyPerformer"/>

            <issue number="138116"/>

        </change>

                <package>org.netbeans.spi.extexecution.destroy</package>

import java.io.InputStream;

import java.io.OutputStream;

import java.util.Collections;

import java.util.UUID;

import org.netbeans.modules.extexecution.WrapperProcess;

import org.netbeans.spi.extexecution.destroy.DestroyUtils;

        String uuid = UUID.randomUUID().toString();

        pbEnv.put(DestroyUtils.KEY_UUID, uuid);

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.modules.extexecution;

import java.io.InputStream;

import java.io.OutputStream;

import java.util.Collections;

import org.netbeans.spi.extexecution.destroy.DestroyUtils;

/**

 *

 * @author mkleint

 */

public class WrapperProcess extends Process {

        private final String uuid;

        private final Process del;

        public WrapperProcess(Process delegate, String uuid) {

            this.del = delegate;

            this.uuid = uuid;

        }

        @Override

        public OutputStream getOutputStream() {

            return del.getOutputStream();

        }

        @Override

        public InputStream getInputStream() {

            return del.getInputStream();

        }

        @Override

        public InputStream getErrorStream() {

            return del.getErrorStream();

        }

        @Override

        public int waitFor() throws InterruptedException {

            return del.waitFor();

        }

        @Override

        public int exitValue() {

            return del.exitValue();

        }

        @Override

        public void destroy() {

            DestroyUtils.destroy(del, Collections.singletonMap(DestroyUtils.KEY_UUID, uuid));

        }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.spi.extexecution.destroy;

import java.util.Map;

import org.netbeans.modules.extexecution.WrapperProcess;

import org.openide.util.Lookup;

/**

 * Utility class capable of properly terminating external process along with any

 * child processes created during execution.

 *

 * @author mkleint

 * @since 1.16

 */

public class DestroyUtils {

    private DestroyUtils() {

    }

    /**

     * The default environment variable key to be used to identify process trees

     * in <code>destroy</code> method.

     */

    public static final String KEY_UUID = "NB_EXEC_PROCESS_UUID"; //NOI18N

    /**

     * Destroys the process passed as parameter and attempts to terminate all child

     * processes created during the process' execution.

     * @param prcs process to kill

     * @param env Map containing environment variable names and values.

     *            Any process running with such envvar's value will be terminated.

     *            Improves localization of child processes.

     */

    public static void destroy(Process prcs, Map<String, String> env) {

        if (prcs instanceof WrapperProcess) {

            prcs.destroy();

            return;

        }

        ProcessDestroyPerformer pdp = Lookup.getDefault().lookup(ProcessDestroyPerformer.class);

        if (pdp != null) {

            pdp.destroy(prcs, env);

        } else {

            prcs.destroy();

        }

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2009 Sun Microsystems, Inc.

 */

package org.netbeans.spi.extexecution.destroy;

import java.util.Map;

/**

 * A service capable of properly terminating external process along with any

 * child processes created during execution.

 *

 * Note: not to be implemented by modules, might not be present in all versions of

 * the application.

 * Please use <code>DestroyUtils.destroy()</code> for accessing the service.

 *

 * @author mkleint

 * @since 1.16

 */

public interface ProcessDestroyPerformer {

    /**

     * Destroys the process passed as parameter and attempts to terminate all child

     * processes created during the process' execution.

     * @param process process to kill

     * @param env Map containing environment variable names and values.

     *            Any process running with such envvar's value will be terminated.

     *            Improves localization of child processes.

     *

     * @param process

     * @param env

     */

    void destroy(Process process, Map<String, String> env);

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * Contributor(s):

 *

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

 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun

 * Microsystems, Inc. All Rights Reserved.

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 */

/**

 * The support SPI for terminating external processes.

 *

 * @see org.netbeans.spi.extexecution.destroy.DestroyUtils

 */

package org.netbeans.spi.extexecution.destroy;