001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.message.control.replication;
021    
022    
023    /**
024     * This interface is the base for the Sync Info Control, as described by RFC 4533.
025     * The structure for this control is :
026     * 
027     * syncInfoValue ::= CHOICE {
028     *     newcookie      [0] syncCookie,
029     *     refreshDelete  [1] SEQUENCE {
030     *         cookie         syncCookie OPTIONAL,
031     *         refreshDone    BOOLEAN DEFAULT TRUE
032     *     },
033     *     refreshPresent [2] SEQUENCE {
034     *         cookie         syncCookie OPTIONAL,
035     *         refreshDone    BOOLEAN DEFAULT TRUE
036     *     },
037     *     syncIdSet      [3] SEQUENCE {
038     *         cookie         syncCookie OPTIONAL,
039     *         refreshDeletes BOOLEAN DEFAULT FALSE,
040     *         syncUUIDs      SET OF syncUUID
041     *     }
042     * }
043     *
044     * This control OID is 1.3.6.1.4.1.4203.1.9.1.4
045     * 
046     * @see <a href="http://www.faqs.org/rfcs/rfc4533.html">RFC 4533</a>
047     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048     * @version $Rev: $
049     */
050    public interface SyncInfoValueControl
051    {
052        /** This control OID */
053        static final String CONTROL_OID = "1.3.6.1.4.1.4203.1.9.1.4";
054    
055        
056        /**
057         * @return the cookie
058         */
059        byte[] getCookie();
060    
061        
062        /**
063         * @param cookie the cookie to set
064         */
065        void setCookie( byte[] cookie );
066    }