com.unboundid.ldap.sdk.unboundidds.logs.v2.ModifyDNRequestAccessLogMessage Maven / Gradle / Ivy
/*
* Copyright 2022-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2022-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) 2022-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.v2;
import com.unboundid.util.NotExtensible;
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 modify DN
* request access log message.
*
*
* 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()
@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
public interface ModifyDNRequestAccessLogMessage
extends OperationRequestAccessLogMessage
{
/**
* Retrieves the DN of the entry to rename.
*
* @return The DN of the entry to rename, or {@code null} if it is not
* included in the log message.
*/
@Nullable()
String getDN();
/**
* Retrieves the new RDN to use for the entry.
*
* @return The new RDN to use for the entry, or {@code null} if it is not
* included in the log message.
*/
@Nullable()
String getNewRDN();
/**
* Indicates whether the old RDN value(s) should be removed from the entry.
*
* @return {@code Boolean.TRUE} if the old RDN value(s) should be removed
* from the entry, {@code Boolean.FALSE} if the old RDN value(s)
* should be kept in the entry, or {@code null} if it is not included
* in the log message.
*/
@Nullable()
Boolean getDeleteOldRDN();
/**
* Retrieves the new superior DN to use for the entry.
*
* @return The new superior DN to use for the entry, or {@code null} if it is
* not included in the log message.
*/
@Nullable()
String getNewSuperiorDN();
}