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 compare 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 CompareRequestAccessLogMessage 066 extends OperationRequestAccessLogMessage 067{ 068 /** 069 * The serial version UID for this serializable class. 070 */ 071 private static final long serialVersionUID = 5478010218343234128L; 072 073 074 075 // The name of the attribute for which the compare is to be performed. 076 private final String attributeName; 077 078 // The DN of the entry for which the compare is to be performed. 079 private final String dn; 080 081 082 083 /** 084 * Creates a new compare request access log message from the provided message 085 * string. 086 * 087 * @param s The string to be parsed as a compare request access log message. 088 * 089 * @throws LogException If the provided string cannot be parsed as a valid 090 * log message. 091 */ 092 public CompareRequestAccessLogMessage(final String s) 093 throws LogException 094 { 095 this(new LogMessage(s)); 096 } 097 098 099 100 /** 101 * Creates a new compare request access log message from the provided log 102 * message. 103 * 104 * @param m The log message to be parsed as a compare request access log 105 * message. 106 */ 107 public CompareRequestAccessLogMessage(final LogMessage m) 108 { 109 super(m); 110 111 dn = getNamedValue("dn"); 112 attributeName = getNamedValue("attr"); 113 } 114 115 116 117 /** 118 * Retrieves the DN of the entry for which the compare is to be performed. 119 * 120 * @return The DN of the entry for which the compare is to be performed, or 121 * {@code null} if it is not included in the log message. 122 */ 123 public final String getDN() 124 { 125 return dn; 126 } 127 128 129 130 /** 131 * Retrieves the name of the attribute for which the compare is to be 132 * performed. 133 * 134 * @return The name of the attribute for which the compare is to be 135 * performed, or {@code null} if it is not included in the log 136 * message. 137 */ 138 public final String getAttributeName() 139 { 140 return attributeName; 141 } 142 143 144 145 /** 146 * {@inheritDoc} 147 */ 148 @Override() 149 public final AccessLogOperationType getOperationType() 150 { 151 return AccessLogOperationType.COMPARE; 152 } 153}