Package org.apache.sshd.server.x11

Interface X11ForwardSupport

All Superinterfaces:

java.lang.AutoCloseable, java.nio.channels.Channel, java.io.Closeable, Closeable, IoHandler

All Known Implementing Classes:

DefaultX11ForwardSupport

public interface X11ForwardSupport
extends Closeable, IoHandler

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CHANNEL_OPEN_TIMEOUT_PROP	Configuration value on the FactoryManager to control the channel open timeout.
static long	DEFAULT_CHANNEL_OPEN_TIMEOUT
static int	DEFAULT_X11_BASE_PORT
static java.lang.String	DEFAULT_X11_BIND_HOST
static int	DEFAULT_X11_DISPLAY_OFFSET
static int	DEFAULT_X11_MAX_DISPLAYS
static java.lang.String	ENV_DISPLAY	Key for the user DISPLAY variable
static java.lang.String	X11_BASE_PORT	Configuration value to control the base port number for the X11 display number socket binding.
static java.lang.String	X11_BIND_HOST	Configuration value to control the host used to bind to for the X11 display when looking for a free port.
static java.lang.String	X11_DISPLAY_OFFSET	Configuration value to control from which X11 display number to start looking for a free value.
static java.lang.String	X11_MAX_DISPLAYS	Configuration value to control up to which (but not including) X11 display number to look or a free value.
static java.lang.String	XAUTH_COMMAND	"xauth" command name

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Method Summary

Modifier and Type	Method	Description
java.lang.String	createDisplay(boolean singleConnection, java.lang.String authenticationProtocol, java.lang.String authenticationCookie, int screen)

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener

Methods inherited from interface org.apache.sshd.common.io.IoHandler

exceptionCaught, messageReceived, sessionClosed, sessionCreated

Field Detail

CHANNEL_OPEN_TIMEOUT_PROP

static final java.lang.String CHANNEL_OPEN_TIMEOUT_PROP

Configuration value on the FactoryManager to control the channel open timeout. If not specified then value is used

See Also:

Constant Field Values

DEFAULT_CHANNEL_OPEN_TIMEOUT

static final long DEFAULT_CHANNEL_OPEN_TIMEOUT

X11_DISPLAY_OFFSET

static final java.lang.String X11_DISPLAY_OFFSET

Configuration value to control from which X11 display number to start looking for a free value. If not specified, then 10 is used

See Also:

Constant Field Values

DEFAULT_X11_DISPLAY_OFFSET

static final int DEFAULT_X11_DISPLAY_OFFSET

See Also:

Constant Field Values

X11_MAX_DISPLAYS

static final java.lang.String X11_MAX_DISPLAYS

Configuration value to control up to which (but not including) X11 display number to look or a free value. If not specified, then 1000 is used

See Also:

Constant Field Values

DEFAULT_X11_MAX_DISPLAYS

static final int DEFAULT_X11_MAX_DISPLAYS

See Also:

Constant Field Values

X11_BASE_PORT

static final java.lang.String X11_BASE_PORT

Configuration value to control the base port number for the X11 display number socket binding. If not specified then 6000 value is used

See Also:

Constant Field Values

DEFAULT_X11_BASE_PORT

static final int DEFAULT_X11_BASE_PORT

See Also:

Constant Field Values

X11_BIND_HOST

static final java.lang.String X11_BIND_HOST

Configuration value to control the host used to bind to for the X11 display when looking for a free port. If not specified, then "127.0.0.1" is used

See Also:

Constant Field Values

DEFAULT_X11_BIND_HOST

static final java.lang.String DEFAULT_X11_BIND_HOST

See Also:

Constant Field Values

ENV_DISPLAY

static final java.lang.String ENV_DISPLAY

Key for the user DISPLAY variable

See Also:

Constant Field Values

XAUTH_COMMAND

static final java.lang.String XAUTH_COMMAND

"xauth" command name

Method Detail

createDisplay

java.lang.String createDisplay(boolean singleConnection,
                               java.lang.String authenticationProtocol,
                               java.lang.String authenticationCookie,
                               int screen)
                        throws java.io.IOException

Throws:

java.io.IOException