001/* 002 * Copyright 2022-2024 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2022-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) 2022-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.logs.v2.text; 037 038 039 040import com.unboundid.ldap.sdk.unboundidds.logs.AccessLogOperationType; 041import com.unboundid.ldap.sdk.unboundidds.logs.LogException; 042import com.unboundid.ldap.sdk.unboundidds.logs.v2. 043 ModifyDNRequestAccessLogMessage; 044import com.unboundid.util.NotExtensible; 045import com.unboundid.util.NotMutable; 046import com.unboundid.util.NotNull; 047import com.unboundid.util.Nullable; 048import com.unboundid.util.ThreadSafety; 049import com.unboundid.util.ThreadSafetyLevel; 050 051 052 053/** 054 * This class provides a data structure that holds information about a 055 * text-formatted modify DN request access log message. 056 * <BR> 057 * <BLOCKQUOTE> 058 * <B>NOTE:</B> This class, and other classes within the 059 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 060 * supported for use against Ping Identity, UnboundID, and 061 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 062 * for proprietary functionality or for external specifications that are not 063 * considered stable or mature enough to be guaranteed to work in an 064 * interoperable way with other types of LDAP servers. 065 * </BLOCKQUOTE> 066 */ 067@NotExtensible() 068@NotMutable() 069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 070public class TextFormattedModifyDNRequestAccessLogMessage 071 extends TextFormattedRequestAccessLogMessage 072 implements ModifyDNRequestAccessLogMessage 073{ 074 /** 075 * The serial version UID for this serializable class. 076 */ 077 private static final long serialVersionUID = -4814940474132841630L; 078 079 080 081 // Indicates whether to delete the old RDN values from the entry. 082 @Nullable private final Boolean deleteOldRDN; 083 084 // The current DN of the entry to rename. 085 @Nullable private final String dn; 086 087 // The new RDN to use for the entry. 088 @Nullable private final String newRDN; 089 090 // The new superior DN to use for the entry. 091 @Nullable private final String newSuperiorDN; 092 093 094 095 /** 096 * Creates a new text-formatted modify DN request access log message from the 097 * provided message string. 098 * 099 * @param logMessageString The string representation of this log message. 100 * It must not be {@code null}. 101 * 102 * @throws LogException If the provided string cannot be parsed as a valid 103 * log message. 104 */ 105 public TextFormattedModifyDNRequestAccessLogMessage( 106 @NotNull final String logMessageString) 107 throws LogException 108 { 109 this(new TextFormattedLogMessage(logMessageString)); 110 } 111 112 113 114 /** 115 * Creates a new text-formatted modify DN request access log message from the 116 * provided message. 117 * 118 * @param logMessage The log message to use to create this modify DN request 119 * access log message. It must not be {@code null}. 120 */ 121 TextFormattedModifyDNRequestAccessLogMessage( 122 @NotNull final TextFormattedLogMessage logMessage) 123 { 124 super(logMessage); 125 126 dn = getString(TextFormattedAccessLogFields.MODDN_ENTRY_DN); 127 newRDN = getString(TextFormattedAccessLogFields.MODDN_NEW_RDN); 128 deleteOldRDN = 129 getBooleanNoThrow(TextFormattedAccessLogFields.MODDN_DELETE_OLD_RDN); 130 newSuperiorDN = 131 getString(TextFormattedAccessLogFields.MODDN_NEW_SUPERIOR_DN); 132 } 133 134 135 136 /** 137 * {@inheritDoc} 138 */ 139 @Override() 140 @NotNull() 141 public final AccessLogOperationType getOperationType() 142 { 143 return AccessLogOperationType.MODDN; 144 } 145 146 147 148 /** 149 * {@inheritDoc} 150 */ 151 @Override() 152 @Nullable() 153 public final String getDN() 154 { 155 return dn; 156 } 157 158 159 160 /** 161 * {@inheritDoc} 162 */ 163 @Override() 164 @Nullable() 165 public final String getNewRDN() 166 { 167 return newRDN; 168 } 169 170 171 172 /** 173 * {@inheritDoc} 174 */ 175 @Override() 176 @Nullable() 177 public final Boolean getDeleteOldRDN() 178 { 179 return deleteOldRDN; 180 } 181 182 183 184 /** 185 * {@inheritDoc} 186 */ 187 @Override() 188 @Nullable() 189 public final String getNewSuperiorDN() 190 { 191 return newSuperiorDN; 192 } 193}