org.wso2.apimgt.gateway.cli.model.template.service

Class BallerinaService

java.lang.Object

org.wso2.apimgt.gateway.cli.model.template.service.BallerinaService

All Implemented Interfaces:

BallerinaOpenAPIObject<BallerinaService,io.swagger.v3.oas.models.OpenAPI>

public class BallerinaService
extends Object
implements BallerinaOpenAPIObject<BallerinaService,io.swagger.v3.oas.models.OpenAPI>

Wrapper for OpenAPI.

Parsing OpenAPI object model from the mustache/handlebars templates makes the template logic complex. These Ballerina... classes helps the process by wrapping all required attributes into a easily parsable object model.

This class can be used to push additional context variables for handlebars

Constructor Summary

Constructors

Constructor and Description
BallerinaService()

Method Summary

Modifier and Type	Method and Description
void	addMethodNotFoundPath(io.swagger.v3.oas.models.OpenAPI openAPI) Add the /* service path resource for the existing API if it is currently not available when the apiFaultResponses is enabled.
BallerinaService	buildContext(io.swagger.v3.oas.models.OpenAPI openAPI) Build a BallerinaService object from a OpenAPI object.
BallerinaService	buildContext(io.swagger.v3.oas.models.OpenAPI definition, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
ExtendedAPI	getApi()
String	getBasepath()
Config	getConfig()
ContainerConfig	getContainerConfig()
BallerinaService	getDefaultValue() Retrieve the default value for this type.
MgwEndpointConfigDTO	getEndpointConfig()
io.swagger.v3.oas.models.info.Info	getInfo()
HashMap<String,String>	getLibVersions() Returns the map which contains the interceptor module name with organization and the module version.
String	getModelPackage()
String	getName()
Set<Map.Entry<String,BallerinaPath>>	getPaths()
String	getProjectName()
String	getQualifiedServiceName()
String	getRequestInterceptor()
String	getResponseInterceptor()
String	getSrcPackage()
List<io.swagger.v3.oas.models.tags.Tag>	getTags()
boolean	isAddMethodNotFoundService()
boolean	isGenerateApiFaultResponses()
BallerinaService	modelPackage(String modelPackage)
void	setAddMethodNotFoundService(boolean addMethodNotFoundService)
void	setApi(ExtendedAPI api)
void	setBasepath(String basepath)
void	setConfig(Config config)
void	setContainerConfig(ContainerConfig containerConfig)
void	setEndpointConfig(MgwEndpointConfigDTO endpointConfig)
void	setGenerateApiFaultResponses(boolean generateApiFaultResponses)
void	setHasEpSecurity(MgwEndpointConfigDTO endpointConfig)
void	setName(String name)
void	setProjectName(String projectName)
void	setQualifiedServiceName(String qualifiedServiceName)
void	setRequestInterceptor(String requestInterceptor)
void	setResponseCache(Map<String,Object> exts)
void	setResponseInterceptor(String responseInterceptor)
BallerinaService	srcPackage(String srcPackage)

Methods inherited from class java.lang.Object

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

Constructor Detail

BallerinaService

public BallerinaService()

Method Detail

buildContext

public BallerinaService buildContext(io.swagger.v3.oas.models.OpenAPI openAPI)

Build a BallerinaService object from a OpenAPI object. All non iterable objects using handlebars library is converted into supported iterable object types.

Specified by:

buildContext in interface BallerinaOpenAPIObject<BallerinaService,io.swagger.v3.oas.models.OpenAPI>

Parameters:

openAPI - OpenAPI type object to be converted

Returns:

Converted BallerinaService object

buildContext

public BallerinaService buildContext(io.swagger.v3.oas.models.OpenAPI definition,
                                     ExtendedAPI api)
                              throws BallerinaServiceGenException

Description copied from interface: BallerinaOpenAPIObject

Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.

OpenAPI definition openApi can be used to access the parent context helpful for building the current context

Specified by:

buildContext in interface BallerinaOpenAPIObject<BallerinaService,io.swagger.v3.oas.models.OpenAPI>

Parameters:

definition - Swagger Api definition or component

api - openApi object model

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

getDefaultValue

public BallerinaService getDefaultValue()

Description copied from interface: BallerinaOpenAPIObject

Retrieve the default value for this type.

Specified by:

getDefaultValue in interface BallerinaOpenAPIObject<BallerinaService,io.swagger.v3.oas.models.OpenAPI>

Returns:

default values

srcPackage

public BallerinaService srcPackage(String srcPackage)

modelPackage

public BallerinaService modelPackage(String modelPackage)

getSrcPackage

public String getSrcPackage()

getModelPackage

public String getModelPackage()

getInfo

public io.swagger.v3.oas.models.info.Info getInfo()

getTags

public List<io.swagger.v3.oas.models.tags.Tag> getTags()

getLibVersions

public HashMap<String,String> getLibVersions()

Returns the map which contains the interceptor module name with organization and the module version.

Returns:

HashMap object

getPaths

public Set<Map.Entry<String,BallerinaPath>> getPaths()

getName

public String getName()

setName

public void setName(String name)

getEndpointConfig

public MgwEndpointConfigDTO getEndpointConfig()

setEndpointConfig

public void setEndpointConfig(MgwEndpointConfigDTO endpointConfig)

getApi

public ExtendedAPI getApi()

setApi

public void setApi(ExtendedAPI api)

getQualifiedServiceName

public String getQualifiedServiceName()

setQualifiedServiceName

public void setQualifiedServiceName(String qualifiedServiceName)

getContainerConfig

public ContainerConfig getContainerConfig()

setContainerConfig

public void setContainerConfig(ContainerConfig containerConfig)

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

getBasepath

public String getBasepath()

setBasepath

public void setBasepath(String basepath)

getProjectName

public String getProjectName()

setProjectName

public void setProjectName(String projectName)

setHasEpSecurity

public void setHasEpSecurity(MgwEndpointConfigDTO endpointConfig)

setResponseCache

public void setResponseCache(Map<String,Object> exts)

isGenerateApiFaultResponses

public boolean isGenerateApiFaultResponses()

setGenerateApiFaultResponses

public void setGenerateApiFaultResponses(boolean generateApiFaultResponses)

isAddMethodNotFoundService

public boolean isAddMethodNotFoundService()

setAddMethodNotFoundService

public void setAddMethodNotFoundService(boolean addMethodNotFoundService)

addMethodNotFoundPath

public void addMethodNotFoundPath(io.swagger.v3.oas.models.OpenAPI openAPI)

Add the /* service path resource for the existing API if it is currently not available when the apiFaultResponses is enabled.

Parameters:

openAPI - api definition

getRequestInterceptor

public String getRequestInterceptor()

setRequestInterceptor

public void setRequestInterceptor(String requestInterceptor)

getResponseInterceptor

public String getResponseInterceptor()

setResponseInterceptor

public void setResponseInterceptor(String responseInterceptor)