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