org.apache.sshd.server.x11

Class X11ForwardSupport

java.lang.Object

org.apache.sshd.server.x11.X11ForwardSupport

All Implemented Interfaces:

Closeable, IoHandler

public class X11ForwardSupport
extends java.lang.Object
implements IoHandler, Closeable

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	X11ForwardSupport.ChannelForwardedX11

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENV_DISPLAY Key for the user DISPLAY variable
protected org.slf4j.Logger	log
static int	MAX_DISPLAYS
static int	X11_DISPLAY_OFFSET

Constructor Summary

Constructors

Constructor and Description
X11ForwardSupport(ConnectionService service)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
java.lang.String	createDisplay(boolean singleConnection, java.lang.String authenticationProtocol, java.lang.String authenticationCookie, int screen)
void	exceptionCaught(IoSession session, java.lang.Throwable cause)
void	initialize()
void	messageReceived(IoSession session, Readable message)
void	sessionClosed(IoSession session)
void	sessionCreated(IoSession session)

Methods inherited from class java.lang.Object

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

Field Detail

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 java.lang.String ENV_DISPLAY

Key for the user DISPLAY variable

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

Constructor Detail

X11ForwardSupport

public X11ForwardSupport(ConnectionService service)

Method Detail

initialize

public void initialize()

close

public void close()

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

createDisplay

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

Throws:

java.io.IOException

sessionCreated

public void sessionCreated(IoSession session)
                    throws java.lang.Exception

Specified by:

sessionCreated in interface IoHandler

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(IoSession session)
                   throws java.lang.Exception

Specified by:

sessionClosed in interface IoHandler

Throws:

java.lang.Exception

messageReceived

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

Specified by:

messageReceived in interface IoHandler

Throws:

java.lang.Exception

exceptionCaught

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

Specified by:

exceptionCaught in interface IoHandler

Throws:

java.lang.Exception