io.apiman.gateway.engine

Interface IRegistry

All Known Implementing Classes:

InMemoryRegistry, SecureRegistryWrapper

public interface IRegistry

A registry that maintains a collection of Services and Contracts that have been published to the API Management runtime engine. This registry provides a mechanism to both publish new ones (and remove/retire old ones) as well as retrieve them.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	getContract(io.apiman.gateway.engine.beans.ServiceRequest request, IAsyncResultHandler<io.apiman.gateway.engine.beans.ServiceContract> handler) Gets the Contract to use based on information included in the inbound service request.
void	getService(String organizationId, String serviceId, String serviceVersion, IAsyncResultHandler<io.apiman.gateway.engine.beans.Service> handler) Gets a service by its service coordinates.
void	publishService(io.apiman.gateway.engine.beans.Service service, IAsyncResultHandler<Void> handler) Publishes a new Service into the registry.
void	registerApplication(io.apiman.gateway.engine.beans.Application application, IAsyncResultHandler<Void> handler) Registers a new Application with the registry.
void	retireService(io.apiman.gateway.engine.beans.Service service, IAsyncResultHandler<Void> handler) Retires (removes) a Service from the registry.
void	unregisterApplication(io.apiman.gateway.engine.beans.Application application, IAsyncResultHandler<Void> handler) Removes an Application from the registry.

Method Detail

getContract

void getContract(io.apiman.gateway.engine.beans.ServiceRequest request,
               IAsyncResultHandler<io.apiman.gateway.engine.beans.ServiceContract> handler)

Gets the Contract to use based on information included in the inbound service request.

Parameters:

request - an inbound service request

handler - the result handler

Throws:

io.apiman.gateway.engine.beans.exceptions.InvalidContractException - when contract is invalid

publishService

void publishService(io.apiman.gateway.engine.beans.Service service,
                  IAsyncResultHandler<Void> handler)

Publishes a new Service into the registry.

Parameters:

service - the service being published

handler - the result handler

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException - when unable to publish service

retireService

void retireService(io.apiman.gateway.engine.beans.Service service,
                 IAsyncResultHandler<Void> handler)

Retires (removes) a Service from the registry.

Parameters:

service - the service

handler - the result handler

Throws:

io.apiman.gateway.engine.beans.exceptions.PublishingException - when unable to retire service

registerApplication

void registerApplication(io.apiman.gateway.engine.beans.Application application,
                       IAsyncResultHandler<Void> handler)

Registers a new Application with the registry.

Parameters:

application - the application being registered

handler - the result handler

Throws:

io.apiman.gateway.engine.beans.exceptions.RegistrationException - when unable to register entity

unregisterApplication

void unregisterApplication(io.apiman.gateway.engine.beans.Application application,
                         IAsyncResultHandler<Void> handler)

Removes an Application from the registry.

Parameters:

application - the application to remove

handler - the result handler

Throws:

io.apiman.gateway.engine.beans.exceptions.RegistrationException - when unable to register entity

getService

void getService(String organizationId,
              String serviceId,
              String serviceVersion,
              IAsyncResultHandler<io.apiman.gateway.engine.beans.Service> handler)

Gets a service by its service coordinates.

Parameters:

organizationId - the org id

serviceId - the service id

serviceVersion - the service version

handler - the result handler