001/*
002 * Copyright 2019-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2019-2020 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) 2019-2020 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.unboundidds.extensions;
037
038
039
040import com.unboundid.util.ThreadSafety;
041import com.unboundid.util.ThreadSafetyLevel;
042
043
044
045/**
046 * This enum describes the mechanism that the server should use when selecting
047 * the password policy to use (for its password generator and validators) while
048 * processing a {@link GeneratePasswordExtendedRequest}.
049 * <BR>
050 * <BLOCKQUOTE>
051 *   <B>NOTE:</B>  This class, and other classes within the
052 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
053 *   supported for use against Ping Identity, UnboundID, and
054 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
055 *   for proprietary functionality or for external specifications that are not
056 *   considered stable or mature enough to be guaranteed to work in an
057 *   interoperable way with other types of LDAP servers.
058 * </BLOCKQUOTE>
059 */
060@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
061public enum GeneratePasswordPolicySelectionType
062{
063  /**
064   * The selection type that indicates that the server should use the default
065   * password policy as defined in the configuration.
066   */
067  DEFAULT_POLICY((byte) 0x80),
068
069
070
071  /**
072   * The selection type that indicates that the server should use the password
073   * policy that is defined in a specified entry.
074   */
075  PASSWORD_POLICY_DN((byte) 0x81),
076
077
078
079  /**
080   * The selection type that indicates that the server should use the password
081   * policy that governs a specified entry.
082   */
083  TARGET_ENTRY_DN((byte) 0x82);
084
085
086
087  // The BER type associated with this password policy selection type.
088  private final byte berType;
089
090
091
092  /**
093   * Creates a new password policy selection type with the provided BER type.
094   *
095   * @param  type  The BER type associated with this password policy selection
096   *               type.
097   */
098  GeneratePasswordPolicySelectionType(final byte type)
099  {
100    this.berType = type;
101  }
102
103
104
105  /**
106   * Retrieves the BER type that will be used to identify this password policy
107   * selection type in a {@link GeneratePasswordExtendedRequest}.
108   *
109   * @return  The BER type that will be used to identify this password policy
110   *          selection type in a generate password extended request.
111   */
112  public byte getBERType()
113  {
114    return berType;
115  }
116
117
118
119  /**
120   * Retrieves the password policy selection type with the specified BER type.
121   *
122   * @param  berType  The BER type for the password policy selection type to
123   *                  retrieve.
124   *
125   * @return  The password policy selection type with the specified BER type,
126   *          or {@code null} if there is no selection type with the provided
127   *          BER type.
128   */
129  public static GeneratePasswordPolicySelectionType forType(final byte berType)
130  {
131    for (final GeneratePasswordPolicySelectionType t : values())
132    {
133      if (t.berType == berType)
134      {
135        return t;
136      }
137    }
138
139    return null;
140  }
141}