From 93b186f8cd2a35a52901945c8190863ef04c4b32 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Tue, 13 Dec 2011 18:04:14 -0800 Subject: [PATCH 1/4] Added README --- guacamole-common/README | 76 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 guacamole-common/README diff --git a/guacamole-common/README b/guacamole-common/README new file mode 100644 index 000000000..f3769e311 --- /dev/null +++ b/guacamole-common/README @@ -0,0 +1,76 @@ + +------------------------------------------------------------ + About this README +------------------------------------------------------------ + +This README is intended to provide quick and to-the-point documentation for +technical users intending to compile parts of Guacamole themselves. + +Distribution-specific packages are available from the files section of the main +project page: + + http://sourceforge.net/projects/guacamole/files/ + +Distribution-specific documentation is provided on the Guacamole wiki: + + http://guac-dev.org/ + + +------------------------------------------------------------ + What is guacamole-common? +------------------------------------------------------------ + +guacamole-common is the core Java library used by the Guacamole web +application. + +guacamole-common provides abstract means of connecting to guacd, interfacing +with the JavaScript client and tunnel provided by guacamole-common-js, and +reading configuration from a standard location (guacamole.properties). + + +------------------------------------------------------------ + Compiling and installing guacamole-common +------------------------------------------------------------ + +guacamole-common is built using Maven. Building guacamole-common-js +compiles all classes and packages them into a redistributable .jar file. This +.jar file can be easily included in other Maven-based projects (like Guacamole). + +Note that prebuilt versions of guacamole-common are available from the +main guac-dev.org Maven repository which is referenced in all Maven +projects in Guacamole. Unless you want to make changes to guacamole-common +or you want to use a newer, unreleased version (such as the unstable branch), +you do not need to build this manually. You can let Maven download it for +you when you build Guacamole. + +1) Run mvn package + + $ mvn package + + Maven will download any needed dependencies for building the .jar file. + Once all dependencies have been downloaded, the .jar file will be + created in the target/ subdirectory of the current directory. + +2) Run mvn install + + $ mvn install + + DO NOT RUN THIS AS ROOT! + + Maven will install guacamole-common to your user's local Maven + repository where it can be used in future builds. It will not install + into a system-wide repository and does not require root privileges. + + Once installed, building other Maven projects that depend on + guacamole-common (such as Guacamole) will be possible. + + +------------------------------------------------------------ + Reporting problems +------------------------------------------------------------ + +Please report any bugs encountered by opening a new ticket at the Trac system +hosted at: + + http://guac-dev.org/trac/ + From 75dd6a4ffac8907bd982796c47c097a68be71563 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 18 Dec 2011 12:34:56 -0800 Subject: [PATCH 2/4] Added changelog. --- guacamole-common/ChangeLog | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 guacamole-common/ChangeLog diff --git a/guacamole-common/ChangeLog b/guacamole-common/ChangeLog new file mode 100644 index 000000000..7563099b6 --- /dev/null +++ b/guacamole-common/ChangeLog @@ -0,0 +1,19 @@ +2011-12-11 Michael Jumper + + * Implemented improved instruction format + * Fixed failed connections when using Konqueror + * Relicensed as Mozilla/LGPL/GPL + +2011-07-13 Michael Jumper + + * Fixed "no element found" errors + * Added timeouts + * Multiple tunnel support + * Better error handling + * Added JavaDoc + * Added logging + +2011-03-02 Michael Jumper + + * Initial release + From 3a95a270acec819e0d4ffb3806ea50bbf99e2d7e Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 18 Dec 2011 14:56:02 -0800 Subject: [PATCH 3/4] Fixed typo README --- guacamole-common/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guacamole-common/README b/guacamole-common/README index f3769e311..68bf72358 100644 --- a/guacamole-common/README +++ b/guacamole-common/README @@ -32,7 +32,7 @@ reading configuration from a standard location (guacamole.properties). Compiling and installing guacamole-common ------------------------------------------------------------ -guacamole-common is built using Maven. Building guacamole-common-js +guacamole-common is built using Maven. Building guacamole-common compiles all classes and packages them into a redistributable .jar file. This .jar file can be easily included in other Maven-based projects (like Guacamole). From 2f3e8d3643191d5846ef9562be30d2003aeb6cf6 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sun, 18 Dec 2011 21:31:56 -0800 Subject: [PATCH 4/4] Fixed comments. --- guacamole-common/doc/example/ExampleTunnelServlet.java | 4 ++-- .../net/sourceforge/guacamole/io/ReaderGuacamoleReader.java | 3 +++ .../net/sourceforge/guacamole/io/WriterGuacamoleWriter.java | 3 +++ .../net/sourceforge/guacamole/net/InetGuacamoleSocket.java | 1 - 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/guacamole-common/doc/example/ExampleTunnelServlet.java b/guacamole-common/doc/example/ExampleTunnelServlet.java index d335754f6..00f409859 100644 --- a/guacamole-common/doc/example/ExampleTunnelServlet.java +++ b/guacamole-common/doc/example/ExampleTunnelServlet.java @@ -9,9 +9,9 @@ import net.sourceforge.guacamole.net.InetGuacamoleSocket; import net.sourceforge.guacamole.protocol.GuacamoleConfiguration; import net.sourceforge.guacamole.protocol.ConfiguredGuacamoleSocket; import net.sourceforge.guacamole.servlet.GuacamoleSession; -import net.sourceforge.guacamole.servlet.GuacamoleTunnelServlet; +import net.sourceforge.guacamole.servlet.GuacamoleHTTPTunnelServlet; -public class ExampleTunnelServlet extends GuacamoleTunnelServlet { +public class ExampleTunnelServlet extends GuacamoleHTTPTunnelServlet { @Override protected GuacamoleTunnel doConnect(HttpServletRequest request) diff --git a/guacamole-common/src/main/java/net/sourceforge/guacamole/io/ReaderGuacamoleReader.java b/guacamole-common/src/main/java/net/sourceforge/guacamole/io/ReaderGuacamoleReader.java index c5de457da..0d1164083 100644 --- a/guacamole-common/src/main/java/net/sourceforge/guacamole/io/ReaderGuacamoleReader.java +++ b/guacamole-common/src/main/java/net/sourceforge/guacamole/io/ReaderGuacamoleReader.java @@ -53,6 +53,9 @@ import org.apache.commons.lang3.ArrayUtils; */ public class ReaderGuacamoleReader implements GuacamoleReader { + /** + * Wrapped Reader to be used for all input. + */ private Reader input; /** diff --git a/guacamole-common/src/main/java/net/sourceforge/guacamole/io/WriterGuacamoleWriter.java b/guacamole-common/src/main/java/net/sourceforge/guacamole/io/WriterGuacamoleWriter.java index ded7cf82d..fca0d6bf7 100644 --- a/guacamole-common/src/main/java/net/sourceforge/guacamole/io/WriterGuacamoleWriter.java +++ b/guacamole-common/src/main/java/net/sourceforge/guacamole/io/WriterGuacamoleWriter.java @@ -50,6 +50,9 @@ import net.sourceforge.guacamole.protocol.GuacamoleInstruction; */ public class WriterGuacamoleWriter implements GuacamoleWriter { + /** + * Wrapped Writer to be used for all output. + */ private Writer output; /** diff --git a/guacamole-common/src/main/java/net/sourceforge/guacamole/net/InetGuacamoleSocket.java b/guacamole-common/src/main/java/net/sourceforge/guacamole/net/InetGuacamoleSocket.java index bb3268c01..af38242d6 100644 --- a/guacamole-common/src/main/java/net/sourceforge/guacamole/net/InetGuacamoleSocket.java +++ b/guacamole-common/src/main/java/net/sourceforge/guacamole/net/InetGuacamoleSocket.java @@ -54,7 +54,6 @@ import net.sourceforge.guacamole.GuacamoleException; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - /** * Provides abstract socket-like access to a Guacamole connection over a given * hostname and port.