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 E9EE8200BB7 for ; Tue, 25 Oct 2016 23:56:08 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id E897A160AFA; Tue, 25 Oct 2016 21:56: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 911B6160B03 for ; Tue, 25 Oct 2016 23:56:06 +0200 (CEST) Received: (qmail 86824 invoked by uid 500); 25 Oct 2016 21:56:05 -0000 Mailing-List: contact commits-help@geode.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.incubator.apache.org Delivered-To: mailing list commits@geode.incubator.apache.org Received: (qmail 86713 invoked by uid 99); 25 Oct 2016 21:56:05 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 25 Oct 2016 21:56:05 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id A6BB418397F for ; Tue, 25 Oct 2016 21:56:04 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-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-us.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id vMJ3Tu90Cy8N for ; Tue, 25 Oct 2016 21:55:49 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with SMTP id 6A0955FC0E for ; Tue, 25 Oct 2016 21:55:45 +0000 (UTC) Received: (qmail 72494 invoked by uid 99); 25 Oct 2016 21:51:58 -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; Tue, 25 Oct 2016 21:51:58 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C3CD2E0BCE; Tue, 25 Oct 2016 21:51:58 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: sbawaskar@apache.org To: commits@geode.incubator.apache.org Date: Tue, 25 Oct 2016 21:52:24 -0000 Message-Id: <3761cd10e37344e79756fb26b54b2127@git.apache.org> In-Reply-To: <4e2243667d854ff08eecf532f23fe07d@git.apache.org> References: <4e2243667d854ff08eecf532f23fe07d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [27/51] [abbrv] [partial] incubator-geode git commit: Adding javadocs for the 1.0.0-incubating release archived-at: Tue, 25 Oct 2016 21:56:09 -0000 http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/DistributedSystemHealthConfig.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/DistributedSystemHealthConfig.html b/releases/latest/javadoc/org/apache/geode/admin/DistributedSystemHealthConfig.html new file mode 100644 index 0000000..d4591d8 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/DistributedSystemHealthConfig.html @@ -0,0 +1,333 @@ + + + + + +DistributedSystemHealthConfig (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.geode.admin
+

Interface DistributedSystemHealthConfig

+
+
+
+
    +
  • +
    +
    Deprecated.  +
    as of 7.0 use the management package instead
    +
    +
    +
    public interface DistributedSystemHealthConfig
    +
    Provides configuration information relating to the health of an + entire GemFire distributed system. + +

    + + If any of the following criteria is + true, then the distributed system is considered to be in + OKAY_HEALTH. + +

      + +
    + + If any of the following criteria is true, then the distributed + system is considered to be in POOR_HEALTH. + +
    +
    +
    Since:
    +
    GemFire 3.5
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static longDEFAULT_MAX_DEPARTED_APPLICATIONS +
      Deprecated. 
      +
      The default maximum number of application members that can + unexceptedly leave a healthy the distributed system.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT_MAX_DEPARTED_APPLICATIONS

        +
        static final long DEFAULT_MAX_DEPARTED_APPLICATIONS
        +
        Deprecated. 
        +
        The default maximum number of application members that can + unexceptedly leave a healthy the distributed system.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getMaxDepartedApplications

        +
        long getMaxDepartedApplications()
        +
        Deprecated. 
        +
        Returns the maximum number of application members that can + unexceptedly leave a healthy the distributed system.
        +
        +
        See Also:
        +
        DEFAULT_MAX_DEPARTED_APPLICATIONS
        +
        +
        • +
      + + + +
        +
      • +

        setMaxDepartedApplications

        +
        void setMaxDepartedApplications(long maxDepartedApplications)
        +
        Deprecated. 
        +
        Sets the maximum number of application members that can + unexceptedly leave a healthy the distributed system.
        +
        +
        See Also:
        +
        getMaxDepartedApplications()
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/DistributionLocator.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/DistributionLocator.html b/releases/latest/javadoc/org/apache/geode/admin/DistributionLocator.html new file mode 100644 index 0000000..b5a492c --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/DistributionLocator.html @@ -0,0 +1,271 @@ + + + + + +DistributionLocator (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.geode.admin
+

Interface DistributionLocator

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    ManagedEntity
    +
    +
    +
    Deprecated.  +
    as of 7.0 use the management package instead
    +
    +
    +
    public interface DistributionLocator
+extends ManagedEntity
    +
    Represents a single distribution locator server, of which a + distributed system may use zero or many. The distributed system + will be configured to use either multicast discovery or locator + service.
    +
    +
    Since:
    +
    GemFire 3.5
    +
    See Also:
    +
    DistributionLocatorConfig
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getId

        +
        java.lang.String getId()
        +
        Deprecated. 
        +
        Returns the identity name for this locator.
        +
        • +
      + + + +
        +
      • +

        getConfig

        +
        DistributionLocatorConfig getConfig()
        +
        Deprecated. 
        +
        Returns the configuration object for this distribution locator.
        +
        +
        Since:
        +
        GemFire 4.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/DistributionLocatorConfig.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/DistributionLocatorConfig.html b/releases/latest/javadoc/org/apache/geode/admin/DistributionLocatorConfig.html new file mode 100644 index 0000000..7704ded --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/DistributionLocatorConfig.html @@ -0,0 +1,374 @@ + + + + + +DistributionLocatorConfig (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.geode.admin
+

Interface DistributionLocatorConfig

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    java.lang.Cloneable, ManagedEntityConfig
    +
    +
    +
    Deprecated.  +
    as of 7.0 use the management package instead
    +
    +
    +
    public interface DistributionLocatorConfig
+extends ManagedEntityConfig
    +
    Describes the configuration of a DistributionLocator + managed by the GemFire administration APIs. + +

    + + A DistributionLocatorConfig can be modified using a + number of mutator methods until the + DistributionLocator configured by this object is + started. After that, + attempts to modify most attributes in the + DistributionLocatorConfig will result in an IllegalStateException being thrown. If you wish to use the same + DistributionLocatorConfig to configure another + DistributionLocators, a copy of the + DistributionLocatorConfig object can be made by + invoking the Object.clone() method.

    +
    +
    Since:
    +
    GemFire 4.0
    +
    See Also:
    +
    AdminDistributedSystem.addDistributionLocator(), +Locator
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPort

        +
        int getPort()
        +
        Deprecated. 
        +
        Returns the port on which ths distribution locator listens for + members to connect. There is no default locator port, so a + non-default port must be specified.
        +
        • +
      + + + +
        +
      • +

        setPort

        +
        void setPort(int port)
        +
        Deprecated. 
        +
        Sets the port on which the distribution locator listens for + members to connect.
        +
        • +
      + + + +
        +
      • +

        getBindAddress

        +
        java.lang.String getBindAddress()
        +
        Deprecated. 
        +
        Returns the address to which the distribution locator's port is + (or will be) bound. By default, the bind address is + null meaning that the port will be bound to all + network addresses on the host.
        +
        • +
      + + + +
        +
      • +

        setBindAddress

        +
        void setBindAddress(java.lang.String bindAddress)
        +
        Deprecated. 
        +
        Sets the address to which the distribution locator's port is + (or will be) bound.
        +
        • +
      + + + +
        +
      • +

        setDistributedSystemProperties

        +
        void setDistributedSystemProperties(java.util.Properties props)
        +
        Deprecated. 
        +
        Sets the properties used to configure the locator's + DistributedSystem.
        +
        +
        Since:
        +
        GemFire 5.0
        +
        +
        • +
      + + + +
        +
      • +

        getDistributedSystemProperties

        +
        java.util.Properties getDistributedSystemProperties()
        +
        Deprecated. 
        +
        Retrieves the properties used to configure the locator's + DistributedSystem.
        +
        +
        Since:
        +
        GemFire 5.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.Health.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.Health.html b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.Health.html new file mode 100644 index 0000000..848da59 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.Health.html @@ -0,0 +1,310 @@ + + + + + +GemFireHealth.Health (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.geode.admin
+

Class GemFireHealth.Health

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.geode.admin.GemFireHealth.Health
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    Enclosing interface:
    +
    GemFireHealth
    +
    +
    +
    +
    public static class GemFireHealth.Health
+extends java.lang.Object
+implements java.io.Serializable
    +
    An enumerated type for the health of GemFire.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected Health(java.lang.String healthString) +
      Creates a new Health with the given string
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.ObjectreadResolve() +
      Returns the appropriate canonical instance of + Health.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Health

        +
        protected Health(java.lang.String healthString)
        +
        Creates a new Health with the given string
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readResolve

        +
        public java.lang.Object readResolve()
        +
        Returns the appropriate canonical instance of + Health.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.html b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.html new file mode 100644 index 0000000..79e34f6 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/admin/GemFireHealth.html @@ -0,0 +1,602 @@ + + + + + +GemFireHealth (Apache Geode (incubating) 1.0.0-incubating) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.geode.admin
+

Interface GemFireHealth

+
+
+
+
    +
  • +
    +
    Deprecated.  +
    as of 7.0 use the management package instead
    +
    +
    +
    public interface GemFireHealth
    +
    Provides information about the aggregate health of the members of a + GemFire distributed system ("components"). The getHealth method provides an indication of the overall health. + Health is expressed as one of three levels: GOOD_HEALTH, OKAY_HEALTH, and POOR_HEALTH. The getDiagnosis + method provides a more detailed explanation of the cause of ill + health. + +

    + + The aggregate health of the GemFire component is evaluated + every + so often and if certain criteria are met, then the overall health + of the component changes accordingly. If any of the components is + in OKAY_HEALTH, then the overall health is + OKAY_HEALTH. If any of the components is in + POOR_HEALTH, then the overall health is + POOR_HEALTH.

    +
    +
    Since:
    +
    GemFire 3.5
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        GOOD_HEALTH

        +
        static final GemFireHealth.Health GOOD_HEALTH
        +
        Deprecated. 
        +
        An indicator that the GemFire components are healthy.
        +
        +
        See Also:
        +
        getHealth()
        +
        +
        • +
      + + + +
        +
      • +

        OKAY_HEALTH

        +
        static final GemFireHealth.Health OKAY_HEALTH
        +
        Deprecated. 
        +
        An indicator that one or more GemFire components is slightly + unhealthy. The problem may or may not require configuration + changes and may not necessarily lead to poorer component health.
        +
        +
        See Also:
        +
        getHealth()
        +
        +
        • +
      + + + +
        +
      • +

        POOR_HEALTH

        +
        static final GemFireHealth.Health POOR_HEALTH
        +
        Deprecated. 
        +
        An indicator that one or more GemFire components is unhealthy. + While it may be possible for the components to recover on their + own, it is likely that they will have to be restarted.
        +
        +
        See Also:
        +
        getHealth()
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        resetHealth

        +
        void resetHealth()
        +
        Deprecated. 
        +
        Resets the overall health of the GemFire components to GOOD_HEALTH. This operation should be invoked when the + operator has determined that warnings about the components's + health do not need to be regarded.
        +
        • +
      + + + +
        +
      • +

        getDiagnosis

        +
        java.lang.String getDiagnosis()
        +
        Deprecated. 
        +
        Returns a message that provides a description of the cause of a + component's ill health.
        +
        • +
      + + + +
        +
      • +

        getDistributedSystemHealthConfig

        +
        DistributedSystemHealthConfig getDistributedSystemHealthConfig()
        +
        Deprecated. 
        +
        Returns the configuration for determining the health of the + distributed system itself.
        +
        • +
      + + + +
        +
      • +

        setDistributedSystemHealthConfig

        +
        void setDistributedSystemHealthConfig(DistributedSystemHealthConfig config)
        +
        Deprecated. 
        +
        Sets the configuration for determining the health of the + distributed system itself.
        +
        • +
      + + + + + + + +
        +
      • +

        setDefaultGemFireHealthConfig

        +
        void setDefaultGemFireHealthConfig(GemFireHealthConfig config)
        +
        Deprecated. 
        +
        Sets the GemFireHealthConfig for + GemFire components whose configurations are not overridden on a + per-host basis.
        +
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If config specifies the config for a host
        +
        +
        • +
      + + + +
        +
      • +

        getGemFireHealthConfig

        +
        GemFireHealthConfig getGemFireHealthConfig(java.lang.String hostName)
        +
        Deprecated. 
        +
        Returns the GemFireHealthConfig for GemFire + components that reside on a given host. This configuration will + override the default + configuration.
        +
        +
        Parameters:
        +
        hostName - The canonical name of the host.
        +
        +
        • +
      + + + +
        +
      • +

        setGemFireHealthConfig

        +
        void setGemFireHealthConfig(java.lang.String hostName,
+                            GemFireHealthConfig config)
        +
        Deprecated. 
        +
        Sets the GemFireHealthConfig for GemFire + components that reside on a given host. This configuration will + override the default + configuration. Note that changes made to the returned + GemFireHealthConfig will not take effect until + setDefaultGemFireHealthConfig(org.apache.geode.admin.GemFireHealthConfig) is invoked.
        +
        +
        Parameters:
        +
        hostName - The canonical name of the host.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - If host hostName does not exist or if there + are no GemFire components running on that host or if + config does not configure host + hostName.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
        +
        Deprecated. 
        +
        Closes this health monitor and releases all resources associated + with it.
        +
        • +
      + + + +
        +
      • +

        isClosed

        +
        boolean isClosed()
        +
        Deprecated. 
        +
        Returns whether or not this GemFireHealth is + closed.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +