com.boomi.connector.openapi

Class OpenAPIRequestCookie

java.lang.Object

com.boomi.connector.openapi.OpenAPIRequestCookie

public class OpenAPIRequestCookie
extends Object

Used to store operation details based off of the Http Method and Chosen Operation path. This cookie will be used so that the in memory API will not need to be reloaded.

Constructor Summary

Constructors

Constructor and Description
OpenAPIRequestCookie()
OpenAPIRequestCookie(String jsonCookie)

Method Summary

Modifier and Type	Method and Description
List<OpenAPIParameter>	getHeaderParameters() Fetches header parameters identified as "in": "header" from OpenAPIRequestCookie.
List<OpenAPIParameter>	getPathParameters() Fetches path parameters identified as "in": "path" from OpenAPIRequestCookie.
List<OpenAPIParameter>	getQueryParameters() Fetches query parameters identified as "in": "query" from OpenAPIRequestCookie.
String	getRequestContentType() Fetches the content type associated with this operation.
String	getRootSchemaType() Gets the root schema type for the request.
boolean	isRequestBodyRequired() Fetches value of "required" attribute from request body stored in OpenAPIRequestCookie during browse operation.
void	setHeaderParameters(List<OpenAPIParameter> headerParameters)
void	setPathParameters(List<OpenAPIParameter> pathParameters)
void	setQueryParameters(List<OpenAPIParameter> queryParameters)
void	setRequestBodyRequired(boolean requestBodyRequired)
void	setRequestContentType(String requestContentType)
void	setRootSchemaType(String rootSchemaType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIRequestCookie

public OpenAPIRequestCookie()

OpenAPIRequestCookie

public OpenAPIRequestCookie(String jsonCookie)
                     throws JsonProcessingException

Throws:

JsonProcessingException

Method Detail

getHeaderParameters

public List<OpenAPIParameter> getHeaderParameters()

Fetches header parameters identified as "in": "header" from OpenAPIRequestCookie. These parameters are stored during browse operation.

Returns:

the header OpenApiParameter List

setHeaderParameters

public void setHeaderParameters(List<OpenAPIParameter> headerParameters)

getQueryParameters

public List<OpenAPIParameter> getQueryParameters()

Fetches query parameters identified as "in": "query" from OpenAPIRequestCookie. These parameters are stored during browse operation.

Returns:

the query OpenApiParameter List

setQueryParameters

public void setQueryParameters(List<OpenAPIParameter> queryParameters)

getPathParameters

public List<OpenAPIParameter> getPathParameters()

Fetches path parameters identified as "in": "path" from OpenAPIRequestCookie. These parameters are stored during browse operation.

Returns:

the path OpenApiParameter List

setPathParameters

public void setPathParameters(List<OpenAPIParameter> pathParameters)

isRequestBodyRequired

public boolean isRequestBodyRequired()

Fetches value of "required" attribute from request body stored in OpenAPIRequestCookie during browse operation.

Returns:

true if the RequestBody is required, false otherwise

setRequestBodyRequired

public void setRequestBodyRequired(boolean requestBodyRequired)

getRequestContentType

public String getRequestContentType()

Fetches the content type associated with this operation. At the moment, this will always select the first content type available in a set of multiple content types.

Returns:

the requestContentType

setRequestContentType

public void setRequestContentType(String requestContentType)

getRootSchemaType

public String getRootSchemaType()

Gets the root schema type for the request. In OpenAPI, this can be structured as object or array. It can also be a primitive data type such as a number or a string.

Returns:

the root level schema type

setRootSchemaType

public void setRootSchemaType(String rootSchemaType)

toString

public String toString()

Overrides:

toString in class Object