com.unboundid.ldap.sdk.unboundidds.logs.AddAuditLogMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2018-2021 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2018-2021 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) 2018-2021 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 java.util.Collections;
import java.util.List;
import com.unboundid.ldap.sdk.ChangeType;
import com.unboundid.ldap.sdk.ReadOnlyEntry;
import com.unboundid.ldap.sdk.unboundidds.controls.SoftDeleteRequestControl;
import com.unboundid.ldif.LDIFAddChangeRecord;
import com.unboundid.ldif.LDIFChangeRecord;
import com.unboundid.ldif.LDIFDeleteChangeRecord;
import com.unboundid.ldif.LDIFException;
import com.unboundid.ldif.LDIFReader;
import com.unboundid.util.Debug;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.sdk.unboundidds.logs.LogMessages.*;
/**
* This class provides a data structure that holds information about an audit
* log message that represents an add operation.
*
*
* 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.
*
*/
@ThreadSafety(level= ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AddAuditLogMessage
extends AuditLogMessage
{
/**
* Retrieves the serial version UID for this serializable class.
*/
private static final long serialVersionUID = -4103749134439291911L;
// Indicates whether the add operation represents an undelete of a
// soft-deleted entry.
@Nullable private final Boolean isUndelete;
// An LDIF change record that encapsulates the change represented by this add
// audit log message.
@NotNull private final LDIFAddChangeRecord addChangeRecord;
// The entry included in the undelete request.
@Nullable private final ReadOnlyEntry undeleteRequestEntry;
/**
* Creates a new add audit log message from the provided set of lines.
*
* @param logMessageLines The lines that comprise the log message. It must
* not be {@code null} or empty, and it must not
* contain any blank lines, although it may contain
* comments. In fact, it must contain at least one
* comment line that appears before any non-comment
* lines (but possibly after other comment lines)
* that serves as the message header.
*
* @throws AuditLogException If a problem is encountered while processing
* the provided list of log message lines.
*/
public AddAuditLogMessage(@NotNull final String... logMessageLines)
throws AuditLogException
{
this(StaticUtils.toList(logMessageLines), logMessageLines);
}
/**
* Creates a new add audit log message from the provided set of lines.
*
* @param logMessageLines The lines that comprise the log message. It must
* not be {@code null} or empty, and it must not
* contain any blank lines, although it may contain
* comments. In fact, it must contain at least one
* comment line that appears before any non-comment
* lines (but possibly after other comment lines)
* that serves as the message header.
*
* @throws AuditLogException If a problem is encountered while processing
* the provided list of log message lines.
*/
public AddAuditLogMessage(@NotNull final List logMessageLines)
throws AuditLogException
{
this(logMessageLines, StaticUtils.toArray(logMessageLines, String.class));
}
/**
* Creates a new add audit log message from the provided information.
*
* @param logMessageLineList The lines that comprise the log message as a
* list.
* @param logMessageLineArray The lines that comprise the log message as an
* array.
*
* @throws AuditLogException If a problem is encountered while processing
* the provided list of log message lines.
*/
private AddAuditLogMessage(@NotNull final List logMessageLineList,
@NotNull final String[] logMessageLineArray)
throws AuditLogException
{
super(logMessageLineList);
try
{
final LDIFChangeRecord changeRecord =
LDIFReader.decodeChangeRecord(logMessageLineArray);
if (!(changeRecord instanceof LDIFAddChangeRecord))
{
throw new AuditLogException(logMessageLineList,
ERR_ADD_AUDIT_LOG_MESSAGE_CHANGE_TYPE_NOT_ADD.get(
changeRecord.getChangeType().getName(),
ChangeType.ADD.getName()));
}
addChangeRecord = (LDIFAddChangeRecord) changeRecord;
}
catch (final LDIFException e)
{
Debug.debugException(e);
throw new AuditLogException(logMessageLineList,
ERR_ADD_AUDIT_LOG_MESSAGE_LINES_NOT_CHANGE_RECORD.get(
StaticUtils.getExceptionMessage(e)),
e);
}
isUndelete = getNamedValueAsBoolean("isUndelete", getHeaderNamedValues());
undeleteRequestEntry = decodeCommentedEntry("Undelete request entry",
logMessageLineList, null);
}
/**
* Creates a new add audit log message from the provided set of lines.
*
* @param logMessageLines The lines that comprise the log message. It must
* not be {@code null} or empty, and it must not
* contain any blank lines, although it may contain
* comments. In fact, it must contain at least one
* comment line that appears before any non-comment
* lines (but possibly after other comment lines)
* that serves as the message header.
* @param addChangeRecord The LDIF add change record that is described by
* the provided log message lines.
*
* @throws AuditLogException If a problem is encountered while processing
* the provided list of log message lines.
*/
AddAuditLogMessage(@NotNull final List logMessageLines,
@NotNull final LDIFAddChangeRecord addChangeRecord)
throws AuditLogException
{
super(logMessageLines);
this.addChangeRecord = addChangeRecord;
isUndelete = getNamedValueAsBoolean("isUndelete", getHeaderNamedValues());
undeleteRequestEntry = decodeCommentedEntry("Undelete request entry",
logMessageLines, null);
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getDN()
{
return addChangeRecord.getDN();
}
/**
* Retrieves a read-only representation of the entry that was added.
*
* @return A read-only representation of the entry that was added.
*/
@NotNull()
public ReadOnlyEntry getEntry()
{
return new ReadOnlyEntry(addChangeRecord.getEntryToAdd());
}
/**
* Retrieves the value of the "isUndelete" flag from this log message, which
* indicates whether the add operation attempted to undelete a previously
* soft-deleted entry, if available.
*
* @return The value of the "isUndelete" flag from this log message, or
* {@code null} if it is not available.
*/
@Nullable()
public Boolean getIsUndelete()
{
return isUndelete;
}
/**
* Retrieves the entry that comprised the undelete request, available.
*
* @return The entry that comprised the undelete request, or {@code null} if
* it is not available.
*/
@Nullable()
public ReadOnlyEntry getUndeleteRequestEntry()
{
return undeleteRequestEntry;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ChangeType getChangeType()
{
return ChangeType.ADD;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public LDIFAddChangeRecord getChangeRecord()
{
return addChangeRecord;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean isRevertible()
{
// Add audit log messages are always reversible.
return true;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public List getRevertChangeRecords()
{
if ((isUndelete != null) && isUndelete)
{
return Collections.singletonList(
new LDIFDeleteChangeRecord(
SoftDeleteRequestControl.createSoftDeleteRequest(
addChangeRecord.getDN(), false, true)));
}
else
{
return Collections.singletonList(
new LDIFDeleteChangeRecord(addChangeRecord.getDN()));
}
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append(getUncommentedHeaderLine());
buffer.append("; changeType=add; dn=\"");
buffer.append(addChangeRecord.getDN());
buffer.append('\"');
}
}