renamed logger to listener

[xmlrouter] / listener / src / main / java / org / wamblee / xmlrouter / listener / EventListener.java

diff --git a/listener/src/main/java/org/wamblee/xmlrouter/listener/EventListener.java b/listener/src/main/java/org/wamblee/xmlrouter/listener/EventListener.java
new file mode 100644 (file)
index 0000000..a7a5b5a
--- /dev/null
+++ b/listener/src/main/java/org/wamblee/xmlrouter/listener/EventListener.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2005-2011 the original author or authors.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.wamblee.xmlrouter.listener;
+
+import java.util.List;
+
+import javax.print.attribute.standard.Destination;
+import javax.xml.transform.dom.DOMSource;
+
+import org.wamblee.xmlrouter.common.Id;
+import org.wamblee.xmlrouter.config.Transformation;
+
+/**
+ * Event logger which is notified of the activities done by the xml router.
+ * 
+ * @author Erik Brakkee
+ * 
+ */
+public interface EventListener {
+
+    /**
+     * Called when an event is delivered to a destination.
+     * 
+     * @param aDocumentType
+     *            Document type.
+     * @param aEventId
+     *            Unique id for the original event.
+     * @param aEvent
+     *            The event.
+     * @param aSequence
+     *            Sequence of transformations performed.
+     * @param aDestination
+     *            Id of the destination the event was delivered to.
+     * @param aDestinationName
+     *            Destination name.
+     * @param aSuccessFlag
+     *            Whether or not event delivery succeeded.
+     */
+    void delivered(String aDocumentType, Id<DOMSource> aEventId,
+        DOMSource aEvent, List<Transformation> aSequence,
+        Id<Destination> aDestination, String aDestinationName,
+        boolean aSuccessFlag);
+
+    /**
+     * Called when an event could not be delivered to any destination.
+     * 
+     * @param aEventId
+     *            Unique id for the original event.
+     * @param aEvent
+     *            Event.
+     */
+    void notDelivered(String aDocumentType, Id<DOMSource> aEventId,
+        DOMSource aEvent);
+}