io.apiman.gateway.engine.impl

Class EngineImpl

java.lang.Object

io.apiman.gateway.engine.impl.EngineImpl

All Implemented Interfaces:

IEngine

public class EngineImpl
extends Object
implements IEngine

The implementation of the API Management runtime engine.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
EngineImpl(IRegistry registry, IPluginRegistry pluginRegistry, IComponentRegistry componentRegistry, IConnectorFactory connectorFactory, IPolicyFactory policyFactory) Constructor.

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.
IComponentRegistry	getComponentRegistry()
IConnectorFactory	getConnectorFactory()
IPluginRegistry	getPluginRegistry()
IPolicyFactory	getPolicyFactory()
IRegistry	getRegistry()
protected io.apiman.gateway.engine.beans.Service	getService(String serviceOrgId, String serviceId, String serviceVersion) Gets a published service by its service coordinates.
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	setComponentRegistry(IComponentRegistry componentRegistry)
void	setConnectorFactory(IConnectorFactory connectorFactory)
void	setPluginRegistry(IPluginRegistry pluginRegistry)
void	setPolicyFactory(IPolicyFactory policyFactory)
void	setRegistry(IRegistry registry)
void	unregisterApplication(String organizationId, String applicationId, String version) Removes an Application from the registry.
protected void	validateRequest(io.apiman.gateway.engine.beans.ServiceRequest request) Validates that the contract being used for the request is valid against the service information included in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EngineImpl

public EngineImpl(IRegistry registry,
          IPluginRegistry pluginRegistry,
          IComponentRegistry componentRegistry,
          IConnectorFactory connectorFactory,
          IPolicyFactory policyFactory)

Constructor.

Parameters:

registry -

pluginRegistry -

componentRegistry -

connectorFactory -

policyFactory -

Method Detail

getVersion

public String getVersion()

Specified by:

getVersion in interface IEngine

Returns:

the version of the engine

See Also:

IEngine.getVersion()

executor

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

Description copied from interface: IEngine

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.

Specified by:

executor in interface IEngine

Parameters:

request - a request for a managed service

See Also:

io.apiman.gateway.engine.IEngine#request()

getService

protected io.apiman.gateway.engine.beans.Service getService(String serviceOrgId,
                                                String serviceId,
                                                String serviceVersion)

Gets a published service by its service coordinates.

Parameters:

serviceOrgId -

serviceId -

serviceVersion -

validateRequest

protected void validateRequest(io.apiman.gateway.engine.beans.ServiceRequest request)
                        throws io.apiman.gateway.engine.beans.exceptions.InvalidContractException

Validates that the contract being used for the request is valid against the service information included in the request. Basically the request includes information indicating which specific service is being invoked. This method ensures that the service information in the contract matches the requested service.

Parameters:

request -

Throws:

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

publishService

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

Description copied from interface: IEngine

Publishes a new Service.

Specified by:

publishService in interface IEngine

Parameters:

service - the service being published

Throws:

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

See Also:

IEngine.publishService(io.apiman.gateway.engine.beans.Service)

retireService

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

Description copied from interface: IEngine

Retires (removes) a Service from the registry.

Specified by:

retireService in interface IEngine

Throws:

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

See Also:

IEngine.retireService(java.lang.String, java.lang.String, java.lang.String)

registerApplication

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

Description copied from interface: IEngine

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

Specified by:

registerApplication in interface IEngine

Parameters:

application - the application being registered

Throws:

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

See Also:

IEngine.registerApplication(io.apiman.gateway.engine.beans.Application)

unregisterApplication

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

Description copied from interface: IEngine

Removes an Application from the registry.

Specified by:

unregisterApplication in interface IEngine

Throws:

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

See Also:

IEngine.unregisterApplication(java.lang.String, java.lang.String, java.lang.String)

getRegistry

public IRegistry getRegistry()

Returns:

the registry

setRegistry

public void setRegistry(IRegistry registry)

Parameters:

registry - the registry to set

getConnectorFactory

public IConnectorFactory getConnectorFactory()

Returns:

the connectorFactory

setConnectorFactory

public void setConnectorFactory(IConnectorFactory connectorFactory)

Parameters:

connectorFactory - the connectorFactory to set

getPolicyFactory

public IPolicyFactory getPolicyFactory()

Returns:

the policyFactory

setPolicyFactory

public void setPolicyFactory(IPolicyFactory policyFactory)

Parameters:

policyFactory - the policyFactory to set

getComponentRegistry

public IComponentRegistry getComponentRegistry()

Returns:

the componentRegistry

setComponentRegistry

public void setComponentRegistry(IComponentRegistry componentRegistry)

Parameters:

componentRegistry - the componentRegistry to set

getPluginRegistry

public IPluginRegistry getPluginRegistry()

Returns:

the pluginRegistry

setPluginRegistry

public void setPluginRegistry(IPluginRegistry pluginRegistry)

Parameters:

pluginRegistry - the pluginRegistry to set