org.apache.guacamole.protocol

Class FilteredGuacamoleSocket

java.lang.Object

org.apache.guacamole.protocol.FilteredGuacamoleSocket

All Implemented Interfaces:

GuacamoleSocket

public class FilteredGuacamoleSocket
extends Object
implements GuacamoleSocket

Implementation of GuacamoleSocket which allows individual instructions to be intercepted, overridden, etc.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
FilteredGuacamoleSocket(GuacamoleSocket socket, GuacamoleFilter readFilter, GuacamoleFilter writeFilter) Creates a new FilteredGuacamoleSocket which uses the given filters to determine whether instructions read/written are allowed through, modified, etc.

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

FilteredGuacamoleSocket

public FilteredGuacamoleSocket(GuacamoleSocket socket,
                               GuacamoleFilter readFilter,
                               GuacamoleFilter writeFilter)

Creates a new FilteredGuacamoleSocket which uses the given filters to determine whether instructions read/written are allowed through, modified, etc. If reads or writes should be unfiltered, simply specify null rather than a particular filter.

Parameters:

socket - The GuacamoleSocket to wrap.

readFilter - The GuacamoleFilter to apply to all read instructions, if any.

writeFilter - The GuacamoleFilter to apply to all written instructions, if any.

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.