001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase;
019
020import org.apache.yetus.audience.InterfaceAudience;
021
022/** Information about active monitored server tasks */
023@InterfaceAudience.Public
024public interface ServerTask {
025
026  /** Task state */
027  enum State {
028    RUNNING,
029    WAITING,
030    COMPLETE,
031    ABORTED;
032  }
033
034  /**
035   * Get the task's description.
036   * @return the task's description, typically a name
037   */
038  String getDescription();
039
040  /**
041   * Get the current status of the task.
042   * @return the task's current status
043   */
044  String getStatus();
045
046  /**
047   * Get the current state of the task.
048   * @return the task's current state
049   */
050  State getState();
051
052  /**
053   * Get the task start time.
054   * @return the time when the task started, or 0 if it has not started yet
055   */
056  long getStartTime();
057
058  /**
059   * Get the task completion time.
060   * @return the time when the task completed, or 0 if it has not completed yet
061   */
062  long getCompletionTime();
063
064}