content: /*
   * Copyright (C) 2013 4th Line GmbH, Switzerland
   *
   * The contents of this file are subject to the terms of either the GNU
   * Lesser General Public License Version 2 or later ("LGPL") or the
   * Common Development and Distribution License Version 1 or later
   * ("CDDL") (collectively, the "License"). You may not use this file
   * except in compliance with the License. See LICENSE.txt for more
   * information.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   */
  
  package org.fourthline.cling.protocol;
  
  import org.fourthline.cling.UpnpService;
  import org.fourthline.cling.transport.RouterException;
  import org.seamless.util.Exceptions;
  
  import java.util.logging.Level;
  import java.util.logging.Logger;
  
  /**
   * Supertype for all synchronously executing protocols, sending UPnP messages.
   * <p>
   * After instantiation by the {@link ProtocolFactory}, this protocol <code>run()</code>s and
   * calls its {@link #execute()} method.
   * </p>
   * <p>
   * A {@link RouterException} during execution will be wrapped in a fatal <code>RuntimeException</code>,
   * unless its cause is an <code>InterruptedException</code>, in which case an INFO message will be logged.
   * </p>
   *
   * @author Christian Bauer
   */
  public abstract class SendingAsync implements Runnable {
  
      final private static Logger log = Logger.getLogger(UpnpService.class.getName());
  
      private final UpnpService upnpService;
  
      protected SendingAsync(UpnpService upnpService) {
          this.upnpService = upnpService;
      }
  
      public UpnpService getUpnpService() {
          return upnpService;
      }
  
      public void run() {
          try {
              execute();
          } catch (Exception ex) {
              Throwable cause = Exceptions.unwrap(ex);
              if (cause instanceof InterruptedException) {
                  log.log(Level.INFO, "Interrupted protocol '" + getClass().getSimpleName() + "': " + ex, cause);
              } else {
                  throw new RuntimeException(
                      "Fatal error while executing protocol '" + getClass().getSimpleName() + "': " + ex, ex
                  );
              }
          }
      }
  
      protected abstract void execute() throws RouterException;
  
      @Override
      public String toString() {
          return "(" + getClass().getSimpleName() + ")";
      }
  
  }