io.streamnative.pulsar.handlers.kop.security.Authenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulsar-protocol-handler-kafka Show documentation

Kafka on Pulsar implemented using Pulsar Protocol Handler

There is a newer version: 4.0.0.4

Show newest version

/**
 * Copyright (c) 2019 - 2024 StreamNative, Inc.. All Rights Reserved.
 */
/**
 * Licensed 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 io.streamnative.pulsar.handlers.kop.security;

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.util.concurrent.Future;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import org.apache.kafka.common.errors.AuthenticationException;
import org.apache.kafka.common.protocol.ApiKeys;

public interface Authenticator {

    /**
     * Authenticate the request.
     *
     * @param ctx channel handler context
     * @param requestBuf request buffer
     * @param registerRequestParseLatency register request parse latency
     * @param registerRequestLatency register request latency
     * @param tenantAccessValidationFunction tenant access validation function
     * @throws AuthenticationException authentication exception
     */
    void authenticate(ChannelHandlerContext ctx,
                      ByteBuf requestBuf,
                      BiConsumer registerRequestParseLatency,
                      BiConsumer registerRequestLatency,
                      Function tenantAccessValidationFunction)
        throws AuthenticationException;

    /**
     * Send any authentication failure response that may have been previously built.
     */
    void sendAuthenticationFailureResponse(Consumer> listener);

    /**
     * Returns the session information if authentication is complete otherwise returns null.
     *
     * @return session information.
     */
    Session session();

    /**
     * returns true if authentication is complete otherwise returns false.
     */
    boolean complete();

    /**
     * Close any resources opened by the authenticator.
     */
    void close();
}