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

Class BallerinaOperation

java.lang.Object

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

All Implemented Interfaces:

BallerinaOpenAPIObject<BallerinaOperation,io.swagger.v3.oas.models.Operation>

public class BallerinaOperation
extends Object
implements BallerinaOpenAPIObject<BallerinaOperation,io.swagger.v3.oas.models.Operation>

Wraps the Operation from swagger models to provide iterable child models.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_TYPE_NONE
static String	X_AUTH_TYPE
static String	X_SCOPE
static String	X_THROTTLING_TIER

Constructor Summary

Constructors

Constructor and Description
BallerinaOperation()

Method Summary

Modifier and Type	Method and Description
BallerinaOperation	buildContext(io.swagger.v3.oas.models.Operation operation) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaOperation	buildContext(io.swagger.v3.oas.models.Operation operation, ExtendedAPI api) Build the Ballerina context model C for Open APIDetailedDTO definition/component in D.
BallerinaOperation	buildContextForNotAllowed(ExtendedAPI api) This method is used to generate a dummy service for 405 responses.
BallerinaOperation	buildContextForNotFound(ExtendedAPI api) This method is used to generate a dummy service for 404 responses.
List<String>	getAllMethods()
BallerinaOperation	getDefaultValue() Retrieve the default value for this type.
String	getDescription()
MgwEndpointConfigDTO	getEpConfigDTO()
io.swagger.v3.oas.models.ExternalDocumentation	getExternalDocs()
String	getOperationId()
List<BallerinaParameter>	getParameters()
List<BallerinaParameter>	getPathParameters()
BallerinaInterceptor	getReqInterceptorContext()
String	getRequestInterceptor()
BallerinaInterceptor	getResInterceptorContext()
String	getResourceTier()
String	getResponseInterceptor()
String	getScope()
String	getSummary()
List<String>	getTags()
boolean	isMethodNotAllowedOperation()
boolean	isMethodNotFoundOperation()
boolean	isSecured()
void	setExternalDocs(io.swagger.v3.oas.models.ExternalDocumentation externalDocs)
void	setMethodNotAllowedOperation(boolean methodNotAllowedOperation)
void	setMethodNotFoundOperation(boolean methodNotFoundOperation)
void	setOperationId(String operationId)
void	setReqInterceptorContext(BallerinaInterceptor reqInterceptorContext)
void	setRequestInterceptor(String requestInterceptor)
void	setResInterceptorContext(BallerinaInterceptor resInterceptorContext)
void	setResourceTier(String resourceTier)
void	setResponseInterceptor(String responseInterceptor)
void	setScope(String scope)
void	setSecured(boolean secured)

Methods inherited from class java.lang.Object

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

Field Detail

X_THROTTLING_TIER

public static final String X_THROTTLING_TIER

See Also:

Constant Field Values

X_SCOPE

public static final String X_SCOPE

See Also:

Constant Field Values

X_AUTH_TYPE

public static final String X_AUTH_TYPE

See Also:

Constant Field Values

AUTH_TYPE_NONE

public static final String AUTH_TYPE_NONE

See Also:

Constant Field Values

Constructor Detail

BallerinaOperation

public BallerinaOperation()

Method Detail

buildContext

public BallerinaOperation buildContext(io.swagger.v3.oas.models.Operation operation,
                                       ExtendedAPI api)
                                throws BallerinaServiceGenException,
                                       CLICompileTimeException,
                                       CLIRuntimeException

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<BallerinaOperation,io.swagger.v3.oas.models.Operation>

Parameters:

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

CLIRuntimeException

buildContext

public BallerinaOperation buildContext(io.swagger.v3.oas.models.Operation operation)
                                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<BallerinaOperation,io.swagger.v3.oas.models.Operation>

Parameters:

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

buildContextForNotAllowed

public BallerinaOperation buildContextForNotAllowed(ExtendedAPI api)
                                             throws BallerinaServiceGenException,
                                                    CLICompileTimeException

This method is used to generate a dummy service for 405 responses.

Parameters:

api - API from the definition

Returns:

Ballerina operation

Throws:

BallerinaServiceGenException

CLICompileTimeException

buildContextForNotFound

public BallerinaOperation buildContextForNotFound(ExtendedAPI api)
                                           throws BallerinaServiceGenException,
                                                  CLICompileTimeException

This method is used to generate a dummy service for 404 responses.

Parameters:

api - API from the definition

Returns:

Ballerina operation

Throws:

BallerinaServiceGenException

CLICompileTimeException

getDefaultValue

public BallerinaOperation getDefaultValue()

Description copied from interface: BallerinaOpenAPIObject

Retrieve the default value for this type.

Specified by:

getDefaultValue in interface BallerinaOpenAPIObject<BallerinaOperation,io.swagger.v3.oas.models.Operation>

Returns:

default values

getTags

public List<String> getTags()

getSummary

public String getSummary()

getDescription

public String getDescription()

getOperationId

public String getOperationId()

getParameters

public List<BallerinaParameter> getParameters()

getPathParameters

public List<BallerinaParameter> getPathParameters()

setOperationId

public void setOperationId(String operationId)

getAllMethods

public List<String> getAllMethods()

getExternalDocs

public io.swagger.v3.oas.models.ExternalDocumentation getExternalDocs()

setExternalDocs

public void setExternalDocs(io.swagger.v3.oas.models.ExternalDocumentation externalDocs)

getResourceTier

public String getResourceTier()

setResourceTier

public void setResourceTier(String resourceTier)

getScope

public String getScope()

setScope

public void setScope(String scope)

isSecured

public boolean isSecured()

setSecured

public void setSecured(boolean secured)

getEpConfigDTO

public MgwEndpointConfigDTO getEpConfigDTO()

getRequestInterceptor

public String getRequestInterceptor()

setRequestInterceptor

public void setRequestInterceptor(String requestInterceptor)

getResponseInterceptor

public String getResponseInterceptor()

setResponseInterceptor

public void setResponseInterceptor(String responseInterceptor)

getReqInterceptorContext

public BallerinaInterceptor getReqInterceptorContext()

setReqInterceptorContext

public void setReqInterceptorContext(BallerinaInterceptor reqInterceptorContext)

getResInterceptorContext

public BallerinaInterceptor getResInterceptorContext()

setResInterceptorContext

public void setResInterceptorContext(BallerinaInterceptor resInterceptorContext)

isMethodNotAllowedOperation

public boolean isMethodNotAllowedOperation()

setMethodNotAllowedOperation

public void setMethodNotAllowedOperation(boolean methodNotAllowedOperation)

isMethodNotFoundOperation

public boolean isMethodNotFoundOperation()

setMethodNotFoundOperation

public void setMethodNotFoundOperation(boolean methodNotFoundOperation)