Apache Mina SSHD 2.15.0 · org.apache.sshd.server.StandardEnvironment

Modifier and Type	Field and Description
private final Map<String, String>	env
private final Map<Signal, Collection<SignalListener>>	listeners
private final Map<PtyMode, Integer>	ptyModes

Access	Constructor and Description
public	StandardEnvironment()

Method Summary

Modifier and Type	Method and Description
public void	addSignalListener(SignalListener the `SignalListener` to register listener, Collection<Signal> the `Signal`s the listener is interested in signals) Implements org.apache.sshd.server.Environment.addSignalListener. Add a qualified listener for the specific signals
public Map<String, String>	getEnv() Implements org.apache.sshd.server.Environment.getEnv. Retrieve the environment map
public Map<PtyMode, Integer>	getPtyModes() Implements org.apache.sshd.server.Environment.getPtyModes. Retrieve the PTY modes settings
protected Collection<SignalListener>	Returns: The `Collection` of listeners registered for the signal - may be `null` in case `create` is `false` getSignalListeners(Signal The specified `Signal` signal, boolean If `true` and no current listeners are mapped then creates a new `Collection` create) Retrieves the set of listeners registered for a signal
public void	removeSignalListener(SignalListener the `SignalListener` to remove listener) Implements org.apache.sshd.server.Environment.removeSignalListener. Remove a previously registered listener for all the signals it was registered
public void	set(String environment variable name - never `null`/empty key, String environment variable value value) Adds a variable to the environment.
public void	signal(Channel channel, Signal signal)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

env	back to summary
private final Map<String, String> env

listeners	back to summary
private final Map<Signal, Collection<SignalListener>> listeners

ptyModes	back to summary
private final Map<PtyMode, Integer> ptyModes

StandardEnvironment	back to summary
public StandardEnvironment()

Method Detail

addSignalListener back to summary

addSignalListener	back to summary
public void addSignalListener(SignalListener listener, Collection<Signal> signals) Implements org.apache.sshd.server.Environment.addSignalListener. Doc from org.apache.sshd.server.Environment.addSignalListener. Add a qualified listener for the specific signals Parameters listener:SignalListener the `SignalListener` to register signals:Collection<Signal> the `Signal`s the listener is interested in Annotations @Override

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

Implements org.apache.sshd.server.Environment.addSignalListener.

Doc from org.apache.sshd.server.Environment.addSignalListener.

Add a qualified listener for the specific signals

Parameters

listener:SignalListener: the SignalListener to register
signals:Collection<Signal>: the Signals the listener is interested in

Annotations

@Override

getEnv back to summary

getEnv	back to summary
public Map<String, String> getEnv() Implements org.apache.sshd.server.Environment.getEnv. Doc from org.apache.sshd.server.Environment.getEnv. Retrieve the environment map Returns:Map<String, String> the environment `Map` - never `null` Annotations @Override

public Map<String, String> getEnv()

Implements org.apache.sshd.server.Environment.getEnv.

Doc from org.apache.sshd.server.Environment.getEnv.

Retrieve the environment map

Returns:Map<String, String>

the environment Map - never null

Annotations

@Override

getPtyModes back to summary

getPtyModes	back to summary
public Map<PtyMode, Integer> getPtyModes() Implements org.apache.sshd.server.Environment.getPtyModes. Doc from org.apache.sshd.server.Environment.getPtyModes. Retrieve the PTY modes settings Returns:Map<PtyMode, Integer> the `Map` of `PtyMode`s - never `null` Annotations @Override

public Map<PtyMode, Integer> getPtyModes()

Implements org.apache.sshd.server.Environment.getPtyModes.

Doc from org.apache.sshd.server.Environment.getPtyModes.

Retrieve the PTY modes settings

Returns:Map<PtyMode, Integer>

the Map of PtyModes - never null

Annotations

@Override

getSignalListeners back to summary

getSignalListeners	back to summary
protected Collection<SignalListener> getSignalListeners(Signal signal, boolean create) Retrieves the set of listeners registered for a signal Parameters signal:Signal The specified `Signal` create:boolean If `true` and no current listeners are mapped then creates a new `Collection` Returns:Collection<SignalListener> The `Collection` of listeners registered for the signal - may be `null` in case `create` is `false`

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

Retrieves the set of listeners registered for a signal

Parameters

signal:Signal: The specified Signal
create:boolean: If true and no current listeners are mapped then creates a new Collection

Returns:Collection<SignalListener>

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

removeSignalListener back to summary

removeSignalListener	back to summary
public void removeSignalListener(SignalListener listener) Implements org.apache.sshd.server.Environment.removeSignalListener. Doc from org.apache.sshd.server.Environment.removeSignalListener. Remove a previously registered listener for all the signals it was registered Parameters listener:SignalListener the `SignalListener` to remove Annotations @Override

public void removeSignalListener(SignalListener listener)

Implements org.apache.sshd.server.Environment.removeSignalListener.

Doc from org.apache.sshd.server.Environment.removeSignalListener.

Remove a previously registered listener for all the signals it was registered

Parameters

listener:SignalListener: the SignalListener to remove

Annotations

@Override

set back to summary

set	back to summary
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:String environment variable name - never `null`/empty value:String environment variable value

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:String: environment variable name - never null/empty
value:String: environment variable value

signal	back to summary
public void signal(Channel channel, Signal signal)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class StandardEnvironment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail