org.apache.kafka.common.security.oauthbearer.secured.AccessTokenRetriever Maven / Gradle / Ivy
The newest version!
/*
* 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.kafka.common.security.oauthbearer.secured;
import java.io.Closeable;
import java.io.IOException;
/**
* An AccessTokenRetriever is the internal API by which the login module will
* retrieve an access token for use in authorization by the broker. The implementation may
* involve authentication to a remote system, or it can be as simple as loading the contents
* of a file or configuration setting.
*
* Retrieval is a separate concern from validation, so it isn't necessary for
* the AccessTokenRetriever implementation to validate the integrity of the JWT
* access token.
*
* @see HttpAccessTokenRetriever
* @see FileTokenRetriever
*/
public interface AccessTokenRetriever extends Initable, Closeable {
/**
* Retrieves a JWT access token in its serialized three-part form. The implementation
* is free to determine how it should be retrieved but should not perform validation
* on the result.
*
* Note: This is a blocking function and callers should be aware that the
* implementation may be communicating over a network, with the file system, coordinating
* threads, etc. The facility in the {@link javax.security.auth.spi.LoginModule} from
* which this is ultimately called does not provide an asynchronous approach.
*
* @return Non-null JWT access token string
*
* @throws IOException Thrown on errors related to IO during retrieval
*/
String retrieve() throws IOException;
/**
* Lifecycle method to perform a clean shutdown of the retriever. This must
* be performed by the caller to ensure the correct state, freeing up and releasing any
* resources performed in {@link #init()}.
*
* @throws IOException Thrown on errors related to IO during closure
*/
default void close() throws IOException {
// This method left intentionally blank.
}
}