wamblee.org Git - xmlrouter/blob - logging/src/main/java/org/wamblee/xmlrouter/logging/EventLogger.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.logging;
  17
  18 import java.util.List;
  19
  20 import javax.print.attribute.standard.Destination;
  21 import javax.xml.transform.dom.DOMSource;
  22
  23 import org.wamblee.xmlrouter.common.Id;
  24 import org.wamblee.xmlrouter.config.Transformation;
  25
  26 /**
  27  * Event logger which is notified of the activities done by the xml router.
  28  *
  29  * @author Erik Brakkee
  30  *
  31  */
  32 public interface EventLogger {
  33
  34     /**
  35      * Called when an event is delivered to a destination.
  36      *
  37      * @param aDocumentType
  38      *            Document type.
  39      * @param aEventId
  40      *            Unique id for the original event.
  41      * @param aEvent
  42      *            The event.
  43      * @param aSequence
  44      *            Sequence of transformations performed.
  45      * @param aDestination
  46      *            Id of the destination the event was delivered to.
  47      * @param aDestinationName
  48      *            Destination name.
  49      * @param aSuccessFlag
  50      *            Whether or not event delivery succeeded.
  51      */
  52     void delivered(String aDocumentType, Id<DOMSource> aEventId,
  53         DOMSource aEvent, List<Transformation> aSequence,
  54         Id<Destination> aDestination, String aDestinationName,
  55         boolean aSuccessFlag);
  56
  57     /**
  58      * Called when an event could not be delivered to any destination.
  59      *
  60      * @param aEventId
  61      *            Unique id for the original event.
  62      * @param aEvent
  63      *            Event.
  64      */
  65     void notDelivered(String aDocumentType, Id<DOMSource> aEventId,
  66         DOMSource aEvent);
  67 }