io.apiman.gateway.engine

Interface IEngine

All Known Implementing Classes:

EngineImpl

public interface IEngine

The API Management runtime engine. This engine can either be embedded or used as part of a web app gateway.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
IServiceRequestExecutor	executor(io.apiman.gateway.engine.beans.ServiceRequest request, IAsyncResultHandler<IEngineResult> resultHandler) Executes an asynchronous request for a managed service, with the provided handler being passed an EngineResultImpl with the status and result of the policy chain invocation.
String	getVersion()
void	publishService(io.apiman.gateway.engine.beans.Service service) Publishes a new Service.
void	registerApplication(io.apiman.gateway.engine.beans.Application application) Registers a new Application.
void	retireService(String organizationId, String serviceId, String version) Retires (removes) a Service from the registry.
void	unregisterApplication(String organizationId, String applicationId, String version) Removes an Application from the registry.

Method Detail

getVersion

String getVersion()

Returns:

the version of the engine

executor

IServiceRequestExecutor executor(io.apiman.gateway.engine.beans.ServiceRequest request,
                               IAsyncResultHandler<IEngineResult> resultHandler)

Executes an asynchronous request for a managed service, with the provided handler being passed an EngineResultImpl with the status and result of the policy chain invocation.

Parameters:

request - a request for a managed service

handler - an async handler called when a response is returned or an exception is captured.

publishService

void publishService(io.apiman.gateway.engine.beans.Service service)
                    throws io.apiman.gateway.engine.beans.exceptions.PublishingException

Publishes a new Service.

Parameters:

service - the service being published

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException

retireService

void retireService(String organizationId,
                 String serviceId,
                 String version)
                   throws io.apiman.gateway.engine.beans.exceptions.PublishingException

Retires (removes) a Service from the registry.

Parameters:

organizationId -

serviceId -

version -

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException

registerApplication

void registerApplication(io.apiman.gateway.engine.beans.Application application)
                         throws io.apiman.gateway.engine.beans.exceptions.RegistrationException

Registers a new Application. An application is ultimately a collection of contracts to managed services.

Parameters:

application - the application being registered

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException

io.apiman.gateway.engine.beans.exceptions.RegistrationException

unregisterApplication

void unregisterApplication(String organizationId,
                         String applicationId,
                         String version)
                           throws io.apiman.gateway.engine.beans.exceptions.RegistrationException

Removes an Application from the registry.

Parameters:

organizationId -

applicationId -

version -

Throws:

io.apiman.gateway.engine.beans.exceptions.RegistrationException