org.wso2.apimgt.gateway.cli.utils

Class MgwDefinitionBuilder

java.lang.Object

org.wso2.apimgt.gateway.cli.utils.MgwDefinitionBuilder

public class MgwDefinitionBuilder
extends Object

Represents the microgateway definitions file.

Implementation contains the methods required to build a valid definition object model from a definition file.

Constructor Summary

Constructors

Constructor and Description
MgwDefinitionBuilder()

Method Summary

Modifier and Type	Method and Description
static void	FindUnusedAPIInformation() To find out the api information which is not used for code generation but included in the definitions.yaml
static String	getApiRequestInterceptor(String basePath) Get the API-level request interceptor of an API.
static String	getApiResponseInterceptor(String basePath) Get the API-level response interceptor of an API.
static String	getBasePath(String apiName, String apiVersion) Get basePath from the definition.yaml.
static APICorsConfigurationDTO	getCorsConfiguration(String basePath)
static EndpointListRouteDTO	getProdEndpointList(String basePath)
static String	getRequestInterceptor(String basePath, String path, String operation) Get the request interceptor for a given resource in an API.
static MgwEndpointConfigDTO	getResourceEpConfigForCodegen(String basePath, String path, String operation)
static String	getResponseInterceptor(String basePath, String path, String operation) Get the response interceptor for a given resource in an API.
static EndpointListRouteDTO	getSandEndpointList(String basePath)
static String	getSecurity(String basePath)
static String	getThrottlePolicy(String basePath, String path, String operation)

Methods inherited from class java.lang.Object

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

Constructor Detail

MgwDefinitionBuilder

public MgwDefinitionBuilder()

Method Detail

getBasePath

public static String getBasePath(String apiName,
                                 String apiVersion)

Get basePath from the definition.yaml.

Parameters:

apiName - API name

apiVersion - API version

Returns:

basePath

getProdEndpointList

public static EndpointListRouteDTO getProdEndpointList(String basePath)

getSandEndpointList

public static EndpointListRouteDTO getSandEndpointList(String basePath)

getSecurity

public static String getSecurity(String basePath)

getCorsConfiguration

public static APICorsConfigurationDTO getCorsConfiguration(String basePath)

getResourceEpConfigForCodegen

public static MgwEndpointConfigDTO getResourceEpConfigForCodegen(String basePath,
                                                                 String path,
                                                                 String operation)

getRequestInterceptor

public static String getRequestInterceptor(String basePath,
                                           String path,
                                           String operation)

Get the request interceptor for a given resource in an API.

Parameters:

basePath - basePath of the API

path - path variable of the resource

operation - operation of the resource

Returns:

request interceptor of the resource if available, otherwise null.

getResponseInterceptor

public static String getResponseInterceptor(String basePath,
                                            String path,
                                            String operation)

Get the response interceptor for a given resource in an API.

Parameters:

basePath - basePath of the API

path - path variable of the resource

operation - operation of the resource

Returns:

response interceptor of the resource if available, otherwise null.

getThrottlePolicy

public static String getThrottlePolicy(String basePath,
                                       String path,
                                       String operation)

getApiRequestInterceptor

public static String getApiRequestInterceptor(String basePath)

Get the API-level request interceptor of an API.

Parameters:

basePath - basePath of the API

Returns:

API response request function name

getApiResponseInterceptor

public static String getApiResponseInterceptor(String basePath)

Get the API-level response interceptor of an API.

Parameters:

basePath - basePath of the API

Returns:

API response interceptor function name

FindUnusedAPIInformation

public static void FindUnusedAPIInformation()

To find out the api information which is not used for code generation but included in the definitions.yaml