io.vertx.camel.CamelBridge Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-camel-bridge Show documentation

The newest version!

/*
 *  Copyright (c) 2011-2015 The original author or authors
 *  ------------------------------------------------------
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *       The Eclipse Public License is available at
 *       http://www.eclipse.org/legal/epl-v10.html
 *
 *       The Apache License v2.0 is available at
 *       http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.camel;

import io.vertx.camel.impl.CamelBridgeImpl;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Future;
import io.vertx.core.Vertx;

/**
 * Camel Bridge facade.
 *
 * @author Clement Escoffier
 */
@VertxGen
public interface CamelBridge {

  /**
   * Creates a bridge between Camel endpoints and Vert.x
   *
   * @param vertx         the vert.x instance
   * @param bridgeOptions the bridge configuration
   * @return the created {@link CamelBridge}. It must be started explicitly.
   */
  static CamelBridge create(Vertx vertx, CamelBridgeOptions bridgeOptions) {
    return new CamelBridgeImpl(vertx, bridgeOptions);
  }

  /**
   * Starts the bridge. The bridge is started asynchronously.
   *
   * @return a future notified when the bridge has started
   */
  Future start();

  /**
   * Stops the bridge. The bridges is stopped asynchronously.
   *
   * @return a future notified when the bridge has been stopped
   */
  Future stop();

}