com.rationaleemotions.pojo.ShellAttribs Maven / Gradle / Ivy

Go to download

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

A simple way of interacting with a remote host for executing commands, scp (upload and download)

There is a newer version: 1.0.2

package com.rationaleemotions.pojo;

import java.util.Locale;

/**
 * Represents the common attributes associated with a UNIX Shell flavor.
 */
public interface ShellAttribs {
    /**
     * @return - The keyword that represents environment variable setting.
     */
    String envKeyword();

    /**
     * @return - The separator character to be used when setting up environment variables.
     * For e.g., in BASH shell the separator character is = whereas in TCSH its " " (space)
     */
    String envSeparator();

    /**
     * @return - A format that kind of looks like the format supplied to {@link String#format(Locale, String, Object...)}
     * which would be internally used to represent how does a typical well formed command look like for a given shell.
     */
    String cmdFormat();
}