org.wso2.apimgt.gateway.cli.rest

Interface RESTAPIService

All Known Implementing Classes:

RESTAPIServiceImpl

public interface RESTAPIService

Interface to communicate with Third party rest API for fetching APIs. As an example usage, Implementations of this interface will be used by import command to communicate with API Provider.

Method Summary

Modifier and Type	Method and Description
List<ExtendedAPI>	exportAPIs(String apiName, String apiVersion, String gatewayLabel, String accessToken, String projectName)
ExtendedAPI	getAPI(String apiName, String version, String accessToken) Gets the API specified by name and version.
List<ExtendedAPI>	getAPIs(String labelName, String accessToken) Get APIs of given label.
List<ApplicationThrottlePolicyDTO>	getApplicationPolicies(String accessToken) Get list of application.
List<ClientCertMetadataDTO>	getClientCertificates(String accessToken) Get list of client certificates.
List<SubscriptionThrottlePolicyDTO>	getSubscriptionPolicies(String accessToken) Get list of subsription policies.

Method Detail

getAPIs

List<ExtendedAPI> getAPIs(String labelName,
                          String accessToken)

Get APIs of given label.

Parameters:

labelName - label name

accessToken - access token

Returns:

list of APIs belong to the given label

getAPI

ExtendedAPI getAPI(String apiName,
                   String version,
                   String accessToken)

Gets the API specified by name and version.

Parameters:

apiName - Name of the API

version - Version of the API

accessToken - access token

Returns:

the API specified by name and version by calling the Publisher REST API

getApplicationPolicies

List<ApplicationThrottlePolicyDTO> getApplicationPolicies(String accessToken)

Get list of application.

Parameters:

accessToken - access token

Returns:

list of application policies

getSubscriptionPolicies

List<SubscriptionThrottlePolicyDTO> getSubscriptionPolicies(String accessToken)

Get list of subsription policies.

Parameters:

accessToken - access token

Returns:

list of subscription policies

getClientCertificates

List<ClientCertMetadataDTO> getClientCertificates(String accessToken)

Get list of client certificates.

Parameters:

accessToken - access token

Returns:

list of client certificates

exportAPIs

List<ExtendedAPI> exportAPIs(String apiName,
                             String apiVersion,
                             String gatewayLabel,
                             String accessToken,
                             String projectName)

Parameters:

apiName - Name of the API

apiVersion - Version of the API

gatewayLabel - Gateway label

accessToken - Access token for the API invocation

projectName - Name of the API project

Returns:

List of APIs belong to the given label