io.apiman.manager.api.gateway

Interface IGatewayLink

All Known Implementing Classes:

RestGatewayLink

public interface IGatewayLink

Links the design time API with a Gateway. This allows the design time API to interface with the runtime Gateway in order to do things like publishing Services and Contracts.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close down the gateway link when it's no longer needed.
io.apiman.gateway.engine.beans.ServiceEndpoint	getServiceEndpoint(String organizationId, String serviceId, String version) Gets the service endpoint from the gateway.
io.apiman.gateway.engine.beans.SystemStatus	getStatus() Gets the current status of the gateway.
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(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

getStatus

io.apiman.gateway.engine.beans.SystemStatus getStatus()
                                                      throws GatewayAuthenticationException

Gets the current status of the gateway.

Throws:

GatewayAuthenticationException

publishService

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

Publishes a new Service.

Parameters:

service - the service being published

Throws:

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

GatewayAuthenticationException

retireService

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

Retires (removes) a Service from the registry.

Parameters:

service - the service to retire/remove

Throws:

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

GatewayAuthenticationException

registerApplication

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

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

GatewayAuthenticationException

unregisterApplication

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

Removes an Application from the registry.

Parameters:

application - the application to remove

Throws:

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

GatewayAuthenticationException

getServiceEndpoint

io.apiman.gateway.engine.beans.ServiceEndpoint getServiceEndpoint(String organizationId,
                                                                String serviceId,
                                                                String version)
                                                                  throws GatewayAuthenticationException

Gets the service endpoint from the gateway.

Parameters:

organizationId -

serviceId -

version -

Throws:

io.apiman.gateway.api.rest.contract.exceptions.NotAuthorizedException

GatewayAuthenticationException

close

void close()

Close down the gateway link when it's no longer needed.