io.dropwizard.lifecycle.AutoCloseableManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropwizard-lifecycle Show documentation

The newest version!

package io.dropwizard.lifecycle;

/**
 * An implementation of the Managed Interface for {@link AutoCloseable} instances. Adding an
 * {@code AutoCloseableManager} instance to the application's environment ties that object’s lifecycle to
 * that of the application’s HTTP server. After the server has stopped (and after its graceful
 * shutdown period) the {@link #stop()} method is called, which will trigger the call to {@link
 * AutoCloseable#close()}
 *
 * Usage :
 *  * {@code
 * AutoCloseable client = ...;
 * AutoCloseableManager clientManager = new AutoCloseableManager(client);
 * environment.lifecycle().manage(clientManager);
 * }
 * 
 */
public class AutoCloseableManager implements Managed {

    private final AutoCloseable autoCloseable;

    /**
     * @param autoCloseable instance to close when the HTTP server stops.
     */
    public AutoCloseableManager(final AutoCloseable autoCloseable) {
        this.autoCloseable = autoCloseable;
    }

    /**
     * Calls {@link AutoCloseable#close()} on the closable provided in
     * {@link AutoCloseableManager#AutoCloseableManager(AutoCloseable)}.
     *
     * @throws Exception propagates {@link AutoCloseable#close()} exception
     */
    @Override
    public void stop() throws Exception {
        this.autoCloseable.close();
    }
}