View Javadoc

1   /*
2      Copyright 2008 Ramon Servadei
3   
4      Licensed under the Apache License, Version 2.0 (the "License");
5      you may not use this file except in compliance with the License.
6      You may obtain a copy of the License at
7   
8          http://www.apache.org/licenses/LICENSE-2.0
9   
10     Unless required by applicable law or agreed to in writing, software
11     distributed under the License is distributed on an "AS IS" BASIS,
12     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13     See the License for the specific language governing permissions and
14     limitations under the License.
15   */
16  package fulmine.event.system;
17  
18  import fulmine.IAddressable;
19  import fulmine.event.IEventManager;
20  import fulmine.event.subscription.ISubscriptionManager;
21  
22  /**
23   * A system event raised when an {@link ISubscriptionManager} receives a new
24   * subscription. The event is raised only on the first issue of the
25   * subscription; subsequent calls for the same subscription will not raise this
26   * event.
27   * <p>
28   * Application code can register an {@link ISystemEventListener} to receive
29   * these events in order to start servicing the affected event source(s).
30   * 
31   * @see ISubscriptionManager#subscribe(fulmine.event.subscription.ISubscriptionParameters)
32   * @see UnsubscribeEvent
33   * @author Ramon Servadei
34   */
35  public final class SubscribeEvent extends AbstractSystemEvent
36  {
37      /**
38       * Standard constructor
39       * 
40       * @param context
41       *            the context the event is handled in
42       * @param id
43       *            the subscription parameters
44       */
45      public SubscribeEvent(IEventManager context, IAddressable id)
46      {
47          super(context, id);
48      }
49  }