EventLinker


1   // Copyright 2004, 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // Unless required by applicable law or agreed to in writing, software
10  // distributed under the License is distributed on an "AS IS" BASIS,
11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  // See the License for the specific language governing permissions and
13  // limitations under the License.
14  
15  package org.apache.hivemind.service;
16  
17  import org.apache.hivemind.Location;
18  
19  /**
20   * Service used to link two other services together using event notifications. The service producer
21   * will have the consumer registered as a listener.
22   * 
23   * @author Howard Lewis Ship
24   */
25  public interface EventLinker
26  {
27      /**
28       * Adds the consumer as a listener of events published by the producer. Typically, the producer
29       * is a service, and the consumer is some other service's core implementation.
30       * 
31       * @param producer
32       *            the object which will be publishing the events.
33       * @param eventSetName
34       *            the name of an event set; the consumer will only be registered for that set of
35       *            events.
36       * @param consumer
37       *            the object which will be added as a listener.
38       * @param location
39       *            used when reporting errors, may be null
40       */
41      public void addEventListener(Object   producer, String   eventSetName, Object   consumer,
42              Location location);
43  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags