io.fabric8.gateway.api.apimanager

Interface ApiManagerService

public interface ApiManagerService

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_GATEWAY
static String	PORT
static String	PORT_REST
static String	VERTX

Method Summary

Methods

Modifier and Type	Method and Description
org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest>	createApiManagerHttpGatewayHandler() Creates an implementation of a Handler of type HttpServerRequest, and returns a reference.
org.vertx.java.core.Handler<org.vertx.java.core.http.HttpClientResponse>	createServiceResponseHandler(org.vertx.java.core.http.HttpClient httpClient, Object apiManagementResponseHandler) Creates a Handler of type HttpClientResponse.
ServiceMapping	getApiManagerServiceMapping(String servicePath) Return service info: OrganizationId, ServiceId and Version of this service given the servicePath.
Object	getEngine() Get a reference to a 3rd Party API Manager Engine
void	init(Map<String,Object> config)

Field Detail

VERTX

static final String VERTX

See Also:

Constant Field Values

HTTP_GATEWAY

static final String HTTP_GATEWAY

See Also:

Constant Field Values

PORT

static final String PORT

See Also:

Constant Field Values

PORT_REST

static final String PORT_REST

See Also:

Constant Field Values

Method Detail

init

void init(Map<String,Object> config)

getEngine

Object getEngine()

Get a reference to a 3rd Party API Manager Engine

createServiceResponseHandler

org.vertx.java.core.Handler<org.vertx.java.core.http.HttpClientResponse> createServiceResponseHandler(org.vertx.java.core.http.HttpClient httpClient,
                                                                                                    Object apiManagementResponseHandler)

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.

Parameters:

httpClient - - vert.x HttpClient used to call the fabric8 service

httpServerRequest - - vert.x HttpServerRequest used to create a HttpServiceResponseHandler when no API Manager is used

apiManagementResponseHandler - -

Returns:

createApiManagerHttpGatewayHandler

org.vertx.java.core.Handler<org.vertx.java.core.http.HttpServerRequest> createApiManagerHttpGatewayHandler()

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.

Returns:

a Handler of type HttpServerRequest

See Also:

HttpGatewayHandler, ApiManHttpGatewayHandler

getApiManagerServiceMapping

ServiceMapping getApiManagerServiceMapping(String servicePath)

Return service info: OrganizationId, ServiceId and Version of this service given the servicePath.

Parameters:

servicePath - - the path of the backend service

Returns: