io.apiman.manager.api.gateway.rest

Class RestGatewayLink

java.lang.Object

io.apiman.manager.api.gateway.rest.RestGatewayLink

All Implemented Interfaces:

IGatewayLink

public class RestGatewayLink
extends Object
implements IGatewayLink

An implementation of a Gateway Link that uses the Gateway's simple REST API to publish Services.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
RestGatewayLink(io.apiman.manager.api.beans.gateways.GatewayBean gateway) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close down the gateway link when it's no longer needed.
protected void	configureBasicAuth(org.apache.http.HttpRequest request) Configures BASIC authentication for the request.
protected GatewayClient	getClient()
io.apiman.manager.api.beans.gateways.RestGatewayConfigBean	getConfig()
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	setConfig(io.apiman.manager.api.beans.gateways.RestGatewayConfigBean config)
void	unregisterApplication(io.apiman.gateway.engine.beans.Application application) Removes an Application from the registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestGatewayLink

public RestGatewayLink(io.apiman.manager.api.beans.gateways.GatewayBean gateway)

Constructor.

Parameters:

gateway - the gateway

Method Detail

close

public void close()

Description copied from interface: IGatewayLink

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

Specified by:

close in interface IGatewayLink

See Also:

IGatewayLink.close()

getStatus

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

Description copied from interface: IGatewayLink

Gets the current status of the gateway.

Specified by:

getStatus in interface IGatewayLink

Returns:

the system status

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.getStatus()

getServiceEndpoint

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

Description copied from interface: IGatewayLink

Gets the service endpoint from the gateway.

Specified by:

getServiceEndpoint in interface IGatewayLink

Parameters:

organizationId - the org id

serviceId - the service id

version - the version

Returns:

the service endpoint

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.getServiceEndpoint(java.lang.String, java.lang.String, java.lang.String)

publishService

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

Description copied from interface: IGatewayLink

Publishes a new Service.

Specified by:

publishService in interface IGatewayLink

Parameters:

service - the service being published

Throws:

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

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

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

retireService

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

Description copied from interface: IGatewayLink

Retires (removes) a Service from the registry.

Specified by:

retireService in interface IGatewayLink

Parameters:

service - the service to retire/remove

Throws:

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

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.retireService(io.apiman.gateway.engine.beans.Service)

registerApplication

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

Description copied from interface: IGatewayLink

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

Specified by:

registerApplication in interface IGatewayLink

Parameters:

application - the application being registered

Throws:

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

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

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

unregisterApplication

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

Description copied from interface: IGatewayLink

Removes an Application from the registry.

Specified by:

unregisterApplication in interface IGatewayLink

Parameters:

application - the application to remove

Throws:

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

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.unregisterApplication(io.apiman.gateway.engine.beans.Application)

configureBasicAuth

protected void configureBasicAuth(org.apache.http.HttpRequest request)

Configures BASIC authentication for the request.

Parameters:

request -

getClient

protected GatewayClient getClient()

Returns:

the gateway client

getConfig

public io.apiman.manager.api.beans.gateways.RestGatewayConfigBean getConfig()

Returns:

the config

setConfig

public void setConfig(io.apiman.manager.api.beans.gateways.RestGatewayConfigBean config)

Parameters:

config - the config to set