Package com.boomi.connector.api

Interface Summary

Interface	Description
AtomConfig	Atom configuration information which may be of use to a Connector.
AtomContext	Basic contextual information about the atom in which the connector is executing.
AtomProxyConfig	Atom proxy configuration information which may be of use to a developer.
BrowseContext	Contextual information about a connector browse request.
Browser	A Browser is used to query metadata about a service.
ConnectionTester	A Connection Tester is used to perform test connection for a given connector.
Connector	A Connector is the central class for controlling how the Atom interacts with some external service.
ConnectorContext	Contextual information about a Connector and any relevant connection properties.
DeleteRequest	Interface for accessing the request information for a DELETE request.
DynamicPropertyMap
ExtendedPayload	A ExtendedPayload allows to provide PayloadMetadata for the payload.
FilterData	Interface for tracked query filter data.
GetRequest	Interface for accessing the request information for a GET request.
JwtAssertionParameters
OAuth2Context	Interface to access OAuth 2.0 token configuration and to retrieve updated access tokens
OAuth2Token
ObjectData	TrackedData instance used by operations that accept input documents.
ObjectIdData	Interface for tracked object ids data.
Operation	An Operation is used to run an actual connector operation on a service.
OperationContext	Contextual information for a connector Operation execution.
OperationRequest	Common base interface for all operation requests.
OperationResponse	Interface for processing the results of an Operation execution.
Payload	A Payload encapsulates result data in some form.
PayloadMetadata	Metadata that can be attached to an ExtendedPayload.
PayloadMetadataFactory	Common factory API for creating payload metadata.
PersistedConnectorCache	Interface to set and retrieve the listeners persisted cache's properties
PrivateKeyStore	Base interface for java KeyStore wrapper object containing private key entry.
PropertyMap	Extension of a String -> Object map which provides some useful methods for retrieving values of specific types.
PublicKeyStore	Base interface for java KeyStore wrapper object containing public key entry.
QueryRequest	Interface for accessing the request information for a QUERY request.
TrackedData	Base interface for all data which is being tracked by the atom.
UpdateRequest	Interface for accessing the request information for a CREATE, UPDATE, UPSERT, or EXECUTE request.

Class Summary

Class	Description
BrowseUtil	Utility methods for browsing
Expression	Base type for an expression in a QueryFilter.
ExtraSchema	Optional additional XML Schema document which is included or imported by the primary XML Schema document.
ExtraSchemas	Optional additional XML Schema documents which are included or imported by the primary XML Schema document.
FieldSpecField	Indicates a field that should be listed as selectable, sortable, or filterable
GroupingExpression	Expression type which represents a grouping of other nested expressions joined by the given operator.
ObjectDefinition	The actual specification of the structure of an object type within the context of a Connector operation and object role.
ObjectDefinitions	A wrapper around a list of ObjectDefinition instances.
ObjectFactory	This object contains factory methods for each Java content interface and Java element interface generated in the com.boomi.connector.api package.
ObjectType	Basic information about an object which a Connector can manipulate in various ways.
ObjectTypes	A wrapper around a list of ObjectType instances.
OperationType.Config
QueryFilter	Specification for filter to a query operation.
RequestUtil	Utility methods for handling requests.
SimpleExpression	Expression type which represents a simple operator based expression on a property and some number of arguments.
Sort	Java class for Sort complex type.

Enum Summary

Enum	Description
ContentType	Content types.
GroupingOperator	Type of logical operators supported for GroupingExpressions.
ObjectDefinitionRole	Type of the role that the relevant definition plays in the operation.
OperationStatus
OperationType	Enumeration which defines the available Operations in the system (not all of which are necessarily supported by every connector implementation).

Exception Summary

Exception	Description
ConnectorException	Throwing a ConnectorException is a shortcut for indicating an OperationResponse for all outstanding inputs to an operation.
ContainerStoppingException	Connector exception used to indicate an action can not be completed because the container is stopping.