com.couchbase.client.core.env.SaslMechanism Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation

The official Couchbase JVM Core IO Library

There is a newer version: 2.7.0

/*
 * Copyright (c) 2018 Couchbase, Inc.
 *
 * 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 com.couchbase.client.core.env;

/**
 * Describes the support SASL authentication mechanisms.
 */
public enum SaslMechanism {

  PLAIN("PLAIN", 1),
  SCRAM_SHA1("SCRAM-SHA1", 2),
  SCRAM_SHA256("SCRAM-SHA256", 2),
  SCRAM_SHA512("SCRAM-SHA512", 2);

  private final String mech;
  private final int roundtrips;

  SaslMechanism(String mech, int roundtrips) {
    this.mech = mech;
    this.roundtrips = roundtrips;
  }

  /**
   * Returns the "raw" string representation of the mechanism on the wire.
   */
  public String mech() {
    return mech;
  }

  /**
   * Returns the number of roundtrips this algorithm has with the server.
   */
  public int roundtrips() {
    return roundtrips;
  }

  /**
   * Helper method to create the enum from its string representation.
   *
   * @param mech the mechanism to convert.
   * @return null if not found, otherwise the enum representation.
   */
  public static SaslMechanism from(final String mech) {
    if (mech.equalsIgnoreCase("PLAIN")) {
      return PLAIN;
    } else if (mech.equalsIgnoreCase("SCRAM-SHA1")) {
      return SCRAM_SHA1;
    } else if (mech.equalsIgnoreCase("SCRAM-SHA256")) {
      return SCRAM_SHA256;
    } else if (mech.equalsIgnoreCase("SCRAM-SHA512")) {
      return SCRAM_SHA512;
    }

    return null;
  }
}