org.jooby

Interface LifeCycle

All Known Subinterfaces:

Env

All Known Implementing Classes:

Jooby

public interface LifeCycle

life cycle

Listen for application start and stop events. Useful for starting/stopping services.

onStart/onStop events

Start/stop callbacks are accessible via application:

 {
    onStart(() -> {
      log.info("starting app");
    });

    onStop(() -> {
      log.info("stopping app");
    });
 }
 

Or via module:

 public class MyModule implements Jooby.Module {

   public void configure(Env env, Config conf, Binder binder) {
     env.onStart(() -> {
       log.info("starting module");
     });

     env.onStop(() -> {
       log.info("stopping module");
     });
   }
 }
 

callbacks order

Callback order is preserved:

 {
   onStart(() -> {
     log.info("first");
   });

   onStart(() -> {
     log.info("second");
   });

   onStart(() -> {
     log.info("third");
   });
 }
 

Order is useful for service dependencies, like ServiceB should be started after ServiceA.

service registry

You can also request for a service and start or stop it:

 {
   onStart(registry -> {
     MyService service = registry.require(MyService.class);
     service.start();
   });

   onStop(registry -> {
     MyService service = registry.require(MyService.class);
     service.stop();
   });
 }
 

PostConstruct/PreDestroy annotations

If you prefer the annotation way... you can too:

 @Singleton
 public class MyService {

   @PostConstruct
   public void start() {
   }

   @PreDestroy
   public void stop() {
   }
 }

 App.java:

 {
   lifeCycle(MyService.class);
 }

 

It works as expected just make sure MyService is a Singleton object.

Since:

1.0.0.CR3

Author:

edgar

Method Summary

Modifier and Type	Method and Description
default LifeCycle	lifeCycle(Class<?> service) Add to lifecycle the given service.
static Optional<org.jooby.funzy.Throwing.Consumer<Object>>	lifeCycleAnnotation(Class<?> rawType, Class<? extends Annotation> annotation) Find a single method annotated with the given annotation in the provided type.
LifeCycle	onStart(org.jooby.funzy.Throwing.Consumer<Registry> task) Add a start lifecycle event, useful for initialize and/or start services at startup time.
default LifeCycle	onStart(org.jooby.funzy.Throwing.Runnable task) Add a start lifecycle event, useful for initialize and/or start services at startup time.
LifeCycle	onStarted(org.jooby.funzy.Throwing.Consumer<Registry> task) Add a started lifecycle event.
default LifeCycle	onStarted(org.jooby.funzy.Throwing.Runnable task) Add a started lifecycle event.
LifeCycle	onStop(org.jooby.funzy.Throwing.Consumer<Registry> task) Add a stop lifecycle event, useful for cleanup and/or stop service at stop time.
default LifeCycle	onStop(org.jooby.funzy.Throwing.Runnable task) Add a stop lifecycle event, useful for cleanup and/or stop service at stop time.

Method Detail

lifeCycleAnnotation

static Optional<org.jooby.funzy.Throwing.Consumer<Object>> lifeCycleAnnotation(Class<?> rawType,
                                                                               Class<? extends Annotation> annotation)

Find a single method annotated with the given annotation in the provided type.

Parameters:

rawType - The type to look for a method.

annotation - Annotation to look for.

Returns:

A callback to the method. Or empty.

lifeCycle

@Nonnull
default LifeCycle lifeCycle(Class<?> service)

Add to lifecycle the given service. Any method annotated with PostConstruct or PreDestroy will be executed at application startup or shutdown time. The service must be a Singleton object.

 @Singleton
 public class MyService {

   @PostConstruct
   public void start() {
   }

   @PreDestroy
   public void stop() {
   }
 }

 App.java:

 {
   lifeCycle(MyService.class);
 }

 

You should ONLY call this method while the application is been initialized or while Jooby.Module.configure(Env, Config, com.google.inject.Binder) is been executed. The behavior of this method once application has been initialized is undefined.

Parameters:

service - Service type. Must be a singleton object.

Returns:

This instance.

onStart

@Nonnull
LifeCycle onStart(org.jooby.funzy.Throwing.Consumer<Registry> task)

Add a start lifecycle event, useful for initialize and/or start services at startup time. You should ONLY call this method while the application is been initialized or while Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behavior of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.

onStarted

@Nonnull
LifeCycle onStarted(org.jooby.funzy.Throwing.Consumer<Registry> task)

Add a started lifecycle event. Started callbacks are executed when the application is ready: modules and servers has been started. You should ONLY call this method while the application is been initialized or while Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behavior of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.

onStart

@Nonnull
default LifeCycle onStart(org.jooby.funzy.Throwing.Runnable task)

Add a start lifecycle event, useful for initialize and/or start services at startup time. You should ONLY call this method while the application is been initialized or from Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behavior of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.

onStarted

@Nonnull
default LifeCycle onStarted(org.jooby.funzy.Throwing.Runnable task)

Add a started lifecycle event. Started callbacks are executed when the application is ready: modules and servers has been started. You should ONLY call this method while the application is been initialized or while Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behavior of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.

onStop

@Nonnull
default LifeCycle onStop(org.jooby.funzy.Throwing.Runnable task)

Add a stop lifecycle event, useful for cleanup and/or stop service at stop time. You should ONLY call this method while the application is been initialized or from Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behavior of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.

onStop

@Nonnull
LifeCycle onStop(org.jooby.funzy.Throwing.Consumer<Registry> task)

Add a stop lifecycle event, useful for cleanup and/or stop service at stop time. You should ONLY call this method while the application is been initialized or from Jooby.Module.configure(Env, Config, com.google.inject.Binder). The behaviour of this method once application has been initialized is undefined.

Parameters:

task - Task to run.

Returns:

This env.