org.apache.camel.component.exec.ExecCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-exec Show documentation
Camel support for system command execution
There is a newer version: 4.8.1
/*
 * 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.camel.component.exec;

import java.io.File;
import java.io.InputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.apache.camel.LoggingLevel;

import static org.apache.camel.util.ObjectHelper.notNull;

/**
 * Value object that describes the command to be executed.
 */
public class ExecCommand implements Serializable {

    private static final long serialVersionUID = 1755094616849607573L;

    /**
     * @see ExecBinding#EXEC_COMMAND_EXECUTABLE
     */
    private final String executable;

    /**
     * @see ExecBinding#EXEC_COMMAND_EXIT_VALUES
     */
    private final Set exitValues;

    /**
     * @see ExecBinding#EXEC_COMMAND_ARGS
     */
    private final List args;

    /**
     * @see ExecBinding#EXEC_COMMAND_WORKING_DIR
     */
    private final String workingDir;

    /**
     * @see ExecBinding#EXEC_COMMAND_TIMEOUT
     */
    private final long timeout;

    /**
     * @see ExecBinding#EXEC_COMMAND_OUT_FILE
     */
    private final File outFile;

    /**
     * The input of the executable
     */
    private final InputStream input;

    /**
     * Log level for commands during execution
     */
    private final LoggingLevel commandLogLevel;

    private final boolean useStderrOnEmptyStdout;

    public ExecCommand(String executable, List args, String workingDir, Long timeout, Set exitValues,
                       InputStream input, File outFile, boolean useStderrOnEmptyStdout, LoggingLevel commandLogLevel) {
        notNull(executable, "command executable");
        this.executable = executable;
        this.exitValues = exitValues;
        this.args = unmodifiableOrEmptyList(args);
        this.workingDir = workingDir;
        this.timeout = timeout;
        this.input = input;
        this.outFile = outFile;
        this.useStderrOnEmptyStdout = useStderrOnEmptyStdout;
        this.commandLogLevel = commandLogLevel;
    }

    public List getArgs() {
        return args;
    }

    public String getExecutable() {
        return executable;
    }

    public Set getExitValues() {
        return exitValues;
    }

    public InputStream getInput() {
        return input;
    }

    public File getOutFile() {
        return outFile;
    }

    public long getTimeout() {
        return timeout;
    }

    public String getWorkingDir() {
        return workingDir;
    }

    public boolean isUseStderrOnEmptyStdout() {
        return useStderrOnEmptyStdout;
    }

    public LoggingLevel getCommandLogLevel() {
        return commandLogLevel;
    }

    @Override
    public String toString() {
        String dirToPrint = workingDir == null ? "null" : workingDir;
        String outFileToPrint = outFile == null ? "null" : outFile.getPath();
        String exitValuesString = exitValues.stream().map(Object::toString)
                .collect(Collectors.joining(","));
        return "ExecCommand [args=" + args + ", executable=" + executable + ", timeout=" + timeout
               + ", exitValues=" + exitValuesString + ", outFile="
               + outFileToPrint + ", workingDir=" + dirToPrint + ", commandLogLevel=" + commandLogLevel
               + ", useStderrOnEmptyStdout=" + useStderrOnEmptyStdout + "]";
    }

    private  List unmodifiableOrEmptyList(List list) {
        return Collections.unmodifiableList(list == null ? new ArrayList() : list);
    }

}