svn commit: r1619652 - in /logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util: DefaultShutdownRegistrationStrategy.java ShutdownRegistrationStrategy.java

[ma...@apache.org]

Author: mattsicker
Date: Fri Aug 22 02:35:49 2014
New Revision: 1619652

URL: http://svn.apache.org/r1619652
Log:
Extract interface for Runtime.add/removeShutdownHook.

  - Inspired by LOG4J2-658.

Added:
    logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/DefaultShutdownRegistrationStrategy.java
    logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ShutdownRegistrationStrategy.java

Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/DefaultShutdownRegistrationStrategy.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/DefaultShutdownRegistrationStrategy.java?rev=1619652&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/DefaultShutdownRegistrationStrategy.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/DefaultShutdownRegistrationStrategy.java Fri Aug 22 02:35:49 2014
@@ -0,0 +1,36 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.logging.log4j.core.util;
+
+/**
+ * ShutdownRegistrationStrategy that simply uses {@link Runtime#addShutdownHook(Thread)}. If no strategy is specified,
+ * this one is used for shutdown hook registration.
+ *
+ * @since 2.1
+ */
+public class DefaultShutdownRegistrationStrategy implements ShutdownRegistrationStrategy {
+    @Override
+    public void registerShutdownHook(final Thread hook) {
+        Runtime.getRuntime().addShutdownHook(hook);
+    }
+
+    @Override
+    public void unregisterShutdownHook(final Thread hook) {
+        Runtime.getRuntime().removeShutdownHook(hook);
+    }
+}

Added: logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ShutdownRegistrationStrategy.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ShutdownRegistrationStrategy.java?rev=1619652&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ShutdownRegistrationStrategy.java (added)
+++ logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/util/ShutdownRegistrationStrategy.java Fri Aug 22 02:35:49 2014
@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.logging.log4j.core.util;
+
+import org.apache.logging.log4j.Marker;
+import org.apache.logging.log4j.MarkerManager;
+
+/**
+ * Strategy used for registering shutdown hook threads. Due to differing requirements of how late in the JVM lifecycle
+ * Log4j should be shut down, this interface is provided for customizing how to register shutdown hook threads.
+ *
+ * @since 2.1
+ */
+public interface ShutdownRegistrationStrategy {
+
+    /**
+     * System property to set to choose the ShutdownRegistryStrategy.
+     */
+    String SHUTDOWN_REGISTRATION_STRATEGY = "log4j.shutdownRegistrationStrategy";
+
+    /**
+     * System property to set to override the global ability to register shutdown hooks.
+     */
+    String SHUTDOWN_HOOK_ENABLED = "log4j.shutdownHookEnabled";
+
+    /**
+     * Shared Marker to indicate log messages corresponding to shutdown hooks.
+     */
+    Marker SHUTDOWN_HOOK_MARKER = MarkerManager.getMarker("SHUTDOWN HOOK");
+
+    /**
+     * Adds a shutdown hook to be executed upon JVM exit.
+     *
+     * @param hook a Thread in the {@link Thread.State#NEW} state
+     * @throws IllegalStateException If the virtual machine is already in the process of shutting down
+     */
+    void registerShutdownHook(Thread hook);
+
+    /**
+     * Removes a shutdown hook.
+     *
+     * @param hook a previously registered shutdown hook Thread.
+     * @throws IllegalStateException If the virtual machine is already in the process of shutting down
+     */
+    void unregisterShutdownHook(Thread hook);
+}