Repository: incubator-guacamole-client Updated Branches: refs/heads/staging/0.9.14-incubating d955fbea1 -> 0d74dc582
GUACAMOLE-362: Update documentation to reflect code. Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/commit/6f04573b Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/tree/6f04573b Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/diff/6f04573b Branch: refs/heads/staging/0.9.14-incubating Commit: 6f04573b8476a817dffa3bbd1fa97288644e37d3 Parents: 1592cf5 Author: Nick Couchman <vn...@apache.org> Authored: Wed Sep 27 10:25:52 2017 -0400 Committer: Nick Couchman <nick.couch...@yahoo.com> Committed: Fri Oct 27 13:05:12 2017 -0400 ---------------------------------------------------------------------- .../guacamole/auth/cas/conf/ConfigurationService.java | 7 +++---- .../auth/cas/ticket/TicketValidationService.java | 13 ++++++------- 2 files changed, 9 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/6f04573b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java ---------------------------------------------------------------------- diff --git a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java index 409097e..dee9c4d 100644 --- a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java +++ b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/conf/ConfigurationService.java @@ -71,12 +71,11 @@ public class ConfigurationService { } /** - * Returns the path to the file that contains the private key - * used to decrypt the credential that is sent encrypted by CAS, - * or null if no key is defined. + * Returns the PrivateKey used to decrypt the credential object + * sent encrypted by CAS, or null if no key is defined. * * @return - * The path to the private key to decrypt the ClearPass + * The PrivateKey used to decrypt the ClearPass * credential returned by CAS. * * @throws GuacamoleException http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/6f04573b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java ---------------------------------------------------------------------- diff --git a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java index fca2ccf..96da6ff 100644 --- a/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java +++ b/extensions/guacamole-auth-cas/src/main/java/org/apache/guacamole/auth/cas/ticket/TicketValidationService.java @@ -42,20 +42,19 @@ public class TicketValidationService { private ConfigurationService confService; /** - * Validates and parses the given ID ticket, returning the username contained - * therein, as defined by the username claim type given in - * guacamole.properties. If the username claim type is missing or the ID - * ticket is invalid, an exception is thrown instead. + * Validates and parses the given ID ticket, returning the AttributePrincipal + * derived from the parameters provided by the CAS server in the ticket. If the + * ticket is invalid an exception is thrown. * * @param ticket * The ID ticket to validate and parse. * * @return - * The username contained within the given ID ticket. + * The AttributePrincipal derived from parameters provided in the ticket. * * @throws GuacamoleException - * If the ID ticket is not valid, the username claim type is missing, or - * guacamole.properties could not be parsed. + * If the ID ticket is not valid or guacamole.properties could + * not be parsed. */ public AttributePrincipal validateTicket(String ticket) throws GuacamoleException {
