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.DeleteRequestAccessLogMessage; 043import com.unboundid.util.NotExtensible; 044import com.unboundid.util.NotMutable; 045import com.unboundid.util.NotNull; 046import com.unboundid.util.Nullable; 047import com.unboundid.util.ThreadSafety; 048import com.unboundid.util.ThreadSafetyLevel; 049 050 051 052/** 053 * This class provides a data structure that holds information about a 054 * text-formatted delete request access log message. 055 * <BR> 056 * <BLOCKQUOTE> 057 * <B>NOTE:</B> This class, and other classes within the 058 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 059 * supported for use against Ping Identity, UnboundID, and 060 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 061 * for proprietary functionality or for external specifications that are not 062 * considered stable or mature enough to be guaranteed to work in an 063 * interoperable way with other types of LDAP servers. 064 * </BLOCKQUOTE> 065 */ 066@NotExtensible() 067@NotMutable() 068@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 069public class TextFormattedDeleteRequestAccessLogMessage 070 extends TextFormattedRequestAccessLogMessage 071 implements DeleteRequestAccessLogMessage 072{ 073 /** 074 * The serial version UID for this serializable class. 075 */ 076 private static final long serialVersionUID = 722709056799803981L; 077 078 079 080 // The DN of the entry to delete 081 @Nullable private final String dn; 082 083 084 085 /** 086 * Creates a new text-formatted delete request access log message from the 087 * provided message string. 088 * 089 * @param logMessageString The string representation of this log message. 090 * It must not be {@code null}. 091 * 092 * @throws LogException If the provided string cannot be parsed as a valid 093 * log message. 094 */ 095 public TextFormattedDeleteRequestAccessLogMessage( 096 @NotNull final String logMessageString) 097 throws LogException 098 { 099 this(new TextFormattedLogMessage(logMessageString)); 100 } 101 102 103 104 /** 105 * Creates a new text-formatted delete request access log message from the 106 * provided message. 107 * 108 * @param logMessage The log message to use to create this delete request 109 * access log message. It must not be {@code null}. 110 */ 111 TextFormattedDeleteRequestAccessLogMessage( 112 @NotNull final TextFormattedLogMessage logMessage) 113 { 114 super(logMessage); 115 116 dn = getString(TextFormattedAccessLogFields.DELETE_ENTRY_DN); 117 } 118 119 120 121 /** 122 * {@inheritDoc} 123 */ 124 @Override() 125 @NotNull() 126 public final AccessLogOperationType getOperationType() 127 { 128 return AccessLogOperationType.DELETE; 129 } 130 131 132 133 /** 134 * {@inheritDoc} 135 */ 136 @Override() 137 @Nullable() 138 public final String getDN() 139 { 140 return dn; 141 } 142}