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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.types.operation;
028    
029    
030    
031    import org.opends.server.types.ByteString;
032    import org.opends.server.types.DN;
033    import org.opends.server.types.Entry;
034    
035    
036    
037    /**
038     * This class defines a set of methods that are available for use by
039     * post-synchronization 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)
048    public interface PostSynchronizationDeleteOperation
049           extends PostSynchronizationOperation
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      public 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      public DN getEntryDN();
068    
069    
070    
071      /**
072       * Retrieves the entry to be deleted.
073       *
074       * @return  The entry to be deleted.
075       */
076      public Entry getEntryToDelete();
077    }
078