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.syncInfoValue;
21
22
23 import org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum;
24 import org.apache.directory.api.ldap.model.message.Control;
25
26
27 /**
28 * A syncRequestValue object, as defined in RFC 4533
29 *
30 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31 */
32 public interface SyncRequestValue extends Control
33 {
34 /** This control OID */
35 String OID = "1.3.6.1.4.1.4203.1.9.1.1";
36
37
38 /**
39 * @return the mode
40 */
41 SynchronizationModeEnum getMode();
42
43
44 /**
45 * @param mode the syncMode to set
46 */
47 void setMode( SynchronizationModeEnum mode );
48
49
50 /**
51 * @return the cookie
52 */
53 byte[] getCookie();
54
55
56 /**
57 * @param cookie the cookie to set
58 */
59 void setCookie( byte[] cookie );
60
61
62 /**
63 * @return the reloadHint
64 */
65 boolean isReloadHint();
66
67
68 /**
69 * @param reloadHint the reloadHint to set
70 */
71 void setReloadHint( boolean reloadHint );
72
73 }