spark-gpu-master/network/common/src/main/java/org/apache/spark/network/sasl/SecretKeyHolder.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.spark.network.sasl;

/**
 * Interface for getting a secret key associated with some application.
 */
public interface SecretKeyHolder {
  /**
   * Gets an appropriate SASL User for the given appId.
   * @throws IllegalArgumentException if the given appId is not associated with a SASL user.
   */
  String getSaslUser(String appId);

  /**
   * Gets an appropriate SASL secret key for the given appId.
   * @throws IllegalArgumentException if the given appId is not associated with a SASL secret key.
   */
  String getSecretKey(String appId);
}
