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

Class BallerinaPath

java.lang.Object

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

All Implemented Interfaces:

BallerinaOpenAPIObject<BallerinaPath,io.swagger.v3.oas.models.PathItem>

public class BallerinaPath
extends Object
implements BallerinaOpenAPIObject<BallerinaPath,io.swagger.v3.oas.models.PathItem>

Wraps the PathItem from swagger models to provide an iterable object model for operations.

Constructor Summary

Constructors

Constructor and Description
BallerinaPath()

Method Summary

Modifier and Type	Method and Description
BallerinaPath	buildContext(io.swagger.v3.oas.models.PathItem item) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaPath	buildContext(io.swagger.v3.oas.models.PathItem item, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaPath	buildContext(io.swagger.v3.oas.models.PathItem item, ExtendedAPI api, Boolean generateApiFaultResponses)
BallerinaPath	buildContextForNotFound(ExtendedAPI api)
BallerinaPath	getDefaultValue() Retrieve the default value for this type.
Set<Map.Entry<String,BallerinaOperation>>	getOperations()
boolean	isAddMethodNotFoundService()
boolean	isGenerateApiFaultResponses()
void	setAddMethodNotFoundService(boolean addMethodNotFoundService)
void	setGenerateApiFaultResponses(boolean generateApiFaultResponses)

Methods inherited from class java.lang.Object

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

Constructor Detail

BallerinaPath

public BallerinaPath()

Method Detail

buildContext

public BallerinaPath buildContext(io.swagger.v3.oas.models.PathItem item,
                                  ExtendedAPI api)
                           throws BallerinaServiceGenException,
                                  CLICompileTimeException

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<BallerinaPath,io.swagger.v3.oas.models.PathItem>

Parameters:

item - 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

CLICompileTimeException

buildContext

public BallerinaPath buildContext(io.swagger.v3.oas.models.PathItem item)
                           throws BallerinaServiceGenException,
                                  CLICompileTimeException

Description copied from interface: BallerinaOpenAPIObject

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

Specified by:

buildContext in interface BallerinaOpenAPIObject<BallerinaPath,io.swagger.v3.oas.models.PathItem>

Parameters:

item - Open Api definition or component

Returns:

parsed context model C of Open Api definition/component D

Throws:

BallerinaServiceGenException - on error when parsing the Open Api definition

CLICompileTimeException

buildContext

public BallerinaPath buildContext(io.swagger.v3.oas.models.PathItem item,
                                  ExtendedAPI api,
                                  Boolean generateApiFaultResponses)
                           throws BallerinaServiceGenException,
                                  CLICompileTimeException

Throws:

BallerinaServiceGenException

CLICompileTimeException

buildContextForNotFound

public BallerinaPath buildContextForNotFound(ExtendedAPI api)
                                      throws BallerinaServiceGenException,
                                             CLICompileTimeException

Throws:

BallerinaServiceGenException

CLICompileTimeException

getDefaultValue

public BallerinaPath getDefaultValue()

Description copied from interface: BallerinaOpenAPIObject

Retrieve the default value for this type.

Specified by:

getDefaultValue in interface BallerinaOpenAPIObject<BallerinaPath,io.swagger.v3.oas.models.PathItem>

Returns:

default values

getOperations

public Set<Map.Entry<String,BallerinaOperation>> getOperations()

isGenerateApiFaultResponses

public boolean isGenerateApiFaultResponses()

setGenerateApiFaultResponses

public void setGenerateApiFaultResponses(boolean generateApiFaultResponses)

isAddMethodNotFoundService

public boolean isAddMethodNotFoundService()

setAddMethodNotFoundService

public void setAddMethodNotFoundService(boolean addMethodNotFoundService)