network/sasl/SecretKeyHolder.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.network.sasl;
0019
0020 /**
0021  * Interface for getting a secret key associated with some application.
0022  */
0023 public interface SecretKeyHolder {
0024   /**
0025    * Gets an appropriate SASL User for the given appId.
0026    * @throws IllegalArgumentException if the given appId is not associated with a SASL user.
0027    */
0028   String getSaslUser(String appId);
0029
0030   /**
0031    * Gets an appropriate SASL secret key for the given appId.
0032    * @throws IllegalArgumentException if the given appId is not associated with a SASL secret key.
0033    */
0034   String getSecretKey(String appId);
0035 }