introduction of EventInfo.
[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 javax.print.attribute.standard.Destination;
21
22 import org.wamblee.xmlrouter.common.Id;
23 import org.wamblee.xmlrouter.config.Transformation;
24
25 /**
26  * Event logger which is notified of the activities done by the xml router.
27  * 
28  * @author Erik Brakkee
29  * 
30  */
31 public interface EventListener {
32
33     /**
34      * Called when an event is delivered to a destination.
35      * 
36      * @param aInfo
37      *            Event information.
38      * @param aSequence
39      *            Sequence of transformations performed.
40      * @param aDestination
41      *            Id of the destination the event was delivered to.
42      * @param aDestinationName
43      *            Destination name.
44      * @param aSuccessFlag
45      *            Whether or not event delivery succeeded.
46      */
47     void delivered(EventInfo aInfo, List<Transformation> aSequence,
48         Id<Destination> aDestination, String aDestinationName,
49         boolean aSuccessFlag);
50
51     /**
52      * Called when an event could not be delivered to any destination.
53      * 
54      * @param aInfo
55      *            Event info.
56      */
57     void notDelivered(EventInfo aInfo);
58 }