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 0FCDE200C37 for ; Sun, 19 Mar 2017 23:49:08 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 0E685160B97; Sun, 19 Mar 2017 22:49:08 +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 C4C10160B6D for ; Sun, 19 Mar 2017 23:49:05 +0100 (CET) Received: (qmail 9694 invoked by uid 500); 19 Mar 2017 22:49:05 -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 9684 invoked by uid 99); 19 Mar 2017 22:49:05 -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; Sun, 19 Mar 2017 22:49: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 3F2C0C028B for ; Sun, 19 Mar 2017 22:49:04 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -2.369 X-Spam-Level: X-Spam-Status: No, score=-2.369 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_NEUTRAL=0.652] 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 JucvFfz8SSn8 for ; Sun, 19 Mar 2017 22:48:50 +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 DAC4D5FE47 for ; Sun, 19 Mar 2017 22:48:47 +0000 (UTC) Received: (qmail 8808 invoked by uid 99); 19 Mar 2017 22:48:47 -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; Sun, 19 Mar 2017 22:48:47 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id DD979F4B58; Sun, 19 Mar 2017 22:48:46 +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: Sun, 19 Mar 2017 22:48:50 -0000 Message-Id: In-Reply-To: <93aebcc0251142d4a4e4e5b9789d3275@git.apache.org> References: <93aebcc0251142d4a4e4e5b9789d3275@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [05/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.12-incubating. archived-at: Sun, 19 Mar 2017 22:49:08 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connectable.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connectable.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connectable.html new file mode 100644 index 0000000..fdda69a --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connectable.html @@ -0,0 +1,283 @@ + + + + + + +Connectable (guacamole-ext 0.9.12-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Interface Connectable

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

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      org.apache.guacamole.net.GuacamoleTunnelconnect(org.apache.guacamole.protocol.GuacamoleClientInformation info) +
      Establishes a connection to guacd using the information associated with + this object.
      +
      intgetActiveConnections() +
      Returns the number of active connections associated with this object.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        connect

        +
        org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info)
+                                          throws org.apache.guacamole.GuacamoleException
        +
        Establishes a connection to guacd using the information associated with + this object. The connection will be provided the given client + information.
        +
        +
        Parameters:
        +
        info - Information associated with the connecting client.
        +
        Returns:
        +
        A fully-established GuacamoleTunnel.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while connecting to guacd, or if permission to + connect is denied.
        +
        +
        • +
      + + + +
        +
      • +

        getActiveConnections

        +
        int getActiveConnections()
        +
        Returns the number of active connections associated with this object. + Implementations may simply return 0 if this value is not tracked.
        +
        +
        Returns:
        +
        The number of active connections associated with this object.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
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/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connection.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connection.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connection.html new file mode 100644 index 0000000..5bd703e --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/Connection.html @@ -0,0 +1,486 @@ + + + + + + +Connection (guacamole-ext 0.9.12-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Interface Connection

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Connectable, Identifiable
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractConnection, SimpleConnection
    +
    +
    +
    +
    public interface Connection
+extends Identifiable, Connectable
    +
    Represents a pairing of a GuacamoleConfiguration with a unique, + human-readable identifier, and abstracts the connection process. The + backing GuacamoleConfiguration may be intentionally obfuscated or tokenized + to protect sensitive configuration information.
    +
    +
    Author:
    +
    Michael Jumper
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        String getName()
        +
        Returns the name assigned to this Connection.
        +
        +
        Returns:
        +
        The name assigned to this Connection.
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        void setName(String name)
        +
        Sets the name assigned to this Connection.
        +
        +
        Parameters:
        +
        name - The name to assign.
        +
        +
        • +
      + + + +
        +
      • +

        getParentIdentifier

        +
        String getParentIdentifier()
        +
        Returns the unique identifier of the parent ConnectionGroup for + this Connection.
        +
        +
        Returns:
        +
        The unique identifier of the parent ConnectionGroup for + this Connection.
        +
        +
        • +
      + + + +
        +
      • +

        setParentIdentifier

        +
        void setParentIdentifier(String parentIdentifier)
        +
        Sets the unique identifier of the parent ConnectionGroup for + this Connection.
        +
        +
        Parameters:
        +
        parentIdentifier - The unique identifier of the parent + ConnectionGroup for this Connection.
        +
        +
        • +
      + + + +
        +
      • +

        getConfiguration

        +
        org.apache.guacamole.protocol.GuacamoleConfiguration getConfiguration()
        +
        Returns the GuacamoleConfiguration associated with this Connection. Note + that because configurations may contain sensitive information, some data + in this configuration may be omitted or tokenized.
        +
        +
        Returns:
        +
        The GuacamoleConfiguration associated with this Connection.
        +
        +
        • +
      + + + +
        +
      • +

        setConfiguration

        +
        void setConfiguration(org.apache.guacamole.protocol.GuacamoleConfiguration config)
        +
        Sets the GuacamoleConfiguration associated with this Connection.
        +
        +
        Parameters:
        +
        config - The GuacamoleConfiguration to associate with this + Connection.
        +
        +
        • +
      + + + +
        +
      • +

        getAttributes

        +
        Map<String,String> getAttributes()
        +
        Returns all attributes associated with this connection. The returned map + may not be modifiable.
        +
        +
        Returns:
        +
        A map of all attribute identifiers to their corresponding values, + for all attributes associated with this connection, which may not be + modifiable.
        +
        +
        • +
      + + + +
        +
      • +

        setAttributes

        +
        void setAttributes(Map<String,String> attributes)
        +
        Sets the given attributes. If an attribute within the map is not + supported, it will simply be dropped. Any attributes not within the + given map will be left untouched.
        +
        +
        Parameters:
        +
        attributes - A map of all attribute identifiers to their corresponding values.
        +
        +
        • +
      + + + +
        +
      • +

        getHistory

        +
        List<? extends ConnectionRecord> getHistory()
+                                     throws org.apache.guacamole.GuacamoleException
        +
        Returns a list of ConnectionRecords representing the usage history + of this Connection, including any active users. ConnectionRecords + in this list will be sorted in descending order of end time (active + connections are first), and then in descending order of start time + (newer connections are first).
        +
        +
        Returns:
        +
        A list of ConnectionRecrods representing the usage history + of this Connection.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while reading the history + of this connection, or if permission is + denied.
        +
        +
        • +
      + + + +
        +
      • +

        getSharingProfileIdentifiers

        +
        Set<String> getSharingProfileIdentifiers()
+                                  throws org.apache.guacamole.GuacamoleException
        +
        Returns identifiers of all readable sharing profiles that can be used to + join this connection when it is active. The level of access granted to a + joining user is dictated by the connection parameters associated with + the sharing profile, not necessarily the parameters of the primary + connection being joined.
        +
        +
        Returns:
        +
        A Set of identifiers representing the sharing profiles for this + connection.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while fetching the sharing profiles for this + connection.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
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/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.Type.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.Type.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.Type.html new file mode 100644 index 0000000..cb0065d --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.Type.html @@ -0,0 +1,371 @@ + + + + + + +ConnectionGroup.Type (guacamole-ext 0.9.12-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Enum ConnectionGroup.Type

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

      Enum Constant Detail

      + + + +
        +
      • +

        ORGANIZATIONAL

        +
        public static final ConnectionGroup.Type ORGANIZATIONAL
        +
        A connection group that purely organizes other connections or + connection groups, serving only as a container. An organizational + connection group is analogous to a directory or folder in a + filesystem.
        +
        • +
      + + + +
        +
      • +

        BALANCING

        +
        public static final ConnectionGroup.Type BALANCING
        +
        A connection group that acts as a load balancer. A balancing + connection group can be connected to in the same manner as a + connection, and will transparently route to the least-used + underlying connection.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ConnectionGroup.Type[] 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 (ConnectionGroup.Type c : ConnectionGroup.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ConnectionGroup.Type 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/31f2d19d/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.html b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.html new file mode 100644 index 0000000..80ea4f9 --- /dev/null +++ b/content/doc/0.9.12-incubating/guacamole-ext/org/apache/guacamole/net/auth/ConnectionGroup.html @@ -0,0 +1,493 @@ + + + + + + +ConnectionGroup (guacamole-ext 0.9.12-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net.auth
+

Interface ConnectionGroup

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

      Method Detail

      + + + +
        +
      • +

        getName

        +
        String getName()
        +
        Returns the name assigned to this ConnectionGroup.
        +
        +
        Returns:
        +
        The name assigned to this ConnectionGroup.
        +
        +
        • +
      + + + +
        +
      • +

        setName

        +
        void setName(String name)
        +
        Sets the name assigned to this ConnectionGroup.
        +
        +
        Parameters:
        +
        name - The name to assign.
        +
        +
        • +
      + + + +
        +
      • +

        getParentIdentifier

        +
        String getParentIdentifier()
        +
        Returns the unique identifier of the parent ConnectionGroup for + this ConnectionGroup.
        +
        +
        Returns:
        +
        The unique identifier of the parent ConnectionGroup for + this ConnectionGroup.
        +
        +
        • +
      + + + +
        +
      • +

        setParentIdentifier

        +
        void setParentIdentifier(String parentIdentifier)
        +
        Sets the unique identifier of the parent ConnectionGroup for + this ConnectionGroup.
        +
        +
        Parameters:
        +
        parentIdentifier - The unique identifier of the parent + ConnectionGroup for this ConnectionGroup.
        +
        +
        • +
      + + + +
        +
      • +

        setType

        +
        void setType(ConnectionGroup.Type type)
        +
        Set the type of this ConnectionGroup.
        +
        +
        Parameters:
        +
        type - The type of this ConnectionGroup.
        +
        +
        • +
      + + + +
        +
      • +

        getType

        +
        ConnectionGroup.Type getType()
        +
        Returns the type of this connection.
        +
        +
        Returns:
        +
        the type of this connection.
        +
        +
        • +
      + + + +
        +
      • +

        getConnectionIdentifiers

        +
        Set<String> getConnectionIdentifiers()
+                              throws org.apache.guacamole.GuacamoleException
        +
        Returns the identifiers of all readable connections that are children + of this connection group.
        +
        +
        Returns:
        +
        The set of identifiers of all readable connections that are children + of this connection group.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.
        +
        +
        • +
      + + + +
        +
      • +

        getConnectionGroupIdentifiers

        +
        Set<String> getConnectionGroupIdentifiers()
+                                   throws org.apache.guacamole.GuacamoleException
        +
        Returns the identifiers of all readable connection groups that are + children of this connection group.
        +
        +
        Returns:
        +
        The set of identifiers of all readable connection groups that are + children of this connection group.
        +
        Throws:
        +
        org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the identifiers.
        +
        +
        • +
      + + + +
        +
      • +

        getAttributes

        +
        Map<String,String> getAttributes()
        +
        Returns all attributes associated with this connection group. The + returned map may not be modifiable.
        +
        +
        Returns:
        +
        A map of all attribute identifiers to their corresponding values, + for all attributes associated with this connection group, which may + not be modifiable.
        +
        +
        • +
      + + + +
        +
      • +

        setAttributes

        +
        void setAttributes(Map<String,String> attributes)
        +
        Sets the given attributes. If an attribute within the map is not + supported, it will simply be dropped. Any attributes not within the + given map will be left untouched.
        +
        +
        Parameters:
        +
        attributes - A map of all attribute identifiers to their corresponding values.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + +