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
021package org.apache.directory.server.ldap.replication.provider;
022
023
024import org.apache.directory.api.ldap.model.exception.LdapException;
025import org.apache.directory.api.ldap.model.message.SearchRequest;
026import org.apache.directory.server.ldap.LdapServer;
027import org.apache.directory.server.ldap.LdapSession;
028
029
030/**
031 * Interface of a replication request handler in a provider/master.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public interface ReplicationRequestHandler
036{
037    /**
038     * initializes the replication provider
039     *
040     * @param server the LdapServer instance
041     */
042    void start( LdapServer server );
043
044
045    /**
046     * stops the replication provider
047     */
048    void stop();
049
050
051    /**
052     * A method to be used by any RFC 4533 compatible provider implementation 
053     *
054     * @param session the LdapSession instance
055     * @param req the SearchRequest with the SyncRequest control
056     * @throws LdapException If the syncrepl request wasn't handled properly
057     */
058    void handleSyncRequest( LdapSession session, SearchRequest req ) throws LdapException;
059}