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 73F6E200B4B for ; Thu, 16 Jun 2016 01:18:50 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 72826160A4D; Wed, 15 Jun 2016 23:18:50 +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 2CFBF160A64 for ; Thu, 16 Jun 2016 01:18:48 +0200 (CEST) Received: (qmail 17407 invoked by uid 500); 15 Jun 2016 23:18:40 -0000 Mailing-List: contact commits-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list commits@hbase.apache.org Received: (qmail 14025 invoked by uid 99); 15 Jun 2016 23:18:38 -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; Wed, 15 Jun 2016 23:18:37 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 93436E094C; Wed, 15 Jun 2016 23:18:37 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: apurtell@apache.org To: commits@hbase.apache.org Date: Wed, 15 Jun 2016 23:19:19 -0000 Message-Id: <52c5bbacf494427a93c0042826450a42@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [44/51] [abbrv] [partial] hbase git commit: Published site at 158568e7806e461275406bc15856ba26e4660f4c archived-at: Wed, 15 Jun 2016 23:18:50 -0000 http://git-wip-us.apache.org/repos/asf/hbase/blob/702fbc6f/apidocs/org/apache/hadoop/hbase/ChoreService.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/ChoreService.html b/apidocs/org/apache/hadoop/hbase/ChoreService.html new file mode 100644 index 0000000..feb1c5e --- /dev/null +++ b/apidocs/org/apache/hadoop/hbase/ChoreService.html @@ -0,0 +1,367 @@ + + + + + +ChoreService (Apache HBase 2.0.0-SNAPSHOT API) + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.hadoop.hbase
+

Class ChoreService

+
+
+ +
+
    +
  • +
    +
    +
    @InterfaceAudience.Public
+@InterfaceStability.Stable
+public class ChoreService
+extends Object
    +
    ChoreService is a service that can be used to schedule instances of ScheduledChore to run + periodically while sharing threads. The ChoreService is backed by a + ScheduledThreadPoolExecutor whose core pool size changes dynamically depending on the + number of ScheduledChore scheduled. All of the threads in the core thread pool of the + underlying ScheduledThreadPoolExecutor are set to be daemon threads. +

    + The ChoreService provides the ability to schedule, cancel, and trigger instances of + ScheduledChore. The ChoreService also provides the ability to check on the status of + scheduled chores. The number of threads used by the ChoreService changes based on the scheduling + load and whether or not the scheduled chores are executing on time. As more chores are scheduled, + there may be a need to increase the number of threads if it is noticed that chores are no longer + meeting their scheduled start times. On the other hand, as chores are cancelled, an attempt is + made to reduce the number of running threads to see if chores can still meet their start times + with a smaller thread pool. +

    + When finished with a ChoreService it is good practice to call shutdown(). + Calling this method ensures that all scheduled chores are cancelled and cleaned up properly.

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

      Constructor Detail

      + + + +
        +
      • +

        ChoreService

        +
        @InterfaceAudience.Private
+public ChoreService(String coreThreadPoolPrefix)
        +
        Parameters:
        coreThreadPoolPrefix - Prefix that will be applied to the Thread name of all threads + spawned by this service
        +
        • +
      + + + +
        +
      • +

        ChoreService

        +
        public ChoreService(String coreThreadPoolPrefix,
+            boolean jitter)
        +
        Parameters:
        coreThreadPoolPrefix - Prefix that will be applied to the Thread name of all threads + spawned by this service
        jitter - Should chore service add some jitter for all of the scheduled chores. When set + to true this will add -10% to 10% jitter.
        +
        • +
      + + + +
        +
      • +

        ChoreService

        +
        public ChoreService(String coreThreadPoolPrefix,
+            int corePoolSize,
+            boolean jitter)
        +
        Parameters:
        coreThreadPoolPrefix - Prefix that will be applied to the Thread name of all threads + spawned by this service
        corePoolSize - The initial size to set the core pool of the ScheduledThreadPoolExecutor + to during initialization. The default size is 1, but specifying a larger size may be + beneficial if you know that 1 thread will not be enough.
        jitter - Should chore service add some jitter for all of the scheduled chores. When set + to true this will add -10% to 10% jitter.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        scheduleChore

        +
        public boolean scheduleChore(ScheduledChore chore)
        +
        Parameters:
        chore - Chore to be scheduled. If the chore is already scheduled with another ChoreService + instance, that schedule will be cancelled (i.e. a Chore can only ever be scheduled + with a single ChoreService instance).
        +
        Returns:
        true when the chore was successfully scheduled. false when the scheduling failed + (typically occurs when a chore is scheduled during shutdown of service)
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        public void shutdown()
        +
        shutdown the service. Any chores that are scheduled for execution will be cancelled. Any chores + in the middle of execution will be interrupted and shutdown. This service will be unusable + after this method has been called (i.e. future scheduling attempts will fail).
        +
        • +
      + + + +
        +
      • +

        isShutdown

        +
        public boolean isShutdown()
        +
        Returns:
        true when the service is shutdown and thus cannot be used anymore
        +
        • +
      + + + +
        +
      • +

        isTerminated

        +
        public boolean isTerminated()
        +
        Returns:
        true when the service is shutdown and all threads have terminated
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.

+ + http://git-wip-us.apache.org/repos/asf/hbase/blob/702fbc6f/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html b/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html index ff9f3c1..ea85522 100644 --- a/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html +++ b/apidocs/org/apache/hadoop/hbase/ClockOutOfSyncException.html @@ -35,7 +35,7 @@
@@ -403,7 +391,7 @@ public int 

  • getRequestsCount

    -
    public int getRequestsCount()
    +
    public int getRequestsCount()
    Returns:
    the number of requests since last report
    • @@ -413,7 +401,7 @@ public int 

  • getHBaseVersion

    -
    public String getHBaseVersion()
    +
    public String getHBaseVersion()
    Returns:
    the HBase version string as reported by the HMaster
    • @@ -423,7 +411,7 @@ public int 

  • equals

    -
    public boolean equals(Object o)
    +
    public boolean equals(Object o)
    Overrides:
    equals in class Object
    @@ -436,7 +424,7 @@ public int 

  • hashCode

    -
    public int hashCode()
    +
    public int hashCode()
    Overrides:
    hashCode in class Object
    @@ -449,7 +437,7 @@ public int 

  • getVersion

    -
    public byte getVersion()
    +
    public byte getVersion()
    Specified by:
    getVersion in class org.apache.hadoop.io.VersionedWritable
    @@ -462,7 +450,7 @@ public int 

  • getServers

    -
    public Collection<ServerName> getServers()
    +
    public Collection<ServerName> getServers()
    • @@ -471,7 +459,7 @@ public int 

  • getMaster

    -
    public ServerName getMaster()
    +
    public ServerName getMaster()
    Returns detailed information about the current master ServerName.
    Returns:
    current master information if it exists
    • @@ -482,7 +470,7 @@ public int 

  • getBackupMastersSize

    -
    public int getBackupMastersSize()
    +
    public int getBackupMastersSize()
    Returns:
    the number of backup masters in the cluster
    • @@ -492,7 +480,7 @@ public int 

  • getBackupMasters

    -
    public Collection<ServerName> getBackupMasters()
    +
    public Collection<ServerName> getBackupMasters()
    Returns:
    the names of backup masters
    • @@ -502,7 +490,7 @@ public int 

  • getLoad

    -
    public ServerLoad getLoad(ServerName sn)
    +
    public ServerLoad getLoad(ServerName sn)
    Parameters:
    sn -
    Returns:
    Server's load or null if not found.
    • @@ -513,7 +501,7 @@ public int 

  • getClusterId

    -
    public String getClusterId()
    +
    public String getClusterId()
    • @@ -522,7 +510,7 @@ public int 

  • getMasterCoprocessors

    -
    public String[] getMasterCoprocessors()
    +
    public String[] getMasterCoprocessors()
    • @@ -531,7 +519,7 @@ public int 

  • getLastMajorCompactionTsForTable

    -
    public long getLastMajorCompactionTsForTable(TableName table)
    +
    public long getLastMajorCompactionTsForTable(TableName table)
    • @@ -540,7 +528,7 @@ public int 

  • getLastMajorCompactionTsForRegion

    -
    public long getLastMajorCompactionTsForRegion(byte[] region)
    +
    public long getLastMajorCompactionTsForRegion(byte[] region)
    • @@ -549,7 +537,7 @@ public int 

  • isBalancerOn

    -
    public boolean isBalancerOn()
    +
    public boolean isBalancerOn()
    • @@ -558,45 +546,22 @@ public int 

  • getBalancerOn

    -
    public Boolean getBalancerOn()
    +
    public Boolean getBalancerOn()
    • -
      + - - - -
        -
      • -

        convert

        -
        public org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ClusterStatus convert()
        -
        Convert a ClusterStatus to a protobuf ClusterStatus
        -
        Returns:
        the protobuf ClusterStatus
        -
        • -
      - - - -
        -
      • -

        convert

        -
        public static ClusterStatus convert(org.apache.hadoop.hbase.protobuf.generated.ClusterStatusProtos.ClusterStatus proto)
        -
        Convert a protobuf ClusterStatus to a ClusterStatus
        -
        Parameters:
        proto - the protobuf ClusterStatus
        -
        Returns:
        the converted ClusterStatus
        -
        • -
    • @@ -664,6 +629,6 @@ public int Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.

    +

    Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.

    http://git-wip-us.apache.org/repos/asf/hbase/blob/702fbc6f/apidocs/org/apache/hadoop/hbase/DoNotRetryIOException.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/DoNotRetryIOException.html b/apidocs/org/apache/hadoop/hbase/DoNotRetryIOException.html index 0df38d0..e1c7b89 100644 --- a/apidocs/org/apache/hadoop/hbase/DoNotRetryIOException.html +++ b/apidocs/org/apache/hadoop/hbase/DoNotRetryIOException.html @@ -306,6 +306,6 @@ extends
    • -

    Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.

    +

    Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.

    http://git-wip-us.apache.org/repos/asf/hbase/blob/702fbc6f/apidocs/org/apache/hadoop/hbase/DroppedSnapshotException.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/DroppedSnapshotException.html b/apidocs/org/apache/hadoop/hbase/DroppedSnapshotException.html index 4520700..6c55f32 100644 --- a/apidocs/org/apache/hadoop/hbase/DroppedSnapshotException.html +++ b/apidocs/org/apache/hadoop/hbase/DroppedSnapshotException.html @@ -270,6 +270,6 @@ extends Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.

    +

    Copyright © 2007–2016 The Apache Software Foundation. All rights reserved.

    http://git-wip-us.apache.org/repos/asf/hbase/blob/702fbc6f/apidocs/org/apache/hadoop/hbase/HBaseConfiguration.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/HBaseConfiguration.html b/apidocs/org/apache/hadoop/hbase/HBaseConfiguration.html index 39c476c..a90e97e 100644 --- a/apidocs/org/apache/hadoop/hbase/HBaseConfiguration.html +++ b/apidocs/org/apache/hadoop/hbase/HBaseConfiguration.html @@ -106,7 +106,7 @@ 
    @InterfaceAudience.Public
 @InterfaceStability.Stable
-public class HBaseConfiguration
+public class HBaseConfiguration
 extends org.apache.hadoop.conf.Configuration
    Adds HBase configuration files to a Configuration
    @@ -170,6 +170,23 @@ extends org.apache.hadoop.conf.Configuration create(org.apache.hadoop.conf.Configuration that)  +static org.apache.hadoop.conf.Configuration +createClusterConf(org.apache.hadoop.conf.Configuration baseConf, + String clusterKey) +
    Generates a Configuration instance by applying the ZooKeeper cluster key + to the base Configuration.
    + + + +static org.apache.hadoop.conf.Configuration +createClusterConf(org.apache.hadoop.conf.Configuration baseConf, + String clusterKey, + String overridePrefix) +
    Generates a Configuration instance by applying property overrides prefixed by + a cluster profile key to the base Configuration.
    + + + static int getInt(org.apache.hadoop.conf.Configuration conf, String name, @@ -206,6 +223,15 @@ extends org.apache.hadoop.conf.Configuration +static void +setWithPrefix(org.apache.hadoop.conf.Configuration conf, + String prefix, + Iterable<Map.Entry<String,String>> properties) +
    Sets all the entries in the provided Map<String, String> as properties in the + given Configuration.
    + + + static org.apache.hadoop.conf.Configuration subset(org.apache.hadoop.conf.Configuration srcConf, String prefix) @@ -248,7 +274,7 @@ extends org.apache.hadoop.conf.Configuration

  • HBaseConfiguration

    @Deprecated
-public HBaseConfiguration()
    +public HBaseConfiguration()
    Deprecated. Please use create() instead.
    Instantiating HBaseConfiguration() is deprecated. Please use HBaseConfiguration#create() to construct a plain Configuration
    @@ -261,7 +287,7 @@ public 

    HBaseConfiguration

    @Deprecated
-public HBaseConfiguration(org.apache.hadoop.conf.Configuration c)
    +public HBaseConfiguration(org.apache.hadoop.conf.Configuration c)
    Deprecated. Please user create(conf) instead.
    Instantiating HBaseConfiguration() is deprecated. Please use HBaseConfiguration#create(conf) to construct a plain Configuration
    @@ -281,7 +307,7 @@ public 

  • addHbaseResources

    -
    public static org.apache.hadoop.conf.Configuration addHbaseResources(org.apache.hadoop.conf.Configuration conf)
    +
    public static org.apache.hadoop.conf.Configuration addHbaseResources(org.apache.hadoop.conf.Configuration conf)
    • @@ -290,7 +316,7 @@ public 

  • create

    -
    public static org.apache.hadoop.conf.Configuration create()
    +
    public static org.apache.hadoop.conf.Configuration create()
    Creates a Configuration with HBase resources
    Returns:
    a Configuration with HBase resources
    • @@ -301,7 +327,7 @@ public 

  • create

    -
    public static org.apache.hadoop.conf.Configuration create(org.apache.hadoop.conf.Configuration that)
    +
    public static org.apache.hadoop.conf.Configuration create(org.apache.hadoop.conf.Configuration that)
    Parameters:
    that - Configuration to clone.
    Returns:
    a Configuration created with the hbase-*.xml files plus the given configuration.
    @@ -313,7 +339,7 @@ public 

  • merge

    -
    public static void merge(org.apache.hadoop.conf.Configuration destConf,
+
    public static void merge(org.apache.hadoop.conf.Configuration destConf,
          org.apache.hadoop.conf.Configuration srcConf)
    
 
    Merge two configurations.
    
 
    Parameters:
    destConf - the configuration that will be overwritten with items
@@ -326,7 +352,7 @@ public 
 
  • 
 
    subset
    
-
    public static org.apache.hadoop.conf.Configuration subset(org.apache.hadoop.conf.Configuration srcConf,
+
    public static org.apache.hadoop.conf.Configuration subset(org.apache.hadoop.conf.Configuration srcConf,
                                           String prefix)
    
 
    Returns a subset of the configuration properties, matching the given key prefix.
  The prefix is stripped from the return keys, ie. when calling with a prefix of "myprefix",
@@ -335,13 +361,27 @@ public 
+
+
+
      
+
    • 
+
      setWithPrefix
      
+
      public static void setWithPrefix(org.apache.hadoop.conf.Configuration conf,
+                 String prefix,
+                 Iterable<Map.Entry<String,String>> properties)
      
+
      Sets all the entries in the provided Map<String, String> as properties in the
+ given Configuration.  Each property will have the specified prefix prepended,
+ so that the configuration entries are keyed by prefix + entry.getKey().
      
+
      • 
+
    
 
 
 
 
@@ -351,7 +391,7 @@ public 
 
  • 
 
    getInt
    
-
    public static int getInt(org.apache.hadoop.conf.Configuration conf,
+
    public static int getInt(org.apache.hadoop.conf.Configuration conf,
          String name,
          String deprecatedName,
          int defaultValue)
    
@@ -374,7 +414,7 @@ public 
 
  • 
 
    getPassword
    
-
    public static String getPassword(org.apache.hadoop.conf.Configuration conf,
+
    public static String getPassword(org.apache.hadoop.conf.Configuration conf,
                  String alias,
                  String defPass)
                           throws IOException
    
@@ -387,13 +427,53 @@ public IOException
    •
    • + + + +
      +
    • +

      createClusterConf

      +
      public static org.apache.hadoop.conf.Configuration createClusterConf(org.apache.hadoop.conf.Configuration baseConf,
+                                                     String clusterKey)
+                                                              throws IOException
      +
      Generates a Configuration instance by applying the ZooKeeper cluster key + to the base Configuration. Note that additional configuration properties may be needed + for a remote cluster, so it is preferable to use + createClusterConf(Configuration, String, String).
      +
      Parameters:
      baseConf - the base configuration to use, containing prefixed override properties
      clusterKey - the ZooKeeper quorum cluster key to apply, or null if none
      +
      Returns:
      the merged configuration with override properties and cluster key applied
      +
      Throws:
      +
      IOException
      See Also:
      createClusterConf(Configuration, String, String)
      +
      • +
    + + + +
      +
    • +

      createClusterConf

      +
      public static org.apache.hadoop.conf.Configuration createClusterConf(org.apache.hadoop.conf.Configuration baseConf,
+                                                     String clusterKey,
+                                                     String overridePrefix)
+                                                              throws IOException
      +
      Generates a Configuration instance by applying property overrides prefixed by + a cluster profile key to the base Configuration. Override properties are extracted by + the subset(Configuration, String) method, then the merged on top of the base + Configuration and returned.
      +
      Parameters:
      baseConf - the base configuration to use, containing prefixed override properties
      clusterKey - the ZooKeeper quorum cluster key to apply, or null if none
      overridePrefix - the property key prefix to match for override properties, + or null if none
      +
      Returns:
      the merged configuration with override properties and cluster key applied
      +
      Throws:
      +
      IOException
      +
      • +