Package io.joynr.runtime

Class ShutdownNotifier

java.lang.Object

io.joynr.runtime.ShutdownNotifier

public class ShutdownNotifier
extends Object

Constructor Summary

Constructors

Constructor	Description
ShutdownNotifier()

Method Summary

Modifier and Type	Method	Description
void	prepareForShutdown()	Will call PrepareForShutdownListener.prepareForShutdown() for each registered listener asynchronously, and waiting a total of five seconds for all to complete or will then timeout without waiting.
void	registerForShutdown(ShutdownListener shutdownListener)	Register to have the listener's shutdown method called at system shutdown NOTE: no shutdown order is guaranteed registered using this method.
void	registerHivemqMqttPrepareForShutdownListener(PrepareForShutdownListener listener)	Register to have HivemqMqttClientFactory.prepareForShutdown() called at system prepareForShutdown.
void	registerHivemqMqttShutdownListener(ShutdownListener listener)	Register to have HivemqMqttClientFactory.shutdown() called at system shutdown.
void	registerMessageTrackerPrepareForShutdownListener(PrepareForShutdownListener listener)	Register to have MessageTrackerForGracefulShutdown.prepareForShutdown() called at system prepareForShutdown.
void	registerMessageTrackerShutdownListener(ShutdownListener listener)	Register to have MessageTrackerForGracefulShutdown.shutdown() called at system shutdown.
void	registerPrepareForShutdownListener(PrepareForShutdownListener prepareForShutdownListener)	Register to have the listener's prepareForShutdown method called at system prepareForShutdown NOTE: no shutdown order is guaranteed registered using this method.
void	registerProxyInvocationHandlerPrepareForShutdownListener(PrepareForShutdownListener listener)	Register to have ProxyInvocationHandler.prepareForShutdown() called at system shutdown.
void	registerProxyInvocationHandlerShutdownListener(ShutdownListener listener)	Register to have ProxyInvocationHandler.shutdown() called at system shutdown.
void	registerToBeShutdownAsLast(ShutdownListener shutdownListener)	Register to have the listener's shutdown method called at system shutdown as one of the last listeners.
void	shutdown()	Calls ShutdownListener.shutdown() for each registered listener synchronously in turn.
void	unregister(PrepareForShutdownListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShutdownNotifier

public ShutdownNotifier()

Method Detail

registerHivemqMqttPrepareForShutdownListener

public void registerHivemqMqttPrepareForShutdownListener(PrepareForShutdownListener listener)
                                                  throws IllegalArgumentException

Register to have HivemqMqttClientFactory.prepareForShutdown() called at system prepareForShutdown.

Parameters:

listener - PrepareForShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerMessageTrackerPrepareForShutdownListener

public void registerMessageTrackerPrepareForShutdownListener(PrepareForShutdownListener listener)
                                                      throws IllegalArgumentException

Register to have MessageTrackerForGracefulShutdown.prepareForShutdown() called at system prepareForShutdown.

Parameters:

listener - PrepareForShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerProxyInvocationHandlerPrepareForShutdownListener

public void registerProxyInvocationHandlerPrepareForShutdownListener(PrepareForShutdownListener listener)
                                                              throws IllegalArgumentException

Register to have ProxyInvocationHandler.prepareForShutdown() called at system shutdown.

Parameters:

listener - PrepareForShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerHivemqMqttShutdownListener

public void registerHivemqMqttShutdownListener(ShutdownListener listener)
                                        throws IllegalArgumentException

Register to have HivemqMqttClientFactory.shutdown() called at system shutdown.

Parameters:

listener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerMessageTrackerShutdownListener

public void registerMessageTrackerShutdownListener(ShutdownListener listener)
                                            throws IllegalArgumentException

Register to have MessageTrackerForGracefulShutdown.shutdown() called at system shutdown.

Parameters:

listener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerProxyInvocationHandlerShutdownListener

public void registerProxyInvocationHandlerShutdownListener(ShutdownListener listener)
                                                    throws IllegalArgumentException

Register to have ProxyInvocationHandler.shutdown() called at system shutdown.

Parameters:

listener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerForShutdown

public void registerForShutdown(ShutdownListener shutdownListener)
                         throws IllegalArgumentException

Register to have the listener's shutdown method called at system shutdown NOTE: no shutdown order is guaranteed registered using this method. Listeners which should be invoked in specific order are to be registered using dedicated register methods.

Parameters:

shutdownListener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerToBeShutdownAsLast

public void registerToBeShutdownAsLast(ShutdownListener shutdownListener)
                                throws IllegalArgumentException

Register to have the listener's shutdown method called at system shutdown as one of the last listeners. It is a partial ordering and ensures that this listener's shutdown will be called after all listeners registered using registerForShutdown(ShutdownListener). NOTE: Listeners who manage some executor service should use this method.

Parameters:

shutdownListener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

registerPrepareForShutdownListener

public void registerPrepareForShutdownListener(PrepareForShutdownListener prepareForShutdownListener)
                                        throws IllegalArgumentException

Register to have the listener's prepareForShutdown method called at system prepareForShutdown NOTE: no shutdown order is guaranteed registered using this method. Listeners which should be invoked in specific order are to be registered using dedicated register methods.

Parameters:

prepareForShutdownListener - ShutdownListener

Throws:

IllegalArgumentException - when parent class of listener is of unsupported class

prepareForShutdown

public void prepareForShutdown()
                        throws InterruptedException

Will call PrepareForShutdownListener.prepareForShutdown() for each registered listener asynchronously, and waiting a total of five seconds for all to complete or will then timeout without waiting.

Throws:

InterruptedException

shutdown

public void shutdown()

Calls ShutdownListener.shutdown() for each registered listener synchronously in turn.

unregister

public void unregister(PrepareForShutdownListener listener)