io.apiman.gateway.engine

Interface IRegistry

All Known Implementing Classes:

InMemoryRegistry

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
io.apiman.gateway.engine.beans.ServiceContract	getContract(io.apiman.gateway.engine.beans.ServiceRequest request) Gets the Contract to use based on information included in the inbound service request.
void	publishService(io.apiman.gateway.engine.beans.Service service) Publishes a new Service into the registry.
void	registerApplication(io.apiman.gateway.engine.beans.Application application) Registers a new Application with the registry.
void	retireService(io.apiman.gateway.engine.beans.Service service) Retires (removes) a Service from the registry.
void	unregisterApplication(io.apiman.gateway.engine.beans.Application application) Removes an Application from the registry.

Method Detail

getContract

io.apiman.gateway.engine.beans.ServiceContract getContract(io.apiman.gateway.engine.beans.ServiceRequest request)
                                                           throws io.apiman.gateway.engine.beans.exceptions.InvalidContractException

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

Parameters:

request - an inbound service request

Returns:

a Contract or null if not found

Throws:

io.apiman.gateway.engine.beans.exceptions.InvalidContractException

publishService

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

Publishes a new Service into the registry.

Parameters:

service - the service being published

Throws:

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

retireService

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

Retires (removes) a Service from the registry.

Parameters:

service -

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 with the registry.

Parameters:

application - the application being registered

Throws:

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

unregisterApplication

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

Removes an Application from the registry.

Parameters:

application - the application to remove

Throws:

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