org.apache.sshd.server.x11

Class X11ForwardSupport

java.lang.Object

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

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.server.x11.X11ForwardSupport

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, IoHandler

public class X11ForwardSupport
extends CloseableUtils.AbstractInnerCloseable
implements IoHandler

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	X11ForwardSupport.ChannelForwardedX11

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANNEL_OPEN_TIMEOUT_PROP Configuration value on the FactoryManager to control the channel open timeout.
static long	DEFAULT_CHANNEL_OPEN_TIMEOUT
static String	ENV_DISPLAY Key for the user DISPLAY variable
static int	MAX_DISPLAYS
static int	X11_DISPLAY_OFFSET

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, state

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

log

Constructor Summary

Constructors

Constructor and Description
X11ForwardSupport(ConnectionService service)

Method Summary

Modifier and Type	Method and Description
void	close()
String	createDisplay(boolean singleConnection, String authenticationProtocol, String authenticationCookie, int screen)
void	exceptionCaught(IoSession session, Throwable cause)
protected Closeable	getInnerCloseable()
void	messageReceived(IoSession session, Readable message)
void	sessionClosed(IoSession session)
void	sessionCreated(IoSession session)

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully, doCloseImmediately

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

isOpen

Methods inherited from class java.lang.Object

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

Field Detail

CHANNEL_OPEN_TIMEOUT_PROP

public static final String CHANNEL_OPEN_TIMEOUT_PROP

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

See Also:

Constant Field Values

DEFAULT_CHANNEL_OPEN_TIMEOUT

public static final long DEFAULT_CHANNEL_OPEN_TIMEOUT

X11_DISPLAY_OFFSET

public static final int X11_DISPLAY_OFFSET

See Also:

Constant Field Values

MAX_DISPLAYS

public static final int MAX_DISPLAYS

See Also:

Constant Field Values

ENV_DISPLAY

public static final String ENV_DISPLAY

Key for the user DISPLAY variable

See Also:

Constant Field Values

Constructor Detail

X11ForwardSupport

public X11ForwardSupport(ConnectionService service)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Overrides:

close in class CloseableUtils.IoBaseCloseable

Throws:

IOException

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class CloseableUtils.AbstractInnerCloseable

createDisplay

public String createDisplay(boolean singleConnection,
                            String authenticationProtocol,
                            String authenticationCookie,
                            int screen)
                     throws IOException

Throws:

IOException

sessionCreated

public void sessionCreated(IoSession session)
                    throws Exception

Specified by:

sessionCreated in interface IoHandler

Throws:

Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws Exception

Specified by:

sessionClosed in interface IoHandler

Throws:

Exception

messageReceived

public void messageReceived(IoSession session,
                            Readable message)
                     throws Exception

Specified by:

messageReceived in interface IoHandler

Throws:

Exception

exceptionCaught

public void exceptionCaught(IoSession session,
                            Throwable cause)
                     throws Exception

Specified by:

exceptionCaught in interface IoHandler

Throws:

Exception