org.apache.kafka.clients.admin.UserScramCredentialsDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kafka-client Show documentation
There is a newer version: 1.2.2.1-jre17
/*
 * 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.clients.admin;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * Representation of all SASL/SCRAM credentials associated with a user that can be retrieved, or an exception indicating
 * why credentials could not be retrieved.
 *
 * @see KIP-554: Add Broker-side SCRAM Config API
 */
public class UserScramCredentialsDescription {
    private final String name;
    private final List credentialInfos;

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        UserScramCredentialsDescription that = (UserScramCredentialsDescription) o;
        return name.equals(that.name) &&
                credentialInfos.equals(that.credentialInfos);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, credentialInfos);
    }

    @Override
    public String toString() {
        return "UserScramCredentialsDescription{" +
                "name='" + name + '\'' +
                ", credentialInfos=" + credentialInfos +
                '}';
    }

    /**
     *
     * @param name the required user name
     * @param credentialInfos the required SASL/SCRAM credential representations for the user
     */
    public UserScramCredentialsDescription(String name, List credentialInfos) {
        this.name = Objects.requireNonNull(name);
        this.credentialInfos = Collections.unmodifiableList(new ArrayList<>(credentialInfos));
    }

    /**
     *
     * @return the user name
     */
    public String name() {
        return name;
    }

    /**
     *
     * @return the always non-null/unmodifiable list of SASL/SCRAM credential representations for the user
     */
    public List credentialInfos() {
        return credentialInfos;
    }
}