com.boomi.connector.api

Interface Browser

All Known Subinterfaces:

ConnectionTester

All Known Implementing Classes:

BaseBrowser, ImportableFieldsBrowser, OpenAPIBrowser, OpenAPIDslBrowser, OverridableFieldBrowser, WSBrowser

public interface Browser

A Browser is used to query metadata about a service. The execution of any of the browsing methods should not modify any data within the service.

Browser implementations need not be thread-safe. However, multiple instances may be in use simultaneously within the same Atom, so any static data should be managed in a thread-safe manner.

Method Summary

Modifier and Type	Method and Description
ObjectDefinitions	getObjectDefinitions(String objectTypeId, Collection<ObjectDefinitionRole> roles) Returns the object definitions for the given object type id and currently configured OperationType (as defined by the BrowseContext).
ObjectTypes	getObjectTypes() Returns the object types which can be utilized by the currently configured OperationType (as defined by the BrowseContext).

Method Detail

getObjectTypes

ObjectTypes getObjectTypes()

Returns the object types which can be utilized by the currently configured OperationType (as defined by the BrowseContext).

Returns:

the available object types (should not be more than AtomConfig.getMaxNumberObjectTypes())

getObjectDefinitions

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

Returns the object definitions for the given object type id and currently configured OperationType (as defined by the BrowseContext).

The returned collection of definitions must correspond to the given collection of roles (the definitions must be in the same order as the roles). There must be a definition for each "required" role for a given OperationType. There may be a definition for any "supported" role for a given OperationType.

Note, the DELETE operation is handled uniquely. By default, this method is not invoked for DELETE operations. However, if the connector has specified an "sdkApiVersion" of "1.0.15" or greater in the connector config file, this method will be invoked. In this situation, the connector implementation may set a cookie for the INPUT definition, but any schema will be ignored. Also, the connector implementation may return an OUTPUT definition.

Parameters:

objectTypeId - the id of the relevant object type chosen from the list returned from a previous call to getObjectTypes()

roles - the roles corresponding to the profiles requested

Returns:

the profile definitions for the object of the given type for the relevant operation