org.apache.camel.component.ssh.SshConstants Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-ssh Show documentation

Camel SSH support

There is a newer version: 4.9.0

/*
 * 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.ssh;

import java.io.InputStream;

import org.apache.camel.spi.Metadata;

public interface SshConstants {

    @Metadata(description = "The user name", javaType = "String")
    String USERNAME_HEADER = "CamelSshUsername";
    @Metadata(description = "The password", javaType = "String")
    String PASSWORD_HEADER = "CamelSshPassword";

    /**
     * The value of this header is a {@link InputStream} with the standard error stream of the executable.
     */
    @Metadata(javaType = "InputStream")
    String STDERR = "CamelSshStderr";

    /**
     * The value of this header is the exit value that is returned, after the execution. By convention a non-zero status
     * exit value indicates abnormal termination. 

     * Note that the exit value is OS dependent.
     */
    @Metadata(javaType = "Integer")
    String EXIT_VALUE = "CamelSshExitValue";
}