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

Author:

eric.wittmann@redhat.com

Method Summary

Modifier and Type	Method	Description
void	close()	Close down the gateway link when it's no longer needed.
ApiEndpoint	getApiEndpoint(String organizationId, String apiId, String version)	Gets the api endpoint from the gateway.
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, 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	unregisterClient(Client client)	Removes an Client from the registry.

Method Detail

getStatus

SystemStatus getStatus()
                throws GatewayAuthenticationException

Gets the current status of the gateway.

Returns:

the system status

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

publishApi

void publishApi(Api api)
         throws PublishingException,
                GatewayAuthenticationException

Publishes a new Api.

Parameters:

api - the api being published

Throws:

PublishingException - when unable to publish api

GatewayAuthenticationException - when unable to authenticate with gateway

retireApi

void retireApi(Api api)
        throws PublishingException,
               GatewayAuthenticationException

Retires (removes) a Api from the registry.

Parameters:

api - the api to retire/remove

Throws:

PublishingException - when unable to retire api

GatewayAuthenticationException - when unable to authenticate with gateway

registerClient

void registerClient(Client client)
             throws RegistrationException,
                    GatewayAuthenticationException

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

Parameters:

client - the client being registered

Throws:

RegistrationException - when unable to register client

GatewayAuthenticationException - when unable to authenticate with gateway

PublishingException - when unable to publish client

unregisterClient

void unregisterClient(Client client)
               throws RegistrationException,
                      GatewayAuthenticationException

Removes an Client from the registry.

Parameters:

client - the client to remove

Throws:

RegistrationException - when unable to register

GatewayAuthenticationException - when unable to authenticate with gateway

getGatewayEndpoint

GatewayEndpoint getGatewayEndpoint()
                            throws GatewayAuthenticationException

Gets the gateway endpoint from the gateway

Returns:

the gateway endpoint

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

getApiEndpoint

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

Gets the api endpoint from the gateway.

Parameters:

organizationId - the org id

apiId - the api id

version - the version

Returns:

the api endpoint

Throws:

GatewayAuthenticationException - when unable to authenticate with gateway

NotAuthorizedException - when not authorized to perform action

close

void close()

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

probe

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

Throws:

RegistrationException

GatewayAuthenticationException