001/*
002 * Copyright 2022-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2023 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-2023 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            CompareRequestAccessLogMessage;
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 compare 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 TextFormattedCompareRequestAccessLogMessage
071       extends TextFormattedRequestAccessLogMessage
072       implements CompareRequestAccessLogMessage
073{
074  /**
075   * The serial version UID for this serializable class.
076   */
077  private static final long serialVersionUID = 5363475182128853195L;
078
079
080
081  // The DN of the entry for which to perform the compare.
082  @Nullable private final String dn;
083
084  // The name of the attribute for which to perform the compare.
085  @Nullable private final String attributeName;
086
087
088
089  /**
090   * Creates a new text-formatted compare request access log message from the
091   * provided message string.
092   *
093   * @param  logMessageString  The string representation of this log message.
094   *                           It must not be {@code null}.
095   *
096   * @throws  LogException  If the provided string cannot be parsed as a valid
097   *                        log message.
098   */
099  public TextFormattedCompareRequestAccessLogMessage(
100              @NotNull final String logMessageString)
101         throws LogException
102  {
103    this(new TextFormattedLogMessage(logMessageString));
104  }
105
106
107
108  /**
109   * Creates a new text-formatted compare request access log message from the
110   * provided message.
111   *
112   * @param  logMessage  The log message to use to create this compare request
113   *                     access log message.  It must not be {@code null}.
114   *
115   * @throws  LogException  If the provided string cannot be parsed as a valid
116   *                        log message.
117   */
118  TextFormattedCompareRequestAccessLogMessage(
119       @NotNull final TextFormattedLogMessage logMessage)
120  {
121    super(logMessage);
122
123    dn = getString(TextFormattedAccessLogFields.COMPARE_ENTRY_DN);
124    attributeName =
125         getString(TextFormattedAccessLogFields.COMPARE_ATTRIBUTE_NAME);
126  }
127
128
129
130  /**
131   * {@inheritDoc}
132   */
133  @Override()
134  @NotNull()
135  public final AccessLogOperationType getOperationType()
136  {
137    return AccessLogOperationType.COMPARE;
138  }
139
140
141
142  /**
143   * {@inheritDoc}
144   */
145  @Override()
146  @Nullable()
147  public final String getDN()
148  {
149    return dn;
150  }
151
152
153
154  /**
155   * {@inheritDoc}
156   */
157  @Override()
158  @Nullable()
159  public final String getAttributeName()
160  {
161    return attributeName;
162  }
163}