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 * This class defines a set of methods that are available for use by
028 * post-response plugins for delete operations.  Note that this
029 * interface is intended only to define an API for use by plugins and
030 * is not intended to be implemented by any custom classes.
031 */
032@org.opends.server.types.PublicAPI(
033     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
034     mayInstantiate=false,
035     mayExtend=false,
036     mayInvoke=true)
037public interface PostResponseDeleteOperation
038       extends PostResponseOperation
039{
040  /**
041   * Retrieves the raw, unprocessed entry DN as included in the client
042   * request.
043   *
044   * @return  The raw, unprocessed entry DN as included in the client
045   *          request.
046   */
047  ByteString getRawEntryDN();
048
049
050
051  /**
052   * Retrieves the DN of the entry to delete.
053   *
054   * @return  The DN of the entry to delete.
055   */
056  DN getEntryDN();
057
058
059
060  /**
061   * Retrieves the entry to be deleted.
062   *
063   * @return  The entry to be deleted.
064   */
065  Entry getEntryToDelete();
066}
067