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 Summary
Fields Modifier and Type Field Description static String
ENV_COLUMNS
Key for the columns environment variable.static String
ENV_LINES
Key for the lines environment variable.static String
ENV_TERM
Key for the term environment variable.static String
ENV_USER
Key for the user environment variable
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
addSignalListener(SignalListener listener)
Add a global listener for all signalsvoid
addSignalListener(SignalListener listener, Collection<Signal> signals)
Add a qualified listener for the specific signalsdefault void
addSignalListener(SignalListener listener, Signal... signals)
Add a qualified listener for the specific signalsMap<String,String>
getEnv()
Retrieve the environment mapMap<PtyMode,Integer>
getPtyModes()
Retrieve the PTY modes settingsvoid
removeSignalListener(SignalListener listener)
Remove a previously registered listener for all the signals it was registered
-
-
-
Field Detail
-
ENV_USER
static final String ENV_USER
Key for the user environment variable- See Also:
- Constant Field Values
-
ENV_LINES
static final String ENV_LINES
Key for the lines environment variable. Specifies the number of lines visible on the client side.ENV_LINES
andENV_COLUMNS
make up the console screen size.- See Also:
- Constant Field Values
-
ENV_COLUMNS
static final String ENV_COLUMNS
Key for the columns environment variable. Specifies the number of columns visible on the client side.ENV_LINES
andENV_COLUMNS
make up the console screen size.- See Also:
- Constant Field Values
-
ENV_TERM
static final 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
Map<String,String> getEnv()
Retrieve the environment map- Returns:
- the environment
Map
- nevernull
-
addSignalListener
default void addSignalListener(SignalListener listener, Signal... signals)
Add a qualified listener for the specific signals- Parameters:
listener
- theSignalListener
to registersignals
- The (nevernull
/empty)Signal
s the listener is interested in
-
addSignalListener
default void addSignalListener(SignalListener listener)
Add a global listener for all signals- Parameters:
listener
- theSignalListener
to register
-
addSignalListener
void addSignalListener(SignalListener listener, Collection<Signal> signals)
Add a qualified listener for the specific signals- Parameters:
listener
- theSignalListener
to registersignals
- theSignal
s the listener is interested in
-
removeSignalListener
void removeSignalListener(SignalListener listener)
Remove a previously registered listener for all the signals it was registered- Parameters:
listener
- theSignalListener
to remove
-
-