001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2006-2008 Sun Microsystems, Inc. 025 * Portions Copyright 2014-2015 ForgeRock AS 026 */ 027package org.opends.server.types.operation; 028 029 030 031import org.forgerock.opendj.ldap.ByteString; 032import org.opends.server.types.DN; 033import org.opends.server.types.Entry; 034 035 036 037/** 038 * This class defines a set of methods that are available for use by 039 * pre-operation plugins for delete operations. Note that this 040 * interface is intended only to define an API for use by plugins and 041 * is not intended to be implemented by any custom classes. 042 */ 043@org.opends.server.types.PublicAPI( 044 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 045 mayInstantiate=false, 046 mayExtend=false, 047 mayInvoke=true) 048public interface PreOperationDeleteOperation 049 extends PreOperationOperation 050{ 051 /** 052 * Retrieves the raw, unprocessed entry DN as included in the client 053 * request. 054 * 055 * @return The raw, unprocessed entry DN as included in the client 056 * request. 057 */ 058 ByteString getRawEntryDN(); 059 060 061 062 /** 063 * Retrieves the DN of the entry to delete. 064 * 065 * @return The DN of the entry to delete. 066 */ 067 DN getEntryDN(); 068 069 070 071 /** 072 * Retrieves the entry to be deleted. 073 * 074 * @return The entry to be deleted. 075 */ 076 Entry getEntryToDelete(); 077} 078