View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone;
21  
22  
23  import org.apache.directory.api.ldap.model.message.Control;
24  
25  
26  /**
27   * A syncDoneValue object as described in rfc4533 :
28   *
29   * <pre>
30   * 2.4.  Sync Done Control
31   *
32   *    The Sync Done Control is an LDAP Control [RFC4511] where the
33   *    controlType is the object identifier 1.3.6.1.4.1.4203.1.9.1.3 and the
34   *    controlValue contains a BER-encoded syncDoneValue.  The criticality
35   *    is FALSE (and hence absent).
36   *
37   *       syncDoneValue ::= SEQUENCE {
38   *           cookie          syncCookie OPTIONAL,
39   *           refreshDeletes  BOOLEAN DEFAULT FALSE
40   *       }
41   *
42   *    The Sync Done Control is only applicable to the SearchResultDone
43   *    Message.
44   * </pre>
45   *
46   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
47   */
48  public interface SyncDoneValue extends Control
49  {
50      /** This control OID */
51      String OID = "1.3.6.1.4.1.4203.1.9.1.3";
52  
53  
54      /**
55       * @return the cookie
56       */
57      byte[] getCookie();
58  
59  
60      /**
61       * @param cookie cookie to be set
62       */
63      void setCookie( byte[] cookie );
64  
65  
66      /**
67       * @return true, if refreshDeletes flag is set, false otherwise
68       */
69      boolean isRefreshDeletes();
70  
71  
72      /**
73       * @param refreshDeletes set the refreshDeletes flag
74       */
75      void setRefreshDeletes( boolean refreshDeletes );
76  
77  }