org.apache.sshd.server.channel
Class ChannelSession.StandardEnvironment

java.lang.Object
  extended by org.apache.sshd.server.channel.ChannelSession.StandardEnvironment
All Implemented Interfaces:
Environment
Enclosing class:
ChannelSession

protected static class ChannelSession.StandardEnvironment
extends Object
implements Environment


Field Summary
 
Fields inherited from interface org.apache.sshd.server.Environment
ENV_COLUMNS, ENV_LINES, ENV_TERM, ENV_USER
 
Constructor Summary
ChannelSession.StandardEnvironment()
           
 
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... signals)
          Add a qualified listener for the specific signal
 Map<String,String> getEnv()
          Retrieve the environment map
 Map<PtyMode,Integer> getPtyModes()
          Retrieve the pty modes
protected  Set<SignalListener> getSignalListeners(Signal signal, boolean create)
           
 void removeSignalListener(SignalListener listener)
          Remove a previously registered listener for all the signals it was registered
 void set(String key, String value)
          adds a variable to the environment.
 void signal(Signal signal)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChannelSession.StandardEnvironment

public ChannelSession.StandardEnvironment()
Method Detail

addSignalListener

public void addSignalListener(SignalListener listener,
                              Signal... signals)
Description copied from interface: Environment
Add a qualified listener for the specific signal

Specified by:
addSignalListener in interface Environment
Parameters:
listener - the listener to register
signals - the signal the listener is interested in

addSignalListener

public void addSignalListener(SignalListener listener)
Description copied from interface: Environment
Add a global listener for all signals

Specified by:
addSignalListener in interface Environment
Parameters:
listener - the listener to register

addSignalListener

public void addSignalListener(SignalListener listener,
                              EnumSet<Signal> signals)
Description copied from interface: Environment
Add a qualified listener for the specific set of signal

Specified by:
addSignalListener in interface Environment
Parameters:
listener - the listener to register
signals - the signals the listener is interested in

getEnv

public Map<String,String> getEnv()
Description copied from interface: Environment
Retrieve the environment map

Specified by:
getEnv in interface Environment
Returns:
the environment map

getPtyModes

public Map<PtyMode,Integer> getPtyModes()
Description copied from interface: Environment
Retrieve the pty modes

Specified by:
getPtyModes in interface Environment
Returns:
the map of pty modes

removeSignalListener

public void removeSignalListener(SignalListener listener)
Description copied from interface: Environment
Remove a previously registered listener for all the signals it was registered

Specified by:
removeSignalListener in interface Environment
Parameters:
listener - the listener to remove

signal

public void signal(Signal signal)

set

public void set(String key,
                String value)
adds a variable to the environment. This method is called set according to the name of the appropriate posix command set

Parameters:
key - environment variable name
value - environment variable value

getSignalListeners

protected Set<SignalListener> getSignalListeners(Signal signal,
                                                 boolean create)


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