net.kuujo.vertigo.deployment.DeploymentManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo Show documentation
There is a newer version: 1.0.2
/*
 * Copyright 2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.kuujo.vertigo.deployment;

import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.ServiceHelper;
import io.vertx.core.Vertx;
import net.kuujo.vertigo.VertigoOptions;
import net.kuujo.vertigo.context.NetworkContext;
import net.kuujo.vertigo.reference.NetworkReference;
import net.kuujo.vertigo.spi.DeploymentManagerFactory;

/**
 * Vertigo context manager.
 *
 * @author Jordan Halterman
 */
public interface DeploymentManager {

  /**
   * Loads a context manager.
   *
   * @param vertx The current Vert.x instance.
   * @param options The Vertigo options.
   * @return A new context manager.
   */
  static DeploymentManager manager(Vertx vertx, VertigoOptions options) {
    return factory.createContextManager(vertx, options);
  }

  /**
   * Loads a network context.
   *
   * @param id The network context ID.
   * @param doneHandler An asynchronous handler to be called once the network context has been loaded.
   * @return The context manager.
   */
  DeploymentManager getNetwork(String id, Handler> doneHandler);

  /**
   * Deploys a network.
   *
   * @param network The network to deploy.
   * @param doneHandler An asynchronous handler to be called once the network has been deployed.
   * @return The context manager.
   */
  DeploymentManager deployNetwork(NetworkContext network, Handler> doneHandler);

  /**
   * Undeploys a network.
   *
   * @param network The network to undeploy.
   * @param doneHandler An asynchronous handler to be called once completed.
   * @return The context manager.
   */
  DeploymentManager undeployNetwork(NetworkContext network, Handler> doneHandler);

  /**
   * Gets a network reference (which allows sending messages to it).
   * @param id The network context ID.
   * @param doneHandler An asynchronous handler to be called once the network reference has been loaded.
   * @return The network reference.
   */
  DeploymentManager getNetworkReference(String id, Handler> doneHandler);

  static DeploymentManagerFactory factory = ServiceHelper.loadFactory(DeploymentManagerFactory.class);

}