org.apache.commons.exec.Executor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-exec Show documentation
CriticalSection.Org internal release of the Apache commons-exec library.
The newest version!
/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package org.apache.commons.exec;

import java.io.File;
import java.io.IOException;
import java.util.Map;

public interface Executor {

    /** Invalid exit code. * */
    int INVALID_EXITVALUE = 0xdeadbeef;

    /*
     * Define the exit code of the process to considered
     * successful.
     */
    void setExitValue(final int value);

    /*
     * Define the exit code of the process to considered
     * successful using one of the following values
     * 
     *  an array of exit values to be considered successful
     *  an empty array for auto-detect of successful exit codes
     *  null to indicate to skip checking of exit codes
     * 
     */
    void setExitValues(final int[] values);

    /**
     * Checks whether exitValue signals a failure. If no
     * exit values are set than the default conventions of the OS is
     * used. 
     *
     * @param exitValue the exit value (return code) to be checked
     * @return true if exitValue signals a failure
     */
    boolean isFailure(final int exitValue);

    /*
     * StreamHandlers are used for providing input, 
     * retriving the output. Also used for logging.  
     */
    ExecuteStreamHandler getStreamHandler();
    void setStreamHandler(ExecuteStreamHandler streamHandler);

    /*
     * Watchdog is used to kill of processes running, 
     * typically, too long time. 
     */
    ExecuteWatchdog getWatchdog();
    void setWatchdog(ExecuteWatchdog watchDog);

    /**
     * Optinal cleanup of started processes if the main process
     * is going to terminate.
     */
    ProcessDestroyer getProcessDestroyer();
    void setProcessDestroyer(ProcessDestroyer processDestroyer);

    /*
     * Set the working directory of the created process.
     */
    File getWorkingDirectory();
    void setWorkingDirectory(File dir);

    /*
     * Methods for starting synchronous execution.
     * Returns process exit value
     */
    int execute(CommandLine command) throws ExecuteException, IOException; 
    int execute(CommandLine command, Map environment) throws ExecuteException, IOException;
    
    /*
     * Methods for starting asynchronous execution. Result provided to callback handler
     */
    void execute(CommandLine command, ExecuteResultHandler handler) throws ExecuteException, IOException;
    void execute(CommandLine command, Map environment, ExecuteResultHandler handler) throws ExecuteException, IOException;
}