com.boomi.connector.api

Interface Connector

All Known Subinterfaces:

ListenConnector<M>, NetworkAuthenticatorConnector

All Known Implementing Classes:

BaseConnector, BaseListenConnector, BootstrapConnector, BrowserlessListenConnector, ImportableFieldsConnector, OpenAPIConnector, OpenAPIDslConnector, RestConnector, SimpleListenConnector, SimplePollingConnector, SimpleUnmanagedListenConnector, UnmanagedListenConnector, WSConnector

public interface Connector

A Connector is the central class for controlling how the Atom interacts with some external service. The connector implementation must have a public, no-argument constructor.

Connector implementations must be thread-safe.

Method Summary

Modifier and Type	Method and Description
Browser	createBrowser(BrowseContext context) Returns a Browser for this connector.
Operation	createOperation(OperationContext context) Returns the actual Operation.
void	initialize(AtomContext context) Does any startup initialization for this connector.

Method Detail

initialize

void initialize(AtomContext context)

Does any startup initialization for this connector. This will be called exactly once (within external synchronization) after the Connector is instantiated and before any other methods are called on it.

This call may do expensive things like open connections or other resources which will be used throughout the Connector's lifecycle. Connectors are never explicitly closed, so explicit resource cleanup (if necessary) should be managed through garbage-collector hooks (e.g. reference objects or finalize). Note that any resources cached at the Connector level should not be account specific. The preferred resource cache is the one returned by a call to ConnectorContext.getConnectorCache() as it is Boomi account specific and therefore may be used to cache account specific information.

Parameters:

context - the static atom context

createBrowser

Browser createBrowser(BrowseContext context)

Returns a Browser for this connector. All connection fields from the connector's descriptor will be provided in ConnectorContext.getConnectionProperties() if the configuration is marked "requireConnectionForBrowse" and all operation fields marked "includeInBrowse will be provided in BrowseContext.getOperationProperties() (where the keys will be the relevant field's "id" and the values will be of the appropriate Java type for the relevant field's "type").

This call should be relatively cheap as Browsers are only ever created for a single invocation. Any resource caching should be handled at the Connector level or via the ConnectorContext.getConnectorCache().

Parameters:

context - the context for this browse operation. this context is considered to be owned by the Browser after this call and may be held by the Browser for use in subsequent method calls.

Returns:

a Browser for use when browsing this connector

createOperation

Operation createOperation(OperationContext context)

Returns the actual Operation. All connection fields from the connector's descriptor will be provided in ConnectorContext.getConnectionProperties() and operation all fields will be provided in BrowseContext.getOperationProperties() (where the keys will be the relevant field's "id" and the values will be of the appropriate Java type for the relevant field's "type").

This call should be relatively cheap as Operations are only ever created for a single invocation. Any resource caching should be handled at the Connector level or via the ConnectorContext.getConnectorCache().

Parameters:

context - the context for this connector operation. this context is considered to be owned by the Operation after this call and may be held by the Operation for use in subsequent method calls.

Returns:

an Operation for use when executing operations for this connector