com.boomi.connector.openapi.util

Class OpenAPISpecContext

java.lang.Object

com.boomi.connector.openapi.util.OpenAPISpecContext

public class OpenAPISpecContext
extends Object

This class is used to store the operation context generated from the given openapi spec.

Method Summary

Modifier and Type	Method and Description
List<BrowseField>	getBrowseFieldByType(OpenAPIParameterType parameterType) Retrieve specific ui fields by OpenAPIParameterType specific parameter types.
Map<OpenAPIParameterType,List<BrowseField>>	getBrowseFields() Retrieve all of the operation's ui fields for this spec's operation, this map is not mutable.
OpenAPIRequestCookie	getRequestCookie() Retrieve the imported operation's request cookie for this spec's operation execution.
OpenAPIResponseCookie	getResponseCookie() Retrieves the imported operation's response cookie for this spec's operation execution.
String	getSelectedRequestContentType() Return the request content type for this operation's request.
io.swagger.v3.oas.models.media.MediaType	getSelectedRequestMedia() Returns the media type definition of the request.
String	getSelectedResponseContentType() Returns the response content type for this operation's response.
io.swagger.v3.oas.models.media.MediaType	getSelectedResponseMedia() Returns the media type definition of the response.

Methods inherited from class java.lang.Object

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

Method Detail

getRequestCookie

public OpenAPIRequestCookie getRequestCookie()

Retrieve the imported operation's request cookie for this spec's operation execution.

Returns:

the OpenAPIRequestCookie

getResponseCookie

public OpenAPIResponseCookie getResponseCookie()

Retrieves the imported operation's response cookie for this spec's operation execution.

Returns:

the OpenAPIResponseCookie

getSelectedRequestContentType

public String getSelectedRequestContentType()

Return the request content type for this operation's request. If this is null, the request body is not necessary.

Returns:

the request content type

getSelectedResponseContentType

public String getSelectedResponseContentType()

Returns the response content type for this operation's response. If this is null, the response body is not necessary

Returns:

the response content type

getSelectedRequestMedia

public io.swagger.v3.oas.models.media.MediaType getSelectedRequestMedia()

Returns the media type definition of the request. If this is null, then the request body is not necessary.

Returns:

the request MediaType

getSelectedResponseMedia

public io.swagger.v3.oas.models.media.MediaType getSelectedResponseMedia()

Returns the media type definition of the response. If this is null, then the request body is not necessary.

Returns:

the response MediaType

getBrowseFields

public Map<OpenAPIParameterType,List<BrowseField>> getBrowseFields()

Retrieve all of the operation's ui fields for this spec's operation, this map is not mutable.

Returns:

Map of Parameter Type to Browse Fields

getBrowseFieldByType

public List<BrowseField> getBrowseFieldByType(OpenAPIParameterType parameterType)

Retrieve specific ui fields by OpenAPIParameterType specific parameter types. this list is not mutable.

Parameters:

parameterType - the parameter type

Returns:

List of Browse Fields