Line data    Source code

       1             : // Copyright (C) 2012 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.extensions.systemstatus;
      16             : 
      17             : /** Exports current server information to an extension. */
      18             : public interface ServerInformation {
      19             :   /** Current state of the server. */
      20         149 :   enum State {
      21             :     /**
      22             :      * The server is starting up, and network connections are not yet being accepted. Plugins or
      23             :      * extensions starting during this time are starting for the first time in this process.
      24             :      */
      25         149 :     STARTUP,
      26             : 
      27             :     /**
      28             :      * The server is running and handling requests. Plugins starting during this state may be
      29             :      * reloading, or being installed into a running system.
      30             :      */
      31         149 :     RUNNING,
      32             : 
      33             :     /**
      34             :      * The server is attempting a graceful halt of operations and will exit (or be killed by the
      35             :      * operating system) soon.
      36             :      */
      37         149 :     SHUTDOWN
      38             :   }
      39             : 
      40             :   State getState();
      41             : }