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