com.unboundid.ldap.sdk.unboundidds.logs.CompareRequestAccessLogMessage Maven / Gradle / Ivy
/*
* Copyright 2009-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2009-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2009-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.logs;
import com.unboundid.util.NotExtensible;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
/**
* This class provides a data structure that holds information about a log
* message that may appear in the Directory Server access log about a compare
* request received from a client.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*/
@NotExtensible()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public class CompareRequestAccessLogMessage
extends OperationRequestAccessLogMessage
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 5478010218343234128L;
// The name of the attribute for which the compare is to be performed.
@Nullable private final String attributeName;
// The DN of the entry for which the compare is to be performed.
@Nullable private final String dn;
/**
* Creates a new compare request access log message from the provided message
* string.
*
* @param s The string to be parsed as a compare request access log message.
*
* @throws LogException If the provided string cannot be parsed as a valid
* log message.
*/
public CompareRequestAccessLogMessage(@NotNull final String s)
throws LogException
{
this(new LogMessage(s));
}
/**
* Creates a new compare request access log message from the provided log
* message.
*
* @param m The log message to be parsed as a compare request access log
* message.
*/
public CompareRequestAccessLogMessage(@NotNull final LogMessage m)
{
super(m);
dn = getNamedValue("dn");
attributeName = getNamedValue("attr");
}
/**
* Retrieves the DN of the entry for which the compare is to be performed.
*
* @return The DN of the entry for which the compare is to be performed, or
* {@code null} if it is not included in the log message.
*/
@Nullable()
public final String getDN()
{
return dn;
}
/**
* Retrieves the name of the attribute for which the compare is to be
* performed.
*
* @return The name of the attribute for which the compare is to be
* performed, or {@code null} if it is not included in the log
* message.
*/
@Nullable()
public final String getAttributeName()
{
return attributeName;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public final AccessLogOperationType getOperationType()
{
return AccessLogOperationType.COMPARE;
}
}