com.solace.messaging.util

Interface LifecycleControl

All Known Subinterfaces:

DirectMessagePublisher, DirectMessageReceiver, MessagePublisher, MessageQueueBrowser, MessageReceiver, PersistentMessagePublisher, PersistentMessageReceiver, RequestReplyMessagePublisher, RequestReplyMessageReceiver

@ProviderType
public interface LifecycleControl

An interface for control of the service lifecycle operations such as start and terminate.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LifecycleControl.TerminationEvent An event interface for non-user initiated non-recoverable receiver or publisher unsolicited termination for which applications can listen.
static interface	LifecycleControl.TerminationNotificationListener A callback listener for notifications about non-recoverable receiver or publisher interruptions.

Method Summary

Modifier and Type	Method and Description
boolean	isRunning() Checks if the process was successfully started and not yet stopped.
boolean	isTerminated() Checks if message delivery process is terminated
boolean	isTerminating() Checks if message delivery process termination is ongoing
void	setTerminationNotificationListener(LifecycleControl.TerminationNotificationListener listener) Adds a callback to listen for non-recoverable receiver or publisher interruption events.
LifecycleControl	start() Enables service regular duties.
void	terminate(long gracePeriod) Disables gracefully the regular duties of a receiver or publisher.

Method Detail

isRunning

boolean isRunning()

Checks if the process was successfully started and not yet stopped.

Returns:

false if process was not started or already stopped, otherwise true

Since:

1.0

isTerminated

boolean isTerminated()

Checks if message delivery process is terminated

Returns:

true if message delivery process is terminated, otherwise false

Since:

1.0

isTerminating

boolean isTerminating()

Checks if message delivery process termination is ongoing

Returns:

true if the message delivery process being terminated, but termination is not finished, otherwise false

Since:

1.0

setTerminationNotificationListener

void setTerminationNotificationListener(LifecycleControl.TerminationNotificationListener listener)

Adds a callback to listen for non-recoverable receiver or publisher interruption events.

Parameters:

listener - the service listener

Since:

1.0

start

LifecycleControl start()
                throws PubSubPlusClientException,
                       IllegalStateException

Enables service regular duties. Before this method is called, the service is considered off-duty. To operate normally, this method needs to be called on a receiver or publisher instance. This method is idempotent.

Returns:

an instance of class on which the method was called to support chaining

Throws:

PubSubPlusClientException - if the instance fails to start for some internal reason

IllegalStateException - if the instance was previously terminated, being terminated, or the method has been invoked at an illegal or at an inappropriate time for some another reason

Since:

1.0

terminate

void terminate(long gracePeriod)
        throws PubSubPlusClientException.IncompleteMessageDeliveryException,
               PubSubPlusClientException,
               IllegalStateException

Disables gracefully the regular duties of a receiver or publisher. This method is idempotent. Only way to resume operation after this method is called is to recreate an instance.

Any attempts to call this method renders the instance permanently terminated, even if this method completes.

You can use gracePeriod == 0 for non-graceful shutdown that ignores unfinished tasks or in-flight messages.

Parameters:

gracePeriod - >0 defines the termination grace period, the amount of time given to finish regular tasks before a non-graceful interruption of duties take place, measured in milliseconds. A value of 0 can be used to specify no grace period so that all unfinished tasks or in-flight messages are ignored. Values < 0 are illegal.

Values in a few milliseconds range may not be applied to be 100% accurate.

Throws:

PubSubPlusClientException.IncompleteMessageDeliveryException - if some incomplete processed messages are discovered at the call time point of the call

PubSubPlusClientException - if the service termination experienced some exception for an internal reason. Even so, an exception occurred so the given instance of a service can be considered terminated

IllegalStateException - if the method has been invoked at an illegal or inappropriate time or for the specified gracePeriod < 0, or for some another reason

Since:

1.0