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 */
020package org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone;
021
022
023import org.apache.directory.api.ldap.model.message.Control;
024
025
026/**
027 * A syncDoneValue object as described in rfc4533 :
028 *
029 * <pre>
030 * 2.4.  Sync Done Control
031 *
032 *    The Sync Done Control is an LDAP Control [RFC4511] where the
033 *    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.3 and the
034 *    controlValue contains a BER-encoded syncDoneValue.  The criticality
035 *    is FALSE (and hence absent).
036 *
037 *       syncDoneValue ::= SEQUENCE {
038 *           cookie          syncCookie OPTIONAL,
039 *           refreshDeletes  BOOLEAN DEFAULT FALSE
040 *       }
041 *
042 *    The Sync Done Control is only applicable to the SearchResultDone
043 *    Message.
044 * </pre>
045 *
046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
047 */
048public interface SyncDoneValue extends Control
049{
050    /** This control OID */
051    String OID = "1.3.6.1.4.1.4203.1.9.1.3";
052
053
054    /**
055     * @return the cookie
056     */
057    byte[] getCookie();
058
059
060    /**
061     * @param cookie cookie to be set
062     */
063    void setCookie( byte[] cookie );
064
065
066    /**
067     * @return true, if refreshDeletes flag is set, false otherwise
068     */
069    boolean isRefreshDeletes();
070
071
072    /**
073     * @param refreshDeletes set the refreshDeletes flag
074     */
075    void setRefreshDeletes( boolean refreshDeletes );
076
077}