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