org.apache.guacamole.protocol

Class FailoverGuacamoleSocket

java.lang.Object

org.apache.guacamole.protocol.FailoverGuacamoleSocket

All Implemented Interfaces:

GuacamoleSocket

public class FailoverGuacamoleSocket
extends Object
implements GuacamoleSocket

GuacamoleSocket which intercepts errors received early in the Guacamole session. Upstream errors which are intercepted early enough result in exceptions thrown immediately within the FailoverGuacamoleSocket's constructor, allowing a different socket to be substituted prior to fulfilling the connection.

Constructor Summary

Constructors

Constructor and Description
FailoverGuacamoleSocket(GuacamoleSocket socket) Creates a new FailoverGuacamoleSocket which reads Guacamole instructions from the given socket, searching for errors from the upstream remote desktop.

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources in use by the connection represented by this GuacamoleSocket.
GuacamoleReader	getReader() Returns a GuacamoleReader which can be used to read from the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
GuacamoleWriter	getWriter() Returns a GuacamoleWriter which can be used to write to the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.
boolean	isOpen() Returns whether this GuacamoleSocket is open and can be used for reading and writing.

Methods inherited from class java.lang.Object

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

Constructor Detail

FailoverGuacamoleSocket

public FailoverGuacamoleSocket(GuacamoleSocket socket)
                        throws GuacamoleException,
                               GuacamoleUpstreamException

Creates a new FailoverGuacamoleSocket which reads Guacamole instructions from the given socket, searching for errors from the upstream remote desktop. If an upstream error is encountered, it is thrown as a GuacamoleUpstreamException. This constructor will block until an error is encountered, or until the connection appears to have been successful. Once the FailoverGuacamoleSocket has been created, all reads, writes, etc. will be delegated to the provided socket.

Parameters:

socket - The GuacamoleSocket of the Guacamole connection this FailoverGuacamoleSocket should handle.

Throws:

GuacamoleException - If an error occurs while reading data from the provided socket.

GuacamoleUpstreamException - If the connection to guacd succeeded, but an error occurred while connecting to the remote desktop.

Method Detail

getReader

public GuacamoleReader getReader()

Description copied from interface: GuacamoleSocket

Returns a GuacamoleReader which can be used to read from the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.

Specified by:

getReader in interface GuacamoleSocket

Returns:

A GuacamoleReader which can be used to read from the Guacamole instruction stream.

getWriter

public GuacamoleWriter getWriter()

Description copied from interface: GuacamoleSocket

Returns a GuacamoleWriter which can be used to write to the Guacamole instruction stream associated with the connection represented by this GuacamoleSocket.

Specified by:

getWriter in interface GuacamoleSocket

Returns:

A GuacamoleWriter which can be used to write to the Guacamole instruction stream.

close

public void close()
           throws GuacamoleException

Description copied from interface: GuacamoleSocket

Releases all resources in use by the connection represented by this GuacamoleSocket.

Specified by:

close in interface GuacamoleSocket

Throws:

GuacamoleException - If an error occurs while releasing resources.

isOpen

public boolean isOpen()

Description copied from interface: GuacamoleSocket

Returns whether this GuacamoleSocket is open and can be used for reading and writing.

Specified by:

isOpen in interface GuacamoleSocket

Returns:

true if this GuacamoleSocket is open, false otherwise.