com.boomi.connector.openapi

Class OpenAPIConnection<C extends BrowseContext>

java.lang.Object

com.boomi.connector.util.BaseConnection<C>

com.boomi.common.rest.RestConnection<C>

com.boomi.connector.openapi.OpenAPIConnection<C>

Direct Known Subclasses:

OpenAPIDslConnection

public class OpenAPIConnection<C extends BrowseContext>
extends RestConnection<C>

Field Summary

Fields inherited from class com.boomi.common.rest.RestConnection

DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OpenAPIConnection(C context)

Method Summary

Modifier and Type	Method and Description
protected io.swagger.v3.oas.models.OpenAPI	getApi()
ObjectDefinitions	getObjectDefinitions(String path, Collection<ObjectDefinitionRole> roles) Generates the Input / Output Object definition based off of the OpenAPI Spec.
List<ObjectType>	getObjectTypes() Returns a list of Object Types.
protected OpenAPIParseOption	getOpenAPIParseOption() Return OpenAPIParseOption which contains information on how you want to parse your openapi spec.
protected io.swagger.v3.oas.models.Operation	getOperation(String path) Fetch the Operation based off of the path value and the selected BrowseContext.getCustomOperationType()
String	getSpec() Get the location of the target OpenAPI Specification.

Methods inherited from class com.boomi.common.rest.RestConnection

getAPIAuthenticationType, getAuthenticationType, getAWSAccessKey, getAWSRegion, getAWSSecretKey, getAWSService, getConnectionProperty, getConnectTimeout, getCookieScope, getCustomAuthCredentials, getDomain, getHttpMethod, getOAuthContext, getPassword, getPreemptive, getPrivateKeyStore, getPublicKeyStore, getReadTimeout, getUrl, getUsername, getWorkstation, isConnectionPoolingEnabled

Methods inherited from class com.boomi.connector.util.BaseConnection

generateConnectionInfo, generateConnectionInfo, getConnector, getContext, getOperationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIConnection

public OpenAPIConnection(C context)

Method Detail

getOperation

protected io.swagger.v3.oas.models.Operation getOperation(String path)

Fetch the Operation based off of the path value and the selected BrowseContext.getCustomOperationType()

Parameters:

path - the selected Path

Returns:

the Operation

getObjectTypes

public List<ObjectType> getObjectTypes()

Returns a list of Object Types. If the spec provides an optional "operationId" then that will be used as the label, otherwise the path is used.

Returns:

the ObjectType List

getObjectDefinitions

public ObjectDefinitions getObjectDefinitions(String path,
                                              Collection<ObjectDefinitionRole> roles)

Generates the Input / Output Object definition based off of the OpenAPI Spec. This will also store a OpenAPIRequestCookie for Operation execution. This will also create BrowseField to fetch parameter details on the operation UI

Parameters:

path - selected operation path

roles - Operation input / output roles

Returns:

the ObjectDefinitions

getApi

protected io.swagger.v3.oas.models.OpenAPI getApi()

getSpec

public String getSpec()

Get the location of the target OpenAPI Specification.

Returns:

the Spec

getOpenAPIParseOption

protected OpenAPIParseOption getOpenAPIParseOption()

Return OpenAPIParseOption which contains information on how you want to parse your openapi spec.

Returns:

the OpenAPI Parse Option;