You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by mj...@apache.org on 2016/03/20 03:15:38 UTC
[28/50] incubator-guacamole-manual git commit: GUAC-1436: Add JavaDoc
comments for authentication tutorial classes.
GUAC-1436: Add JavaDoc comments for authentication tutorial classes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/02ec9c63
Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/02ec9c63
Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/02ec9c63
Branch: refs/heads/master
Commit: 02ec9c6367a247cab4e1451fd5f4f2c75d960c0b
Parents: 45c2d74
Author: Michael Jumper <mi...@guac-dev.org>
Authored: Thu Dec 17 13:04:34 2015 -0800
Committer: Michael Jumper <mi...@guac-dev.org>
Committed: Thu Dec 17 13:04:34 2015 -0800
----------------------------------------------------------------------
src/chapters/custom-auth.xml | 10 ++++++++++
.../guacamole/auth/TutorialAuthenticationProvider.java | 5 +++++
.../guacamole/auth/TutorialGuacamoleProperties.java | 5 +++++
3 files changed, 20 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/02ec9c63/src/chapters/custom-auth.xml
----------------------------------------------------------------------
diff --git a/src/chapters/custom-auth.xml b/src/chapters/custom-auth.xml
index 5977336..9134750 100644
--- a/src/chapters/custom-auth.xml
+++ b/src/chapters/custom-auth.xml
@@ -121,6 +121,11 @@ import org.glyptodon.guacamole.net.auth.simple.SimpleAuthenticationProvider;
import org.glyptodon.guacamole.net.auth.Credentials;
import org.glyptodon.guacamole.protocol.GuacamoleConfiguration;
+/**
+ * Authentication provider implementation intended to demonstrate basic use
+ * of Guacamole's extension API. The credentials and connection information for
+ * a single user are stored directly in guacamole.properties.
+ */
public class TutorialAuthenticationProvider extends SimpleAuthenticationProvider {
@Override
@@ -208,6 +213,11 @@ public class TutorialAuthenticationProvider extends SimpleAuthenticationProvider
import org.glyptodon.guacamole.properties.StringGuacamoleProperty;
+/**
+ * Utility class containing all properties used by the custom authentication
+ * tutorial. The properties defined here must be specified within
+ * guacamole.properties to configure the tutorial authentication provider.
+ */
public class TutorialGuacamoleProperties {
/**
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/02ec9c63/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialAuthenticationProvider.java
----------------------------------------------------------------------
diff --git a/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialAuthenticationProvider.java b/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialAuthenticationProvider.java
index 4084b6b..98131ef 100644
--- a/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialAuthenticationProvider.java
+++ b/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialAuthenticationProvider.java
@@ -10,6 +10,11 @@ import org.glyptodon.guacamole.net.auth.simple.SimpleAuthenticationProvider;
import org.glyptodon.guacamole.net.auth.Credentials;
import org.glyptodon.guacamole.protocol.GuacamoleConfiguration;
+/**
+ * Authentication provider implementation intended to demonstrate basic use
+ * of Guacamole's extension API. The credentials and connection information for
+ * a single user are stored directly in guacamole.properties.
+ */
public class TutorialAuthenticationProvider extends SimpleAuthenticationProvider {
@Override
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/02ec9c63/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialGuacamoleProperties.java
----------------------------------------------------------------------
diff --git a/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialGuacamoleProperties.java b/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialGuacamoleProperties.java
index 4f98d0c..75f0298 100644
--- a/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialGuacamoleProperties.java
+++ b/tutorials/guacamole-auth-tutorial/src/main/java/org/glyptodon/guacamole/auth/TutorialGuacamoleProperties.java
@@ -2,6 +2,11 @@ package org.glyptodon.guacamole.auth;
import org.glyptodon.guacamole.properties.StringGuacamoleProperty;
+/**
+ * Utility class containing all properties used by the custom authentication
+ * tutorial. The properties defined here must be specified within
+ * guacamole.properties to configure the tutorial authentication provider.
+ */
public class TutorialGuacamoleProperties {
/**