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.server.core.api.event;
21  
22  
23  import java.util.List;
24  
25  
26  /**
27   * Interface used by the DirectoryService to manage subscriptions for DIT 
28   * change notifications.
29   *
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public interface EventService
33  {
34      /**
35       * Registers a DirectoryListener for notification on change events on the 
36       * DIT matching some notification criteria.
37       *
38       * @param listener the DirectoryListener to deliver notifications to
39       * @param criteria the parameterized criteria for delivering change events
40       * @throws Exception If the addition failed
41       */
42      void addListener( DirectoryListener listener, NotificationCriteria criteria ) throws Exception;
43  
44  
45      /**
46       * Removes the listener from this EventService preventing all events 
47       * registered from being delivered to it.
48       *
49       * @param listener the DirectoryListener to stop delivering notifications to
50       */
51      void removeListener( DirectoryListener listener );
52  
53  
54      /**
55       * Lists the listeners registered with this EventService.
56       * 
57       * @return The list of registration entries
58       */
59      List<RegistrationEntry> getRegistrationEntries();
60  }