001/* 002 * Copyright 2020-2022 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2020-2022 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) 2020-2022 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.controls; 037 038 039 040import com.unboundid.ldap.sdk.Control; 041import com.unboundid.ldap.sdk.LDAPException; 042import com.unboundid.ldap.sdk.ResultCode; 043import com.unboundid.util.NotMutable; 044import com.unboundid.util.NotNull; 045import com.unboundid.util.ThreadSafety; 046import com.unboundid.util.ThreadSafetyLevel; 047 048import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*; 049 050 051 052/** 053 * This class provides an implementation of a request control that can be 054 * included in a bind request to indicate that the server should include a 055 * control int eh bind response with information about recent login attempts 056 * for the user. 057 * <BR> 058 * <BLOCKQUOTE> 059 * <B>NOTE:</B> This class, and other classes within the 060 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 061 * supported for use against Ping Identity, UnboundID, and 062 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 063 * for proprietary functionality or for external specifications that are not 064 * considered stable or mature enough to be guaranteed to work in an 065 * interoperable way with other types of LDAP servers. 066 * </BLOCKQUOTE> 067 * <BR> 068 * This control has an OID of 1.3.6.1.4.1.30221.2.5.61 and no value. The 069 * criticality may be either {@code true} or {@code false}. 070 * 071 * @see GetRecentLoginHistoryRequestControl 072 */ 073@NotMutable() 074@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 075public final class GetRecentLoginHistoryRequestControl 076 extends Control 077{ 078 /** 079 * The OID (1.3.6.1.4.1.30221.2.5.61) for the get password policy state issues 080 * request control. 081 */ 082 @NotNull public static final String GET_RECENT_LOGIN_HISTORY_REQUEST_OID = 083 "1.3.6.1.4.1.30221.2.5.61"; 084 085 086 087 /** 088 * The serial version UID for this serializable class. 089 */ 090 private static final long serialVersionUID = -3060529240532292690L; 091 092 093 094 /** 095 * Creates a new instance of this control. It will not be considered 096 * critical. 097 */ 098 public GetRecentLoginHistoryRequestControl() 099 { 100 this(false); 101 } 102 103 104 105 /** 106 * Creates a new instance of this control with the specified criticality. 107 * 108 * @param isCritical Indicates whether the control should be considered 109 * critical. 110 */ 111 public GetRecentLoginHistoryRequestControl(final boolean isCritical) 112 { 113 super(GET_RECENT_LOGIN_HISTORY_REQUEST_OID, isCritical); 114 } 115 116 117 118 /** 119 * Creates a new instance of this control that is decoded from the provided 120 * generic control. 121 * 122 * @param control The control to decode as a get recent login history 123 * request control. 124 * 125 * @throws LDAPException If a problem is encountered while attempting to 126 * decode the provided control as a get recent login 127 * history request control. 128 */ 129 public GetRecentLoginHistoryRequestControl(@NotNull final Control control) 130 throws LDAPException 131 { 132 super(control); 133 134 if (control.hasValue()) 135 { 136 throw new LDAPException(ResultCode.DECODING_ERROR, 137 ERR_GET_RECENT_LOGIN_HISTORY_REQUEST_HAS_VALUE.get()); 138 } 139 } 140 141 142 143 /** 144 * {@inheritDoc} 145 */ 146 @Override() 147 @NotNull() 148 public String getControlName() 149 { 150 return INFO_CONTROL_NAME_GET_RECENT_LOGIN_HISTORY_REQUEST.get(); 151 } 152 153 154 155 /** 156 * {@inheritDoc} 157 */ 158 @Override() 159 public void toString(@NotNull final StringBuilder buffer) 160 { 161 buffer.append("GetRecentLoginHistoryRequestControl(isCritical="); 162 buffer.append(isCritical()); 163 buffer.append(')'); 164 } 165}