ProcessHandler.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Vishwesh Venkatraman <vishwesh.venkatraman@ntnu.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.task;
 
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
 
import denoptim.exception.DENOPTIMException;
 
public class ProcessHandler
{
    private int exitCode;
    private transient Process proc = null;
 
    private String standardOutput;
 
    private String errorOutput;
 
    @SuppressWarnings("unused")
    private String id = null;
 
    private String cmdStr = null;
 
 
//------------------------------------------------------------------------------
 
    public ProcessHandler(String cmdStr, String id)
    {
        this.cmdStr = cmdStr;
        this.id = id;
    }
    
  //------------------------------------------------------------------------------
 
    public void runProcessInBASH() throws DENOPTIMException
    {
        try
        {
            ProcessBuilder pb = new ProcessBuilder("/bin/bash", "-c", cmdStr);
            proc = pb.start();
 
            Runtime.getRuntime().addShutdownHook(new Thread()
            {
                @Override
                public void run()
                {
                    proc.destroy();
                }
            });
 
            // Any error message?
            StreamGobbler errorGobbler =
                    new StreamGobbler(proc.getErrorStream(), "ERR");
 
            // Any output?
            StreamGobbler outputGobbler =
                    new StreamGobbler(proc.getInputStream(), "OUT");
 
            errorGobbler.start();
            outputGobbler.start();
 
            errorGobbler.join();
            outputGobbler.join();
 
            exitCode = proc.waitFor();
 
            standardOutput = outputGobbler.getMessages();
            outputGobbler.sb.setLength(0);
            errorOutput = errorGobbler.getMessages();
            errorGobbler.sb.setLength(0);
 
        }
        catch(IllegalArgumentException iae)
        {
            if (proc!=null)
                proc.destroy();
            throw new DENOPTIMException(iae);
        }
        catch(NullPointerException npe)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(npe);
        }
        catch(IOException ioe)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(ioe);
        }
        catch(Exception e)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(e);
        }
        finally
        {
            if (proc != null)
            {
                try {
                    proc.getOutputStream().close();
                    proc.getInputStream().close();
                    proc.getErrorStream().close();
                    proc.destroy();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
 
//------------------------------------------------------------------------------
 
    public void runProcess() throws DENOPTIMException
    {
        try
        {
            List<String> command = new ArrayList<String>(Arrays.asList(
                    cmdStr.split("\\s+")));
            ProcessBuilder pb = new ProcessBuilder(command);
            //NB: this leads to an IOException with the following message:
            // CreateProcess error=2, The system cannot find the file specified
            //ProcessBuilder pb = new ProcessBuilder(cmdStr);
            proc = pb.start();
 
            Runtime.getRuntime().addShutdownHook(new Thread()
            {
                @Override
                public void run()
                {
                    proc.destroy();
                }
            });
 
            // Any error message?
            StreamGobbler errorGobbler =
                    new StreamGobbler(proc.getErrorStream(), "ERR");
 
            // Any output?
            StreamGobbler outputGobbler =
                    new StreamGobbler(proc.getInputStream(), "OUT");
 
            errorGobbler.start();
            outputGobbler.start();
 
            errorGobbler.join();
            outputGobbler.join();
 
            exitCode = proc.waitFor();
 
            standardOutput = outputGobbler.getMessages();
            outputGobbler.sb.setLength(0);
            errorOutput = errorGobbler.getMessages();
            errorGobbler.sb.setLength(0);
 
        }
        catch(IllegalArgumentException iae)
        {
            if (proc!=null)
                proc.destroy();
            throw new DENOPTIMException(iae);
        }
        catch(NullPointerException npe)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(npe);
        }
        catch(IOException ioe)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(ioe);
        }
        catch(Exception e)
        {
            if (proc!=null)
                proc.destroy();
            throw  new DENOPTIMException(e);
        }
        finally
        {
            if (proc != null)
            {
                try {
                    proc.getOutputStream().close();
                    proc.getInputStream().close();
                    proc.getErrorStream().close();
                    proc.destroy();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
  
//------------------------------------------------------------------------------
 
    public String getStandardOutput()
    {
        return standardOutput;
    }
    
//------------------------------------------------------------------------------
 
    public String getErrorOutput()
    {
        return errorOutput;
    }
 
//------------------------------------------------------------------------------
 
    public int getExitCode()
    {
        return exitCode;
    }
 
//------------------------------------------------------------------------------
 
    public void stopProcess()
    {
        try
        {
            if (proc != null)
            {
                proc.getOutputStream().close();
                proc.getInputStream().close();
                proc.getErrorStream().close();
                proc.destroy();
            }
        }
        catch (Throwable t)
        {
            // do nothing
        }
    }
 
//------------------------------------------------------------------------------
 
}