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 */
018
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Private;
022import org.apache.hadoop.classification.InterfaceAudience.Public;
023import org.apache.hadoop.classification.InterfaceStability.Stable;
024import org.apache.hadoop.classification.InterfaceStability.Unstable;
025import org.apache.hadoop.yarn.api.ApplicationClientProtocol;
026import org.apache.hadoop.yarn.util.Records;
027
028/**
029 * <p>
030 * The response sent by the <code>ResourceManager</code> to the client aborting
031 * a submitted application.
032 * </p>
033 * <p>
034 * The response, includes:
035 * <ul>
036 * <li>A flag which indicates that the process of killing the application is
037 * completed or not.</li>
038 * </ul>
039 * Note: user is recommended to wait until this flag becomes true, otherwise if
040 * the <code>ResourceManager</code> crashes before the process of killing the
041 * application is completed, the <code>ResourceManager</code> may retry this
042 * application on recovery.
043 * </p>
044 * 
045 * @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)
046 */
047@Public
048@Stable
049public abstract class KillApplicationResponse {
050  @Private
051  @Unstable
052  public static KillApplicationResponse newInstance(boolean isKillCompleted) {
053    KillApplicationResponse response =
054        Records.newRecord(KillApplicationResponse.class);
055    response.setIsKillCompleted(isKillCompleted);
056    return response;
057  }
058
059  /**
060   * Get the flag which indicates that the process of killing application is completed or not.
061   */
062  @Public
063  @Stable
064  public abstract boolean getIsKillCompleted();
065
066  /**
067   * Set the flag which indicates that the process of killing application is completed or not.
068   */
069  @Private
070  @Unstable
071  public abstract void setIsKillCompleted(boolean isKillCompleted);
072}