io.fabric8.gateway.api.apimanager.ApiManagerService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateway-api Show documentation
There is a newer version: 2.2.22
/*
 *  Copyright 2005-2015 Red Hat, Inc.
 *
 *  Red Hat licenses this file to you 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 io.fabric8.gateway.api.apimanager;

import io.fabric8.gateway.api.handlers.http.HttpGatewayHandler;

import java.util.Map;

import org.vertx.java.core.Handler;
import org.vertx.java.core.http.HttpClient;
import org.vertx.java.core.http.HttpClientResponse;
import org.vertx.java.core.http.HttpServerRequest;

/**
 * Fabric8's API Manager interface. The interface provides access to a 3rd party 'Engine',
 * as well as access to handler needed for the asynchronous nature of Fabric8's HTTPGateway.
 * The ApiManager
 */
public interface ApiManagerService {

	public final static String VERTX        = "vertx";
	public final static String HTTP_GATEWAY = "httpGateway";
	public final static String PORT         = "port";
	public final static String PORT_REST    = "port.rest";

	public void init(Map config);

	/** Get a reference to a 3rd Party API Manager Engine */
	public Object getEngine();

	/**
     * Creates a Handler of type HttpClientResponse. The HttpGateway knows if it is configured
     * to run with an API Manager or as a simple proxy. Therefore it can return the correct handler
     * to be registered with the vert.x framework. This handler is called to handle a response
     * from a fabric8 service.
     *
     * @param httpClient - vert.x HttpClient used to call the fabric8 service
     * @param httpServerRequest - vert.x HttpServerRequest used to create a HttpServiceResponseHandler
     *  when no API Manager is used
     * @param apiManagementResponseHandler -
     * @return
     *
     * @See       HttpServiceResponseHandler
     * @See ApiManHttpServiceResponseHandler
     *
     */
    public Handler  createServiceResponseHandler(HttpClient httpClient,
    		Object apiManagementResponseHandler);
	/**
	 * Creates an implementation of a Handler of type HttpServerRequest, and returns a reference.
	 * This handler is called by the vert.x framework, when when the gateway invoked by an external
	 * client application.
	 *

	 * @return a Handler of type HttpServerRequest
	 *
	 * @see       HttpGatewayHandler
	 * @see ApiManHttpGatewayHandler
	 */
	public Handler createApiManagerHttpGatewayHandler();
	/**
	 * Return service info: OrganizationId, ServiceId and Version of this service
	 * given the servicePath.
	 *
	 * @param servicePath - the path of the backend service
	 * @return
	 */
	public ServiceMapping getApiManagerServiceMapping(String servicePath);
}