opendaylight/config/shutdown-impl/src/main/java/org/opendaylight/controller/config/yang/shutdown/impl/ShutdownServiceImpl.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.yang.shutdown.impl;
   9
  10 import com.google.common.base.Optional;
  11 import org.opendaylight.controller.config.shutdown.ShutdownService;
  12 import org.osgi.framework.Bundle;
  13 import org.osgi.framework.BundleException;
  14 import org.slf4j.Logger;
  15 import org.slf4j.LoggerFactory;
  16
  17 import java.lang.management.ManagementFactory;
  18 import java.lang.management.ThreadInfo;
  19
  20 public class ShutdownServiceImpl implements ShutdownService, AutoCloseable {
  21     private final ShutdownService impl;
  22     private final ShutdownRuntimeRegistration registration;
  23
  24     public ShutdownServiceImpl(String secret, Bundle systemBundle,
  25                                ShutdownRuntimeRegistrator rootRuntimeBeanRegistratorWrapper) {
  26         if (secret == null) {
  27             throw new IllegalArgumentException("Secret cannot be null");
  28         }
  29         impl = new Impl(secret, systemBundle);
  30         registration = rootRuntimeBeanRegistratorWrapper.register(new MXBeanImpl(impl));
  31     }
  32
  33     @Override
  34     public void shutdown(String inputSecret, Long maxWaitTime, Optional<String> reason) {
  35         impl.shutdown(inputSecret, maxWaitTime, reason);
  36     }
  37
  38     @Override
  39     public void close() {
  40         registration.close();
  41     }
  42 }
  43
  44 class Impl implements ShutdownService {
  45     private static final Logger logger = LoggerFactory.getLogger(Impl.class);
  46     private final String secret;
  47     private final Bundle systemBundle;
  48
  49     Impl(String secret, Bundle systemBundle) {
  50         this.secret = secret;
  51         this.systemBundle = systemBundle;
  52     }
  53
  54     @Override
  55     public void shutdown(String inputSecret, Long maxWaitTime, Optional<String> reason) {
  56         logger.warn("Shutdown issued with secret {} and reason {}", inputSecret, reason);
  57         try {
  58             Thread.sleep(1000); // prevent brute force attack
  59         } catch (InterruptedException e) {
  60             Thread.currentThread().interrupt();
  61             logger.warn("Shutdown process interrupted", e);
  62         }
  63         if (this.secret.equals(inputSecret)) {
  64             logger.info("Server is shutting down");
  65
  66             // actual work:
  67             Thread stopSystemBundleThread = new StopSystemBundleThread(systemBundle);
  68             stopSystemBundleThread.start();
  69             if (maxWaitTime != null && maxWaitTime > 0) {
  70                 Thread systemExitThread = new CallSystemExitThread(maxWaitTime);
  71                 logger.debug("Scheduling {}", systemExitThread);
  72                 systemExitThread.start();
  73             }
  74             // end
  75         } else {
  76             logger.warn("Unauthorized attempt to shut down server");
  77             throw new IllegalArgumentException("Invalid secret");
  78         }
  79     }
  80
  81 }
  82
  83 class StopSystemBundleThread extends Thread {
  84     private static final Logger logger = LoggerFactory.getLogger(StopSystemBundleThread.class);
  85     private final Bundle systemBundle;
  86
  87     StopSystemBundleThread(Bundle systemBundle) {
  88         super("stop-system-bundle");
  89         this.systemBundle = systemBundle;
  90     }
  91
  92     @Override
  93     public void run() {
  94         try {
  95             // wait so that JMX response is received
  96             Thread.sleep(1000);
  97             logger.debug("Stopping system bundle");
  98             systemBundle.stop();
  99         } catch (BundleException e) {
 100             logger.warn("Can not stop OSGi server", e);
 101         } catch (InterruptedException e) {
 102             logger.warn("Shutdown process interrupted", e);
 103         }
 104     }
 105 }
 106
 107 class CallSystemExitThread extends Thread {
 108     private static final Logger logger = LoggerFactory.getLogger(CallSystemExitThread.class);
 109     private final long maxWaitTime;
 110     CallSystemExitThread(long maxWaitTime) {
 111         super("call-system-exit-daemon");
 112         setDaemon(true);
 113         if (maxWaitTime <= 0){
 114             throw new IllegalArgumentException("Cannot schedule to zero or negative time:" + maxWaitTime);
 115         }
 116         this.maxWaitTime = maxWaitTime;
 117     }
 118
 119     @Override
 120     public String toString() {
 121         return "CallSystemExitThread{" +
 122                 "maxWaitTime=" + maxWaitTime +
 123                 '}';
 124     }
 125
 126     @Override
 127     public void run() {
 128         try {
 129             // wait specified time
 130             Thread.sleep(maxWaitTime);
 131             logger.error("Since some threads are still running, server is going to shut down via System.exit(1) !");
 132             // do a thread dump
 133             ThreadInfo[] threads = ManagementFactory.getThreadMXBean().dumpAllThreads(true, true);
 134             StringBuffer sb = new StringBuffer();
 135             for(ThreadInfo info : threads) {
 136                 sb.append(info);
 137                 sb.append("\n");
 138             }
 139             logger.warn("Thread dump:{}", sb);
 140             System.exit(1);
 141         } catch (InterruptedException e) {
 142             logger.warn("Interrupted, not going to call System.exit(1)");
 143         }
 144     }
 145 }
 146
 147
 148 class MXBeanImpl implements ShutdownRuntimeMXBean {
 149     private final ShutdownService impl;
 150
 151     MXBeanImpl(ShutdownService impl) {
 152         this.impl = impl;
 153     }
 154
 155     @Override
 156     public void shutdown(String inputSecret, Long maxWaitTime, String nullableReason) {
 157         Optional<String> optionalReason;
 158         if (nullableReason == null) {
 159             optionalReason = Optional.absent();
 160         } else {
 161             optionalReason = Optional.of(nullableReason);
 162         }
 163         impl.shutdown(inputSecret, maxWaitTime, optionalReason);
 164     }
 165 }