com.mulesoft.mule.runtime.gw.client

Class ApiPlatformClient

java.lang.Object

com.mulesoft.mule.runtime.gw.client.ApiPlatformClient

public class ApiPlatformClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiPlatformClient.RestClientStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	GATEWAY_API_BASE_RESOURCE
static String	PROXIES_API_BASE_RESOURCE

Constructor Summary

Constructors

Constructor and Description
ApiPlatformClient()

Method Summary

Modifier and Type	Method and Description
PlatformResponse<Void>	activateEndpoint(String organizationId, String environmentId, Long apiId) Marks a specific API as active in API Manager, using endpoint .
void	cleanConnections()
void	configure(com.mulesoft.mule.runtime.gw.api.config.GatewayConfiguration gatewayConfiguration)
void	connect() Performs an initial connect where configured runtime credentials and general control plane configuration can be validated.
InputStream	downloadTemplateAsset(String link) Downloads a policy template asset from the specified link.
PlatformResponse<ApiResponse>	getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, String apiEntityTag) Retrieves the API details of a specific API, including applied policies, identity management, associated SLAs and metadata of the API from API Manager, using endpoint .
PlatformResponse<ApiClientsResponse>	getApiClients(String organizationId, String environmentId, Long apiId, String contractsEntityTag) Retrieves Contracts from CCS for a particular API, using endpoint .
PlatformResponse<LegacyCoreServicesClientDto>	getClient(String id) Retrieves a Client Application from Auth Service using the id as key, using endpoint .
PlatformResponse<CoreServicesClientDto>	getClient(String id, String secret) Validates a Client Application against Auth Service using its credentials.
PolicyTemplateDto	getPolicyTemplateMetadata(com.mulesoft.mule.runtime.gw.api.policy.PolicyTemplateKey templateKey) Retrieves download URLs of a specific policy template, using API Manager's endpoint Authorization token injected is API Manager's.
String	getRootOrgId()
boolean	isConnected()
int	postHttpEvents(List<com.mulesoft.mule.runtime.gw.api.analytics.AnalyticsHttpEvent> events) Pushes API Analytics events to Anypoint Platform, using endpoint .
int	postMetrics(String eventsBody) Pushes internal metrics, as a set of events, to Anypoint Platform.
void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

GATEWAY_API_BASE_RESOURCE

public static final String GATEWAY_API_BASE_RESOURCE

See Also:

Constant Field Values

PROXIES_API_BASE_RESOURCE

public static final String PROXIES_API_BASE_RESOURCE

See Also:

Constant Field Values

Constructor Detail

ApiPlatformClient

public ApiPlatformClient()

Method Detail

configure

public void configure(com.mulesoft.mule.runtime.gw.api.config.GatewayConfiguration gatewayConfiguration)
               throws URISyntaxException

Throws:

URISyntaxException

cleanConnections

public void cleanConnections()

getApiClients

public PlatformResponse<ApiClientsResponse> getApiClients(String organizationId,
                                                          String environmentId,
                                                          Long apiId,
                                                          String contractsEntityTag)

Retrieves Contracts from CCS for a particular API, using endpoint . Supports a 304 response indicating that there were no changes from the last time
Authorization token injected is API Manager's.

Parameters:

organizationId - organization where the API lives, can be a sub-org

environmentId - environment where the API lives

apiId - API owning the contracts

contractsEntityTag - contracts ETag that the service uses to detect if a NOT_MODIFIED response can be returned

Returns:

a PlatformResponse containing a ApiClientsResponse with the list of downloaded contracts if the status code is 200 or an empty response if the status code was 304

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status is not 200 nor 304

HttpConnectionException - if any connection issue arises while executing the request

EntityUnparsingException - if the response's body can not be parsed

activateEndpoint

public PlatformResponse<Void> activateEndpoint(String organizationId,
                                               String environmentId,
                                               Long apiId)

Marks a specific API as active in API Manager, using endpoint .
Authorization token injected is API Manager's.

Parameters:

organizationId - organization where the API lives, can be a sub-org

environmentId - environment where the API lives

apiId - API to mark as active

Returns:

a PlatformResponse without an entity

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status is not 201

HttpConnectionException - if any connection issue arises while executing the request

getApi

public PlatformResponse<ApiResponse> getApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                                            String apiEntityTag)

Retrieves the API details of a specific API, including applied policies, identity management, associated SLAs and metadata of the API from API Manager, using endpoint . Supports a 304 response indicating that there were no changes from the last time.
Identity management data is not exposed in the ApiResponse but rather injected in each of the applied policies that require it
Authorization token injected is API Manager's.

Parameters:

apiKey - API to which retrieve details from

apiEntityTag - API ETag that the service uses to detect if a NOT_MODIFIED response can be returned

Returns:

a PlatformResponse containing a ApiClientsResponse with the list of downloaded contracts if the status code is 200 or an empty response if the status code was 304

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is not 200 nor 304

HttpConnectionException - if any connection issue arises while executing the request

EntityUnparsingException - if the response's body can not be parsed

postHttpEvents

public int postHttpEvents(List<com.mulesoft.mule.runtime.gw.api.analytics.AnalyticsHttpEvent> events)
                   throws IOException

Pushes API Analytics events to Anypoint Platform, using endpoint . The events are parsed into JSON and gzipped before pushing them.
Authorization token injected is Access Management's.

Parameters:

events - the list of events to push

Returns:

the status code of the response

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

IOException - if any connection issue arises while executing the request

EntityParsingException - if the events to push can not be parsed

postMetrics

public int postMetrics(String eventsBody)
                throws IOException

Pushes internal metrics, as a set of events, to Anypoint Platform.
The request is NOT authenticated.

Parameters:

eventsBody - the JSON containing every internal metrics event that the runtime gathered

Returns:

the status code of the response

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

IOException - if any connection issue arises while executing the request

connect

public void connect()

Performs an initial connect where configured runtime credentials and general control plane configuration can be validated.
As part of the connection, the root organization ID is retrieved from the authentication against API Manager or from me() when the other method does not contain it.
For the corner case where an owner-less organization is being used with an API Manager which does not return the root org id, an error is thrown.

Throws:

NotFoundException - if the me() response's status code is 404

HttpResponseException - if the me() response's status code is 4xx or 5xx

HttpConnectionException - if any connection issue arises while executing the me() request

EntityUnparsingException - if the me() response's body can not be parsed

RuntimeException - when root org id can not be retrieved from either source

getPolicyTemplateMetadata

public PolicyTemplateDto getPolicyTemplateMetadata(com.mulesoft.mule.runtime.gw.api.policy.PolicyTemplateKey templateKey)

Retrieves download URLs of a specific policy template, using API Manager's endpoint
Authorization token injected is API Manager's.

Parameters:

templateKey - the GAV of the policy template

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

HttpConnectionException - if any connection issue arises while executing the request

EntityUnparsingException - if the response's body can not be parsed

downloadTemplateAsset

public InputStream downloadTemplateAsset(String link)
                                  throws IOException

Downloads a policy template asset from the specified link.
Request is not authentication, since the links are signed and expire after some time.

Parameters:

link - the link of the asset

Returns:

a stream containing the policy template asset content

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

IOException - if any connection issue arises while executing the request

getClient

public PlatformResponse<LegacyCoreServicesClientDto> getClient(String id)

Retrieves a Client Application from Auth Service using the id as key, using endpoint .
Authorization token injected is Access Management's.
Note: This endpoint is deprecated and should not be used.

Parameters:

id - id of the Client App to retrieve

Returns:

a PlatformResponse containing a LegacyCoreServicesClientDto which has the data, including the sensitive, of the Client App, like secret, name, etc.

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

HttpConnectionException - if any connection issue arises while executing the request

EntityUnparsingException - if the response's body can not be parsed

getClient

public PlatformResponse<CoreServicesClientDto> getClient(String id,
                                                         String secret)

Validates a Client Application against Auth Service using its credentials. The endpoint is .
Authorization token injected is Access Management's.

Parameters:

id - id of the Client App to retrieve

Returns:

a PlatformResponse containing a CoreServicesClientDto which has only the non-sensitive data of the Client App.

Throws:

NotFoundException - if the response's status code is 404

HttpResponseException - if the response's status code is 4xx or 5xx

HttpConnectionException - if any connection issue arises while executing the request

EntityUnparsingException - if the response's body can not be parsed

getRootOrgId

public String getRootOrgId()

Returns:

the root organization id of the credential's used to start the runtime, which is calculated when the runtime connects to the Anypoint Platform. It will be null if there is a problem with the runtime configuration or with the connection to the Anypoint Platform.

isConnected

public boolean isConnected()

Returns:

whether the runtime successfully connected to the Anypoint Platform.

shutdown

public void shutdown()