hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java/org/apache/hadoop/yarn/api/protocolrecords/GetDelegationTokenRequest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.hadoop.yarn.api.protocolrecords;

import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.yarn.util.Records;

/**
 * The request issued by the client to get a delegation token from
 * the {@code ResourceManager}.
 * for more information.
 */
@Public
@Stable
public abstract class GetDelegationTokenRequest {

  @Public
  @Stable
  public static GetDelegationTokenRequest newInstance(String renewer) {
    GetDelegationTokenRequest request =
        Records.newRecord(GetDelegationTokenRequest.class);
    request.setRenewer(renewer);
    return request;
  }

  @Public
  @Stable
  public abstract String getRenewer();

  @Public
  @Stable
  public abstract void setRenewer(String renewer);
}