org.apache.sshd.server
Interface Environment

All Known Implementing Classes:
ChannelSession.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
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
 void addSignalListener(SignalListener listener)
          Add a global listener for all signals
 void addSignalListener(SignalListener listener, EnumSet<Signal> signals)
          Add a qualified listener for the specific set of signal
 void addSignalListener(SignalListener listener, Signal... signal)
          Add a qualified listener for the specific signal
 Map<String,String> getEnv()
          Retrieve the environment map
 Map<PtyMode,Integer> getPtyModes()
          Retrieve the pty modes
 void 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 and ENV_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 and ENV_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

getPtyModes

Map<PtyMode,Integer> getPtyModes()
Retrieve the pty modes

Returns:
the map of pty modes

addSignalListener

void addSignalListener(SignalListener listener,
                       Signal... signal)
Add a qualified listener for the specific signal

Parameters:
listener - the listener to register
signal - the signal the listener is interested in

addSignalListener

void addSignalListener(SignalListener listener,
                       EnumSet<Signal> signals)
Add a qualified listener for the specific set of signal

Parameters:
listener - the listener to register
signals - the signals the listener is interested in

addSignalListener

void addSignalListener(SignalListener listener)
Add a global listener for all signals

Parameters:
listener - the listener to register

removeSignalListener

void removeSignalListener(SignalListener listener)
Remove a previously registered listener for all the signals it was registered

Parameters:
listener - the listener to remove


Copyright © 2008-2012 Apache Software Foundation. All Rights Reserved.