Used in: cluster-config.


Specifies the action a cluster node should take upon receiving an external shutdown request. External shutdown includes the "kill" command on Unix and "Ctrl-C" on Windows and Unix.


The following table describes the elements you can define within the shutdown-listener element.

Element Required/Optional Description
<enabled> Required Specifies the type of action to take upon an external JVM shutdown.

Legal Values:

  • none - perform no explicit shutdown actions
  • force - perform "hard-stop" the node by calling Cluster.stop()
  • graceful - perform a "normal" shutdown by calling Cluster.shutdown()
  • true - same as force
  • false - same as none

Note: For production use, the suggested value is none unless testing has verified that the behavior on external shutdown is exactly what is desired.

Default value is force.

Preconfigured override is tangosol.coherence.shutdownhook

The content override attribute xml-override can be optionally used to fully or partially override the contents of this element with XML document that is external to the base document.