io.openmessaging

Interface ServiceLifecycle

All Superinterfaces:

Extension

All Known Subinterfaces:

Consumer, Producer, PullConsumer, PushConsumer

public interface ServiceLifecycle
extends Extension

The ServiceLifecycle defines a lifecycle interface for a OMS related service endpoint, like Producer, Consumer, and so on.

If the service endpoint class implements the ServiceLifecycle interface, most of the containers can manage the lifecycle of the corresponding service endpoint objects easily.

Any service endpoint should support repeated restart if it implements the ServiceLifecycle interface.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

Method Summary

Modifier and Type	Method and Description
ServiceLifeState	currentState() Used for get service current state, for execution of some operations is dependent on the current service state.
void	start() Used for startup or initialization of a service endpoint.
void	stop() Notify a service instance of the end of its life cycle.

Methods inherited from interface io.openmessaging.extension.Extension

getQueueMetaData

Method Detail

start

void start()

Used for startup or initialization of a service endpoint. A service endpoint instance will be in a ready state after this method has been completed.

stop

void stop()

Notify a service instance of the end of its life cycle. Once this method completes, the service endpoint could be destroyed and eligible for garbage collection.

currentState

ServiceLifeState currentState()

Used for get service current state, for execution of some operations is dependent on the current service state.

Returns:

This service current state ServiceLifeState