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
21 package org.apache.directory.server.ldap.replication.provider;
22
23
24 import org.apache.directory.api.ldap.model.exception.LdapException;
25 import org.apache.directory.api.ldap.model.message.SearchRequest;
26 import org.apache.directory.server.ldap.LdapServer;
27 import org.apache.directory.server.ldap.LdapSession;
28
29
30 /**
31 * Interface of a replication request handler in a provider/master.
32 *
33 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34 */
35 public interface ReplicationRequestHandler
36 {
37 /**
38 * initializes the replication provider
39 *
40 * @param server the LdapServer instance
41 */
42 void start( LdapServer server );
43
44
45 /**
46 * stops the replication provider
47 */
48 void stop();
49
50
51 /**
52 * A method to be used by any RFC 4533 compatible provider implementation
53 *
54 * @param session the LdapSession instance
55 * @param req the SearchRequest with the SyncRequest control
56 * @throws LdapException If the syncrepl request wasn't handled properly
57 */
58 void handleSyncRequest( LdapSession session, SearchRequest req ) throws LdapException;
59 }