001/*
002 * Copyright 2021-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2021-2023 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2021-2023 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk;
037
038
039
040import com.unboundid.util.NotNull;
041import com.unboundid.util.Nullable;
042import com.unboundid.util.StaticUtils;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This enum defines the types of channel binding that may be used in
050 * conjunction with the GSSAPI SASL mechanism.  Note that channel binding
051 * support is dependent upon the underlying JVM and may not be available in all
052 * cases.
053 *
054 * @see  GSSAPIBindRequest
055 * @see  GSSAPIBindRequestProperties
056 */
057@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
058public enum GSSAPIChannelBindingType
059{
060  /**
061   * The channel binding type that indicates that no channel binding should be
062   * used.
063   */
064  NONE("none"),
065
066
067
068  /**
069   * The channel binding type that indicates that TLS server end-point channel
070   * binding should be used.
071   */
072  TLS_SERVER_END_POINT("tls-server-end-point");
073
074
075
076  // The name for this channel binding type.
077  @NotNull private final String name;
078
079
080
081  /**
082   * Creates a new GSSAPI bind request channel binding type value with the
083   * provided name.
084   *
085   * @param  name  The name to use for this channel binding type.  It must not
086   *               be {@code null].
087   */
088  GSSAPIChannelBindingType(@NotNull final String name)
089  {
090    this.name = name;
091  }
092
093
094
095  /**
096   * Retrieves the name for this GSSAPI channel binding type.
097   *
098   * @return  The name for this GSSAPI channel binding type.
099   */
100  @NotNull()
101  public String getName()
102  {
103    return name;
104  }
105
106
107
108  /**
109   * Retrieves the GSSAPI channel binding type with the specified name.
110   *
111   * @param  name  The name of the GSSAPI channel binding type to retrieve.  It
112   *               must not be {@code null}.
113   *
114   * @return  The requested channel binding type, or {@code null} if no channel
115   *          binding type is defined with the provided name.
116   */
117  @Nullable()
118  public static GSSAPIChannelBindingType forName(
119              @NotNull final String name)
120  {
121    final String convertedName =
122         StaticUtils.toLowerCase(name).replace('_', '-');
123    for (final GSSAPIChannelBindingType t : values())
124    {
125      if (t.name.equals(convertedName))
126      {
127        return t;
128      }
129    }
130
131    return null;
132  }
133}