org.apache.sshd.server

Class StandardEnvironment

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.StandardEnvironment

All Implemented Interfaces:

Environment

public class StandardEnvironment
extends AbstractLoggingBean
implements Environment

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	env
private java.util.Map<Signal,java.util.Collection<SignalListener>>	listeners
private java.util.Map<PtyMode,java.lang.Integer>	ptyModes

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.server.Environment

ENV_COLUMNS, ENV_LINES, ENV_TERM, ENV_USER

Constructor Summary

Constructors

Constructor and Description
StandardEnvironment()

Method Summary

Modifier and Type	Method and Description
void	addSignalListener(SignalListener listener) Add a global listener for all signals
void	addSignalListener(SignalListener listener, java.util.Collection<Signal> signals) Add a qualified listener for the specific signals
void	addSignalListener(SignalListener listener, Signal... signals) Add a qualified listener for the specific signals
java.util.Map<java.lang.String,java.lang.String>	getEnv() Retrieve the environment map
java.util.Map<PtyMode,java.lang.Integer>	getPtyModes() Retrieve the PTY modes settings
protected java.util.Collection<SignalListener>	getSignalListeners(Signal signal, boolean create) Retrieves the set of listeners registered for a signal
void	removeSignalListener(SignalListener listener) Remove a previously registered listener for all the signals it was registered
void	set(java.lang.String key, java.lang.String value) Adds a variable to the environment.
void	signal(Signal signal)
java.lang.String	toString()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

listeners

private final java.util.Map<Signal,java.util.Collection<SignalListener>> listeners

env

private final java.util.Map<java.lang.String,java.lang.String> env

ptyModes

private final java.util.Map<PtyMode,java.lang.Integer> ptyModes

Constructor Detail

StandardEnvironment

public StandardEnvironment()

Method Detail

addSignalListener

public void addSignalListener(SignalListener listener,
                              Signal... signals)

Description copied from interface: Environment

Add a qualified listener for the specific signals

Specified by:

addSignalListener in interface Environment

Parameters:

listener - the SignalListener to register

signals - the Signals 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 SignalListener to register

addSignalListener

public void addSignalListener(SignalListener listener,
                              java.util.Collection<Signal> signals)

Description copied from interface: Environment

Add a qualified listener for the specific signals

Specified by:

addSignalListener in interface Environment

Parameters:

listener - the SignalListener to register

signals - the Signals the listener is interested in

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Description copied from interface: Environment

Retrieve the environment map

Specified by:

getEnv in interface Environment

Returns:

the environment Map - never null

getPtyModes

public java.util.Map<PtyMode,java.lang.Integer> getPtyModes()

Description copied from interface: Environment

Retrieve the PTY modes settings

Specified by:

getPtyModes in interface Environment

Returns:

the Map of PtyModes - never null

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 SignalListener to remove

signal

public void signal(Signal signal)

set

public void set(java.lang.String key,
                java.lang.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 - never null/empty

value - environment variable value

getSignalListeners

protected java.util.Collection<SignalListener> getSignalListeners(Signal signal,
                                                                  boolean create)

Retrieves the set of listeners registered for a signal

Parameters:

signal - The specified Signal

create - If true and no current listeners are mapped then creates a new Collection

Returns:

The Collection of listeners registered for the signal - may be null in case create is false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object