org.apache.kafka.common.security.auth.AuthenticationContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kafka-clients Show documentation

There is a newer version: 3.9.0

/*
 * 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.auth;

import java.net.InetAddress;


/**
 * An object representing contextual information from the authentication session. See
 * {@link PlaintextAuthenticationContext}, {@link SaslAuthenticationContext}
 * and {@link SslAuthenticationContext}. This class is only used in the broker.
 */
public interface AuthenticationContext {
    /**
     * Underlying security protocol of the authentication session.
     */
    SecurityProtocol securityProtocol();

    /**
     * Address of the authenticated client
     */
    InetAddress clientAddress();

    /**
     * Name of the listener used for the connection
     */
    String listenerName();
}