org.apache.kafka.clients.admin.ScramMechanism Maven / Gradle / Ivy
/*
* 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.Arrays;
/**
* Representation of a SASL/SCRAM Mechanism.
*
* @see KIP-554: Add Broker-side SCRAM Config API
*
* This code is duplicated in org.apache.kafka.common.security.scram.internals.ScramMechanism.
* The type field in both files must match and must not change. The type field
* is used both for passing ScramCredentialUpsertion and for the internal
* UserScramCredentialRecord. Do not change the type field.
*/
public enum ScramMechanism {
UNKNOWN((byte) 0),
SCRAM_SHA_256((byte) 1),
SCRAM_SHA_512((byte) 2);
private static final ScramMechanism[] VALUES = values();
/**
*
* @param type the type indicator
* @return the instance corresponding to the given type indicator, otherwise {@link #UNKNOWN}
*/
public static ScramMechanism fromType(byte type) {
for (ScramMechanism scramMechanism : VALUES) {
if (scramMechanism.type == type) {
return scramMechanism;
}
}
return UNKNOWN;
}
/**
*
* @param mechanismName the SASL SCRAM mechanism name
* @return the corresponding SASL SCRAM mechanism enum, otherwise {@link #UNKNOWN}
* @see
* Salted Challenge Response Authentication Mechanism (SCRAM) SASL and GSS-API Mechanisms, Section 4
*/
public static ScramMechanism fromMechanismName(String mechanismName) {
return Arrays.stream(VALUES)
.filter(mechanism -> mechanism.mechanismName.equals(mechanismName))
.findFirst()
.orElse(UNKNOWN);
}
/**
*
* @return the corresponding SASL SCRAM mechanism name
* @see
* Salted Challenge Response Authentication Mechanism (SCRAM) SASL and GSS-API Mechanisms, Section 4
*/
public String mechanismName() {
return this.mechanismName;
}
/**
*
* @return the type indicator for this SASL SCRAM mechanism
*/
public byte type() {
return this.type;
}
private final byte type;
private final String mechanismName;
private ScramMechanism(byte type) {
this.type = type;
this.mechanismName = toString().replace('_', '-');
}
}