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:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiondefault 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 signalsgetEnv()
Retrieve the environment mapRetrieve the PTY modes settingsvoid
removeSignalListener
(SignalListener listener) Remove a previously registered listener for all the signals it was registered
-
Field Details
-
ENV_USER
Key for the user environment variable- See Also:
-
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:
-
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:
-
ENV_TERM
Key for the term environment variable. Describes the terminal or terminal emulation which is in use.- See Also:
-
-
Method Details
-
getEnv
Retrieve the environment map- Returns:
- the environment
Map
- nevernull
-
getPtyModes
Retrieve the PTY modes settings -
addSignalListener
Add a qualified listener for the specific signals- Parameters:
listener
- theSignalListener
to registersignals
- The (nevernull
/empty)Signal
s the listener is interested in
-
addSignalListener
Add a global listener for all signals- Parameters:
listener
- theSignalListener
to register
-
addSignalListener
Add a qualified listener for the specific signals- Parameters:
listener
- theSignalListener
to registersignals
- theSignal
s the listener is interested in
-
removeSignalListener
Remove a previously registered listener for all the signals it was registered- Parameters:
listener
- theSignalListener
to remove
-