com.boomi.connector.openapi

Class OpenAPIBrowser

java.lang.Object

com.boomi.connector.util.BaseBrowser

com.boomi.connector.openapi.OpenAPIBrowser

All Implemented Interfaces:

Browser

Direct Known Subclasses:

OpenAPIDslBrowser

public class OpenAPIBrowser
extends BaseBrowser

Constructor Summary

Constructors

Constructor and Description
OpenAPIBrowser(OpenAPIConnection<? extends BrowseContext> connection)

Method Summary

Modifier and Type	Method and Description
OpenAPIConnection<? extends BrowseContext>	getConnection() Returns the base connection that was either provided or created when this instance was created.
ObjectDefinitions	getObjectDefinitions(String objectTypeId, Collection<ObjectDefinitionRole> roles) Generates the Input / Output Object Definition based off of the Path (objectTypeId) and the selected BrowseContext.getCustomOperationType().
ObjectTypes	getObjectTypes() Creates an ObjectTypes with a list of ObjectType which will contain all the Paths that contain the selected BrowseContext.getCustomOperationType() If the spec provides an optional "operationId" then that will be used as the label, otherwise the path is used as both ID and Label.

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

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIBrowser

public OpenAPIBrowser(OpenAPIConnection<? extends BrowseContext> connection)

Method Detail

getObjectTypes

public ObjectTypes getObjectTypes()

Creates an ObjectTypes with a list of ObjectType which will contain all the Paths that contain the selected BrowseContext.getCustomOperationType() If the spec provides an optional "operationId" then that will be used as the label, otherwise the path is used as both ID and Label.

Returns:

the ObjectTypes

getObjectDefinitions

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

Generates the Input / Output Object Definition based off of the Path (objectTypeId) and the selected BrowseContext.getCustomOperationType(). This will also include OpenAPIRequestCookie and BrowseField for operation parameters

Parameters:

objectTypeId - the selected ObjectType's ID

roles - Roles for Operation

Returns:

the ObjectDefinitions

getConnection

public OpenAPIConnection<? extends BrowseContext> getConnection()

Description copied from class: BaseBrowser

Returns the base connection that was either provided or created when this instance was created.

Overrides:

getConnection in class BaseBrowser

Returns:

the base connection