Package 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 APIs.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor	Description
RestGatewayLink(GatewayBean gateway)	Constructor.

Method Summary

Modifier and Type	Method	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.
ApiEndpoint	getApiEndpoint(String organizationId, String apiId, String version)	Gets the api endpoint from the gateway.
protected GatewayClient	getClient()
RestGatewayConfigBean	getConfig()
GatewayEndpoint	getGatewayEndpoint()	Gets the gateway endpoint from the gateway
SystemStatus	getStatus()	Gets the current status of the gateway.
IPolicyProbeResponse	probe(String orgId, String apiId, String apiVersion, int idx)
IPolicyProbeResponse	probe(String orgId, String apiId, String apiVersion, int idx, String apiKey, String rawPayload)
void	publishApi(Api api)	Publishes a new Api.
void	registerClient(Client client)	Registers a new Client.
void	retireApi(Api api)	Retires (removes) a Api from the registry.
void	setConfig(RestGatewayConfigBean config)
void	unregisterClient(Client client)	Removes an Client 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(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 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()

getGatewayEndpoint

public GatewayEndpoint getGatewayEndpoint()
                                   throws GatewayAuthenticationException

Description copied from interface: IGatewayLink

Gets the gateway endpoint from the gateway

Specified by:

getGatewayEndpoint in interface IGatewayLink

Returns:

the gateway endpoint

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.getGatewayEndpoint()

getApiEndpoint

public ApiEndpoint getApiEndpoint(String organizationId,
                                  String apiId,
                                  String version)
                           throws GatewayAuthenticationException

Description copied from interface: IGatewayLink

Gets the api endpoint from the gateway.

Specified by:

getApiEndpoint in interface IGatewayLink

Parameters:

organizationId - the org id

apiId - the api id

version - the version

Returns:

the api endpoint

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

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

publishApi

public void publishApi(Api api)
                throws PublishingException,
                       GatewayAuthenticationException

Description copied from interface: IGatewayLink

Publishes a new Api.

Specified by:

publishApi in interface IGatewayLink

Parameters:

api - the api being published

Throws:

PublishingException - when unable to publish api

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.publishApi(io.apiman.gateway.engine.beans.Api)

retireApi

public void retireApi(Api api)
               throws PublishingException,
                      GatewayAuthenticationException

Description copied from interface: IGatewayLink

Retires (removes) a Api from the registry.

Specified by:

retireApi in interface IGatewayLink

Parameters:

api - the api to retire/remove

Throws:

PublishingException - when unable to retire api

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.retireApi(io.apiman.gateway.engine.beans.Api)

registerClient

public void registerClient(Client client)
                    throws RegistrationException,
                           GatewayAuthenticationException

Description copied from interface: IGatewayLink

Registers a new Client. An client is ultimately a collection of contracts to managed apis.

Specified by:

registerClient in interface IGatewayLink

Parameters:

client - the client being registered

Throws:

RegistrationException - when unable to register client

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.registerClient(io.apiman.gateway.engine.beans.Client)

unregisterClient

public void unregisterClient(Client client)
                      throws RegistrationException,
                             GatewayAuthenticationException

Description copied from interface: IGatewayLink

Removes an Client from the registry.

Specified by:

unregisterClient in interface IGatewayLink

Parameters:

client - the client to remove

Throws:

RegistrationException - when unable to register

GatewayAuthenticationException - when unable to authenticate with gateway

See Also:

IGatewayLink.unregisterClient(io.apiman.gateway.engine.beans.Client)

probe

public IPolicyProbeResponse probe(String orgId,
                                  String apiId,
                                  String apiVersion,
                                  int idx)
                           throws RegistrationException,
                                  GatewayAuthenticationException

Throws:

RegistrationException

GatewayAuthenticationException

probe

public IPolicyProbeResponse probe(String orgId,
                                  String apiId,
                                  String apiVersion,
                                  int idx,
                                  String apiKey,
                                  String rawPayload)
                           throws RegistrationException,
                                  GatewayAuthenticationException

Specified by:

probe in interface IGatewayLink

Throws:

RegistrationException

GatewayAuthenticationException

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 RestGatewayConfigBean getConfig()

Returns:

the config

setConfig

public void setConfig(RestGatewayConfigBean config)

Parameters:

config - the config to set