Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 9B268200C05 for ; Mon, 23 Jan 2017 07:58:07 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 99CB2160B58; Mon, 23 Jan 2017 06:58:07 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 978F9160B49 for ; Mon, 23 Jan 2017 07:58:05 +0100 (CET) Received: (qmail 64227 invoked by uid 500); 23 Jan 2017 06:58:04 -0000 Mailing-List: contact commits-help@guacamole.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@guacamole.incubator.apache.org Delivered-To: mailing list commits@guacamole.incubator.apache.org Received: (qmail 64218 invoked by uid 99); 23 Jan 2017 06:58:04 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 23 Jan 2017 06:58:04 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id 1E7CBC0D33 for ; Mon, 23 Jan 2017 06:58:04 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -5.019 X-Spam-Level: X-Spam-Status: No, score=-5.019 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-2.999] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id 9HE6oZZUG1gP for ; Mon, 23 Jan 2017 06:57:52 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id 384155FE06 for ; Mon, 23 Jan 2017 06:57:32 +0000 (UTC) Received: (qmail 62446 invoked by uid 99); 23 Jan 2017 06:57:31 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 23 Jan 2017 06:57:31 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C0E90DFF88; Mon, 23 Jan 2017 06:57:31 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mjumper@apache.org To: commits@guacamole.incubator.apache.org Date: Mon, 23 Jan 2017 06:58:06 -0000 Message-Id: <42f504a8f8d542b98a1424def0af5fe5@git.apache.org> In-Reply-To: <7948435a72d445aaa269bce1cd9ac8ad@git.apache.org> References: <7948435a72d445aaa269bce1cd9ac8ad@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [37/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.11-incubating. archived-at: Mon, 23 Jan 2017 06:58:07 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/43af1d75/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html new file mode 100644 index 0000000..5a6fa4c --- /dev/null +++ b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecord.html @@ -0,0 +1,434 @@ + + + + + + +ConnectionRecord (guacamole-ext 0.9.11-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Interface ConnectionRecord

+
+
+
+
    +
  • +
    +
    +
    public interface ConnectionRecord
    +
    A logging record describing when a user started and ended usage of a + particular connection.
    +
    +
    Author:
    +
    Michael Jumper
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      StringgetConnectionIdentifier() +
      Returns the identifier of the connection associated with this + connection record.
      +
      StringgetConnectionName() +
      Returns the name of the connection associated with this connection + record.
      +
      DategetEndDate() +
      Returns the date and time the connection ended, if applicable.
      +
      StringgetRemoteHost() +
      Returns the hostname or IP address of the remote host that used the + connection associated with this record, if known.
      +
      StringgetSharingProfileIdentifier() +
      Returns the identifier of the sharing profile that was used to access the + connection associated with this connection record.
      +
      StringgetSharingProfileName() +
      Returns the name of the sharing profile that was used to access the + connection associated with this connection record.
      +
      DategetStartDate() +
      Returns the date and time the connection began.
      +
      StringgetUsername() +
      Returns the name of the user who used or is using the connection at the + times given by this connection record.
      +
      booleanisActive() +
      Returns whether the connection associated with this record is still + active.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConnectionIdentifier

        +
        String getConnectionIdentifier()
        +
        Returns the identifier of the connection associated with this + connection record.
        +
        +
        Returns:
        +
        The identifier of the connection associated with this connection + record.
        +
        +
        • +
      + + + +
        +
      • +

        getConnectionName

        +
        String getConnectionName()
        +
        Returns the name of the connection associated with this connection + record.
        +
        +
        Returns:
        +
        The name of the connection associated with this connection record.
        +
        +
        • +
      + + + +
        +
      • +

        getSharingProfileIdentifier

        +
        String getSharingProfileIdentifier()
        +
        Returns the identifier of the sharing profile that was used to access the + connection associated with this connection record. If the connection was + accessed directly (without involving a sharing profile), this will be + null.
        +
        +
        Returns:
        +
        The identifier of the sharing profile used to access the connection + associated with this connection record, or null if the connection + was accessed directly.
        +
        +
        • +
      + + + +
        +
      • +

        getSharingProfileName

        +
        String getSharingProfileName()
        +
        Returns the name of the sharing profile that was used to access the + connection associated with this connection record. If the connection was + accessed directly (without involving a sharing profile), this will be + null.
        +
        +
        Returns:
        +
        The name of the sharing profile used to access the connection + associated with this connection record, or null if the connection + was accessed directly.
        +
        +
        • +
      + + + +
        +
      • +

        getStartDate

        +
        Date getStartDate()
        +
        Returns the date and time the connection began.
        +
        +
        Returns:
        +
        The date and time the connection began.
        +
        +
        • +
      + + + +
        +
      • +

        getEndDate

        +
        Date getEndDate()
        +
        Returns the date and time the connection ended, if applicable.
        +
        +
        Returns:
        +
        The date and time the connection ended, or null if the + connection is still running or if the end time is unknown.
        +
        +
        • +
      + + + +
        +
      • +

        getRemoteHost

        +
        String getRemoteHost()
        +
        Returns the hostname or IP address of the remote host that used the + connection associated with this record, if known. If the hostname or IP + address is not known, null is returned.
        +
        +
        Returns:
        +
        The hostname or IP address of the remote host, or null if this + information is not available.
        +
        +
        • +
      + + + +
        +
      • +

        getUsername

        +
        String getUsername()
        +
        Returns the name of the user who used or is using the connection at the + times given by this connection record.
        +
        +
        Returns:
        +
        The name of the user who used or is using the associated + connection.
        +
        +
        • +
      + + + +
        +
      • +

        isActive

        +
        boolean isActive()
        +
        Returns whether the connection associated with this record is still + active.
        +
        +
        Returns:
        +
        true if the connection associated with this record is still + active, false otherwise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/43af1d75/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html new file mode 100644 index 0000000..5b255f4 --- /dev/null +++ b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.SortableProperty.html @@ -0,0 +1,352 @@ + + + + + + +ConnectionRecordSet.SortableProperty (guacamole-ext 0.9.11-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Enum ConnectionRecordSet.SortableProperty

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ConnectionRecordSet.SortableProperty[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ConnectionRecordSet.SortableProperty c : ConnectionRecordSet.SortableProperty.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ConnectionRecordSet.SortableProperty valueOf(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/43af1d75/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html new file mode 100644 index 0000000..fec35a1 --- /dev/null +++ b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionRecordSet.html @@ -0,0 +1,380 @@ + + + + + + +ConnectionRecordSet (guacamole-ext 0.9.11-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Interface ConnectionRecordSet

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    SimpleConnectionRecordSet
    +
    +
    +
    +
    public interface ConnectionRecordSet
    +
    The set of all available connection records, or a subset of those records.
    +
    +
    Author:
    +
    James Muehlner, Michael Jumper
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        asCollection

        +
        Collection<ConnectionRecord> asCollection()
+                                   throws org.apache.guacamole.GuacamoleException
        +
        Returns all connection records within this set as a standard Collection.
        +
        +
        Returns:
        +
        A collection containing all connection records within this set.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the connection records within + this set.
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        ConnectionRecordSet contains(String value)
+                      throws org.apache.guacamole.GuacamoleException
        +
        Returns the subset of connection records to only those where the + connection name, user identifier, or any associated date field contain + the given value. This function may also affect the contents of the + current ConnectionRecordSet. The contents of the current + ConnectionRecordSet should NOT be relied upon after this function is + called.
        +
        +
        Parameters:
        +
        value - The value which all connection records within the resulting subset + should contain within their associated connection name or user + identifier.
        +
        Returns:
        +
        The subset of connection history records which contain the specified + value within their associated connection name or user identifier.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while restricting the current subset.
        +
        +
        • +
      + + + +
        +
      • +

        limit

        +
        ConnectionRecordSet limit(int limit)
+                   throws org.apache.guacamole.GuacamoleException
        +
        Returns the subset of connection history records containing only the + first limit records. If the subset has fewer than + limit records, then this function has no effect. This + function may also affect the contents of the current + ConnectionRecordSet. The contents of the current ConnectionRecordSet + should NOT be relied upon after this function is called.
        +
        +
        Parameters:
        +
        limit - The maximum number of records that the new subset should contain.
        +
        Returns:
        +
        The subset of connection history records that containing only the + first limit records.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while limiting the current subset.
        +
        +
        • +
      + + + +
        +
      • +

        sort

        +
        ConnectionRecordSet sort(ConnectionRecordSet.SortableProperty property,
+                         boolean desc)
+                  throws org.apache.guacamole.GuacamoleException
        +
        Returns a ConnectionRecordSet containing identically the records within + this set, sorted according to the specified criteria. The sort operation + performed is guaranteed to be stable with respect to any past call to + sort(). This function may also affect the contents of the current + ConnectionRecordSet. The contents of the current ConnectionRecordSet + should NOT be relied upon after this function is called.
        +
        +
        Parameters:
        +
        property - The property by which the connection records within the resulting + set should be sorted.
        +
        desc - Whether the records should be sorted according to the specified + property in descending order. If false, records will be sorted + according to the specified property in ascending order.
        +
        Returns:
        +
        The ConnnectionRecordSet, sorted according to the specified + criteria.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while sorting the current subset.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/43af1d75/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html new file mode 100644 index 0000000..da04b23 --- /dev/null +++ b/content/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/Credentials.html @@ -0,0 +1,455 @@ + + + + + + +Credentials (guacamole-ext 0.9.11-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Class Credentials

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    +
    public class Credentials
+extends Object
+implements Serializable
    +
    Simple arbitrary set of credentials, including a username/password pair, + the HttpServletRequest associated with the request for authorization + (if any) and the HttpSession associated with that request. + + This class is used along with AuthenticationProvider to provide arbitrary + HTTP-based authentication for Guacamole.
    +
    +
    Author:
    +
    Michael Jumper
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Credentials() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      StringgetPassword() +
      Returns the password associated with this set of credentials.
      +
      javax.servlet.http.HttpServletRequestgetRequest() +
      Returns the HttpServletRequest associated with this set of credentials.
      +
      javax.servlet.http.HttpSessiongetSession() +
      Returns the HttpSession associated with this set of credentials.
      +
      StringgetUsername() +
      Returns the username associated with this set of credentials.
      +
      voidsetPassword(String password) +
      Sets the password associated with this set of credentials.
      +
      voidsetRequest(javax.servlet.http.HttpServletRequest request) +
      Sets the HttpServletRequest associated with this set of credentials.
      +
      voidsetSession(javax.servlet.http.HttpSession session) +
      Sets the HttpSession associated with this set of credentials.
      +
      voidsetUsername(String username) +
      Sets the username associated with this set of credentials.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Credentials

        +
        public Credentials()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPassword

        +
        public String getPassword()
        +
        Returns the password associated with this set of credentials.
        +
        +
        Returns:
        +
        The password associated with this username/password pair, or + null if no password has been set.
        +
        +
        • +
      + + + +
        +
      • +

        setPassword

        +
        public void setPassword(String password)
        +
        Sets the password associated with this set of credentials.
        +
        +
        Parameters:
        +
        password - The password to associate with this username/password + pair.
        +
        +
        • +
      + + + +
        +
      • +

        getUsername

        +
        public String getUsername()
        +
        Returns the username associated with this set of credentials.
        +
        +
        Returns:
        +
        The username associated with this username/password pair, or + null if no username has been set.
        +
        +
        • +
      + + + +
        +
      • +

        setUsername

        +
        public void setUsername(String username)
        +
        Sets the username associated with this set of credentials.
        +
        +
        Parameters:
        +
        username - The username to associate with this username/password + pair.
        +
        +
        • +
      + + + +
        +
      • +

        getRequest

        +
        public javax.servlet.http.HttpServletRequest getRequest()
        +
        Returns the HttpServletRequest associated with this set of credentials.
        +
        +
        Returns:
        +
        The HttpServletRequest associated with this set of credentials, + or null if no such request exists.
        +
        +
        • +
      + + + +
        +
      • +

        setRequest

        +
        public void setRequest(javax.servlet.http.HttpServletRequest request)
        +
        Sets the HttpServletRequest associated with this set of credentials.
        +
        +
        Parameters:
        +
        request - The HttpServletRequest to associated with this set of + credentials.
        +
        +
        • +
      + + + +
        +
      • +

        getSession

        +
        public javax.servlet.http.HttpSession getSession()
        +
        Returns the HttpSession associated with this set of credentials.
        +
        +
        Returns:
        +
        The HttpSession associated with this set of credentials, or null + if no such request exists.
        +
        +
        • +
      + + + +
        +
      • +

        setSession

        +
        public void setSession(javax.servlet.http.HttpSession session)
        +
        Sets the HttpSession associated with this set of credentials.
        +
        +
        Parameters:
        +
        session - The HttpSession to associated with this set of + credentials.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + +