// Copyright (c) Microsoft Corporation
// All rights reserved. 
//
// MIT License
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING 
// BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

package com.microsoft.frameworklauncher.common.model;

import java.io.Serializable;

public enum FrameworkState implements Serializable {
  // Framework Waiting to Create Application
  //    [START_STATES]
  //    createApplication         -> APPLICATION_CREATED
  //    stopFramework             -> FRAMEWORK_COMPLETED
  FRAMEWORK_WAITING,

  // Framework's current associated Application Created
  //    launchApplication         -> APPLICATION_LAUNCHED
  //    launchApplication         -> APPLICATION_RETRIEVING_DIAGNOSTICS
  //    recover                   -> APPLICATION_LAUNCHED
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_CREATED,

  // Framework's current associated Application Launched
  //    resyncWithRM              -> APPLICATION_WAITING
  //    resyncWithRM              -> APPLICATION_RETRIEVING_DIAGNOSTICS
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_LAUNCHED,

  // Framework's current associated Application Waiting to Allocated AM Container
  //    resyncWithRM              -> APPLICATION_RUNNING
  //    resyncWithRM              -> APPLICATION_RETRIEVING_DIAGNOSTICS
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_WAITING,

  // Framework's current associated Application Running
  //    resyncWithRM              -> APPLICATION_RETRIEVING_DIAGNOSTICS
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_RUNNING,

  // Framework's current associated Application Retrieving ExitDiagnostics
  //    diagnosticsRetrieved    -> APPLICATION_COMPLETED
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_RETRIEVING_DIAGNOSTICS,

  // Framework's current associated Application Completed
  //    attemptToRetry            -> FRAMEWORK_WAITING
  //    attemptToRetry            -> FRAMEWORK_COMPLETED
  //    stopFramework             -> FRAMEWORK_COMPLETED
  APPLICATION_COMPLETED,

  // Framework Completed, possibly with Application retries
  //    [FINAL_STATES]
  FRAMEWORK_COMPLETED
}
