io.ebean.plugin.Plugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebean-api Show documentation

ebean api

There is a newer version: 15.8.0

package io.ebean.plugin;

/**
 * A 'plugin' that wants to be configured on startup so it can use features of the Database itself.
 */
public interface Plugin {

  /**
   * Configure the plugin.
   */
  void configure(SpiServer server);

  /**
   * Called just before the server starts indicating if it is coming up in online mode.
   */
  void online(boolean online);

  /**
   * Called when the server is shutting down.
   * 
   * Plugins should shutdown any resources they are using cleanly.
   * 
   */
  void shutdown();
}