Package org.apache.sshd.server

Interface Environment

  • All Known Implementing Classes:
    StandardEnvironment
    public interface Environment
    Interface providing access to the environment map and allowing the registration of listeners for certain signals.
    See Also:
    Signal

    • Field Detail

      • ENV_USER

        static final java.lang.String ENV_USER
        Key for the user environment variable
        See Also:
        Constant Field Values

      • ENV_LINES

        static final java.lang.String ENV_LINES
        Key for the lines environment variable. Specifies the number of lines visible on the client side. ENV_LINES and ENV_COLUMNS make up the console screen size.
        See Also:
        Constant Field Values

      • ENV_COLUMNS

        static final java.lang.String ENV_COLUMNS
        Key for the columns environment variable. Specifies the number of columns visible on the client side. ENV_LINES and ENV_COLUMNS make up the console screen size.
        See Also:
        Constant Field Values

      • ENV_TERM

        static final java.lang.String ENV_TERM
        Key for the term environment variable. Describes the terminal or terminal emulation which is in use.
        See Also:
        Constant Field Values

    • Method Detail

      • getEnv

        java.util.Map<java.lang.String,​java.lang.String> getEnv()
        Retrieve the environment map
        Returns:
        the environment Map - never null

      • getPtyModes

        java.util.Map<PtyMode,​java.lang.Integer> getPtyModes()
        Retrieve the PTY modes settings
        Returns:
        the Map of PtyModes - never null

      • addSignalListener

        default void addSignalListener​(SignalListener listener,
                               Signal... signals)
        Add a qualified listener for the specific signals
        Parameters:
        listener - the SignalListener to register
        signals - The (never null/empty) Signals the listener is interested in

      • addSignalListener

        default void addSignalListener​(SignalListener listener)
        Add a global listener for all signals
        Parameters:
        listener - the SignalListener to register

      • addSignalListener

        void addSignalListener​(SignalListener listener,
                       java.util.Collection<Signal> signals)
        Add a qualified listener for the specific signals
        Parameters:
        listener - the SignalListener to register
        signals - the Signals the listener is interested in

      • removeSignalListener

        void removeSignalListener​(SignalListener listener)
        Remove a previously registered listener for all the signals it was registered
        Parameters:
        listener - the SignalListener to remove