DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Alternative Structured Concurrency
  • Jakarta EE 12: Entering the Data Age of Enterprise Java
  • Zero-Downtime Deployments for Java Apps on Kubernetes
  • Rethinking Java CRUDs With Event Sourcing and CQRS Patterns

Trending

  • Lambda-Driven API Design: Building Composable Node.js Endpoints With Functional Primitives
  • Slopsquatting: Building a Scanner That Catches AI-Hallucinated Packages Before They Reach Production
  • A Deep Dive into Tracing Agentic Workflows (Part 1)
  • Bringing Intelligence Closer to the Source: Why Real-Time Processing is the Heart of Edge AI
  1. DZone
  2. Coding
  3. Java
  4. Java JMX Shutdown Gracefully with ShutdownHook example

Java JMX Shutdown Gracefully with ShutdownHook example

By 
Bosco Ferrao user avatar
Bosco Ferrao
·
Jul. 30, 14 · Code Snippet
Likes (0)
Comment
Save
Tweet
Share
7.6K Views

Join the DZone community and get the full member experience.

Join For Free

For JMX you need an interface:

package com.bos.jmx;

public interface ShutdownMBean {
	/**
		 * Shutdown operation
		 */	
	public void shutdown() throws Exception;
}

The implementation is Shutdown java class above.

Include this code on server startup used in my Main.java:

public void initServerJMX() throws MalformedObjectNameException,
       InstanceAlreadyExistsException, MBeanRegistrationException,
       NotCompliantMBeanException {
     // Initialise JMX
     // Get the Platform MBean Server
     MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();

     // Construct the ObjectName for the Shutdown MBean we will register
     ObjectName mbeanName = new ObjectName("com.bos.jmx:type=Shutdown");

     // Create the Shutdown MBean
     final Shutdown mbean = new Shutdown();

     // Register the Hello World MBean
     mbs.registerMBean(mbean, mbeanName);
     
     Runtime.getRuntime().addShutdownHook(new Thread() {
       public void run() {
         try {
           mbean.shutdown();
         } catch (Exception e) {
           e.printStackTrace();
         }
       }
     });
   }

public void useArg0(String arg) {

//sample code using arg

}

Include this code in client used to shutdown the server used in my Main.java:

public void clientExecuteShutdown(int port) throws Exception {
	JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://:"
						+ port + "/jmxrmi");
			JMXConnector jmxc = JMXConnectorFactory.connect(url, null);
			MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();
		
	// Construct the ObjectName for the Shutdown MBean
        //
        ObjectName mbeanName = new ObjectName("com.bos.jmx:type=Shutdown");

        // Create a dedicated proxy for the MBean instead of
        // going directly through the MBean server connection
        //
        ShutdownMBean mbeanProxy =
            JMX.newMBeanProxy(mbsc, mbeanName, ShutdownMBean.class, true);
        
        logger.info("Executing shutdown...");
        mbeanProxy.shutdown();
        logger.info("Shutdown done.");
	}

My sample start/shutdown code with main used in my Main.java:

public static void main(String args[]) throws NumberFormatException, Exception {

			if (args.length < 1) {
						throw new RuntimeException(
		"1. Please specify 1st argument."
									+ "\n2. Please specify 1st argument as shutdown and 2nd argument as port of JMX.");
			}
			if ("shutdown".equalsIgnoreCase(args[0])) {
					if (args.length < 2) {
							throw new RuntimeException(
									"Please specify 1st argument as shutdown and 2nd argument as port of JMX.");
					}
					clientExecuteShutdown(Integer.valueOf(args[1]));
			} else {
			useArg0(args[0]);
					initServerJMX();
	}	
	}

This code attached also has Runtime.getRuntime().addShutdownHook()

The code startup line is for server:

java -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -classpath . com.bos.jmx.Main arg0

The code for shutdown of server is:

java -classpath . com.bos.jmx.Main shutdown 9999
package com.bos.jmx;

public class Shutdown implements ShutdownMBean {
	private static volatile boolean flagRunOne = false;

	@Override
	public void shutdown() throws Exception {
		if (!flagRunOne) {
			System.out.println("Server shutting down...");
			//Sample shutdown code here
			Main.shutdown();
			System.out.println("Server shutdown.");
			flagRunOne = true;
		}
	}
}
Java (programming language)

Opinions expressed by DZone contributors are their own.

Related

  • Alternative Structured Concurrency
  • Jakarta EE 12: Entering the Data Age of Enterprise Java
  • Zero-Downtime Deployments for Java Apps on Kubernetes
  • Rethinking Java CRUDs With Event Sourcing and CQRS Patterns

Partner Resources

×

Comments

The likes didn't load as expected. Please refresh the page and try again.

  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook