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