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