event listener is now used by the xml router and the publish method of the gateway is
[xmlrouter] / listener / src / main / java / org / wamblee / xmlrouter / listener / EventListener.java
1 /*
2  * Copyright 2005-2011 the original author or authors.
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 org.wamblee.xmlrouter.listener;
17
18 import java.util.List;
19
20 import org.wamblee.xmlrouter.config.Transformation;
21
22 /**
23  * Event logger which is notified of the activities done by the xml router.
24  * 
25  * @author Erik Brakkee
26  * 
27  */
28 public interface EventListener {
29
30     /**
31      * Called when an event is delivered to a destination.
32      * 
33      * @param aInfo
34      *            Event information.
35      * @param aSequence
36      *            Sequence of transformations performed.
37      * @param aDestinationId
38      *            Id of the destination the event was delivered to.
39      * @param aDestinationName
40      *            Destination name.
41      * @param aSuccessFlag
42      *            Whether or not event delivery succeeded.
43      */
44     void delivered(EventInfo aInfo, List<Transformation> aSequence,
45         long aDestinationId, String aDestinationName, boolean aSuccessFlag);
46
47     /**
48      * Called when an event could not be delivered to any destination.
49      * 
50      * @param aInfo
51      *            Event info.
52      */
53     void notDelivered(EventInfo aInfo);
54 }