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.syncInfoValue;
021
022
023import org.apache.directory.api.ldap.extras.controls.SynchronizationModeEnum;
024import org.apache.directory.api.ldap.model.message.Control;
025
026
027/**
028 * A syncRequestValue object, as defined in RFC 4533
029 * 
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public interface SyncRequestValue extends Control
033{
034    /** This control OID */
035    static final String OID = "1.3.6.1.4.1.4203.1.9.1.1";
036
037
038    /**
039     * @return the mode
040     */
041    SynchronizationModeEnum getMode();
042
043
044    /**
045     * @param syncMode the syncMode to set
046     */
047    void setMode( SynchronizationModeEnum mode );
048
049
050    /**
051     * @return the cookie
052     */
053    byte[] getCookie();
054
055
056    /**
057     * @param cookie the cookie to set
058     */
059    void setCookie( byte[] cookie );
060
061
062    /**
063     * @return the reloadHint
064     */
065    boolean isReloadHint();
066
067
068    /**
069     * @param reloadHint the reloadHint to set
070     */
071    void setReloadHint( boolean reloadHint );
072
073}