Package io.vertx.core

Interface Deployable

  • All Known Subinterfaces:
    Verticle
    All Known Implementing Classes:
    AbstractVerticle, VerticleBase
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface Deployable
    Base interface for reactive services written in Java deployed in a Vert.x instance
    Author:
    Julien Viet
    • Method Detail

      • deploy

        Future<?> deploy​(Context context)
                  throws Exception
        Start the deployable.

        Vert.x calls this method when deploying this deployable. You do not call it yourself.

        Parameters:
        context - the Vert.x context assigned to this deployable
        Returns:
        a future signalling the start-up completion
        Throws:
        Exception
      • undeploy

        default Future<?> undeploy​(Context context)
                            throws Exception
        Stop the deployable.

        Vert.x calls this method when undeploying this deployable. You do not call it yourself.

        Parameters:
        context - the Vert.x context assigned to this deployable
        Returns:
        a future signalling the clean-up completion
        Throws:
        Exception