Waiting for engine...
Skip to main content

Connector SDK

The page has the Connector SDK versions listed from v2.14.8.

Version 2.14.8​

Fix
We fixed these issues
  • Previously composed schemas with multiple subschemas would check for recursive depth on each subschema. With this change, the composed schema recursion is calculated as a group rather than an individual schema. (CON-7419)

Version 2.14.7​

New
We added these features
  • The OpenAPI (Tech Preview) connector has been updated to support OAuth JWT Bearer Token and NTLM authentication.
Fix
We fixed these issues
  • Fixed a defect introduced in version 2.14.6 that prevented packaged OpenAPI specifications from being loaded.

Version 2.14.6​

New
We added these features
  • The SDK has been updated to use a new, more secure version of common-apache-http (0.8).
  • Added a default implementation for BaseConnector.createBrowser so that connectors that don't support browse do not need to provide one.
  • The OpenAPI core libraries have been updated:
    • Enhanced browse functionality for rendering shared response components from OpenAPI schemas.
    • Allows all outgoing requests to have the Accept Header set to use the content type defined in the response cookie. This will allow responses to be returned with the content type specified, if supported by the endpoint.
    • Updated so that OpenAPI connections can use any context that extends BrowseContext
    • Supports the access of a local OpenAPI file specification.
    • Supports a request that contains an array of objects and will return a split JSON response only when the request is successful.
    • Supports the loading of shared components for a request profile.
    • Supports the import of schema objects if the selected schema's sub-value is a primitive/simple data type, such as string, integer, number, or boolean.
    • The REST descriptor has been updated to add Connection Timeout and Read Timeout fields in the connection to set Read and Connect timeouts.
    • The REST core libraries have been updated to set the Connect and Read timeouts configured in the REST descriptor.

Version 2.14.5​

New
We added these features
  • BasePollingOperation class now has the ability to override getSubmitOptions() to provide your own SubmitOption mode when running listen operations.
  • BaseWatchableOperation has the ability to override getFilterFunction() to provide a filter for watchable events. By default, all events are accepted.

Version 2.14.4​

Fix
We fixed these issues
  • The SDK has been updated to use a newer, more secure version of Jackson (2.13.4).

Version 2.14.3​

Fix
We fixed these issues
  • The SDK test utilities have been upgraded to use a newer version 20180130 of org.json from version 20131018.

Version 2.14.2​

Fix
We fixed these issues
  • Removed hardcoded dependencies in gradle plugin
  • Added jackson dependency to samples project
  • Upgraded gradle version to 7.5.1

Version 2.14.0​

Fix
We fixed these issues
  • The boomi-json-util libraries have been upgraded to version 1.2.1 to resolve jackson vulnerabilities.

Version 2.13.6​

Fix
We fixed these issues

The REST core libraries have been updated:

  • With the introduction of Connection Pooling, SSL certificates were not being honored when making a request to a server if connection pooling was disabled. With this fix, SSL certificates are used for both connection pooling and non-pooled requests.

Version 2.13.5​

New
We added these features
  • The OpenAPI core libraries have been updated to load ranged success schemas (2XX). The order of schema loading is as follows:
    • First, explicit successful HTTP statuses are loaded ex: 200 / 201
    • If there are no explicit successful statuses, the core library will try to load the ranged status, that is 2XX
    • If there still are not any explicit successful statuses, the default block will be loaded.
    • If the preceding still do not return successful statuses, there is no response profile for the specified operation.
  • The OpenAPI Core SDK has been updated to include the DSL connector classes. With this update, connector developers can utilize the connector plugin at https://plugins.gradle.org/plugin/com.boomi.connector to build application-specific connectors that utilize the OpenAPI specification.

Version 2.13.4​

New
We added these features
  • Setting the Path in the Set Properties shape is no longer supported. This action is now performed on the Operation configuration dialog.
  • When using either OAuth 2.0 or AWS Signature authentication, the User and Password fields are now hidden since they are not used for these types of authentication.

Version 2.13.3​

New
We added these features
  • The REST descriptor has been updated to add Custom Property Key Value Pair query parameters and the resulting REST Operation logic has been updated to append query parameters.
  • The REST descriptor has been updated to remove the tracked property Path field. This has now been moved to the Operation configuration dialog and the resulting REST Operation logic has been updated.
  • The OpenAPI core libraries have been updated to allow circular request and response schema references. The amount of circular schema load is the initial object reference plus 2 more levels, which will result in 3 objects in the profile being loaded. Developers have the ability to override this load if they choose.
  • Base operation classes are updated to use parameterized base connection instances (BaseConnection<OperationContext>). As a result, calls to getOperationContext() are replaced with getContext(), and class type casting extending BaseConnection is no longer required.

Version 2.13.2​

New
We added these features
  • Added the ability to load path level parameters to the connector-sdk-openapi library.
  • Removed some unused transitive jars for connector-sdk-openapi
    • org.slf4j:*slf4j-ext*
    • org.mozilla:rhino
  • Included SDK license details in the published POM files in our repository.
Fix
We fixed these issues
  • Provided a missing dependency to common-aws 1.2.2 for SDK 2.13.2 when using connector-sdk-rest libraries.

Version 2.13.1​

New
We added these features
  • The OpenAPI and REST modules now follow the same version scheme as the Connector SDK.
  • You can now download and reference descriptors by {project}-{version}.descriptor from the S3 repository.

Version 2.13.0​

New
We added these features
  • Published version 0.7 of the common-apache-http JAR file to the public Maven repository. To learn more about the public Maven repository, see the topic Connector SDK artifacts.
  • Published version 1.1.11 of the boomi-json-util JAR file to the public Maven repository. To learn more about the public Maven repository, see the topic Connector SDK artifacts.
  • Added the ability in the Connector SDK OpenAPI utility to split a response array into multiple documents.
Fix
We fixed these issues
  • Provided a fix in ResponseUtil.addExceptionFailure. Utilizing ResponseUtil.addExceptionFailure inadvertently resulted in duplicate exception log entries. The first logged the exception, and the second resulted by calling OperationResponse.addErrorResult. With this fix, only one exception is logged, as expected.

Version 2.12.1​

New
We added these features
  • Added the ability in the REST Client connector, using key-value pairs, to add Request Headers. When added in the operation, the key-value custom properties are included as http request headers.
  • Updated the REST Client connector to store all response headers in a tracked group.
  • Published version 0.6 of the common-apache-http JAR file to the public Maven repository. To learn more about the public Maven repository, see the topic Connector SDK artifacts.

Version 2.12.0​

New
We added these features

  • Added the ability to configure OAuth 2.0 refresh authorization schemes for those services requiring a client id and client secret as part of the authorization header to refresh the token.

    Attention

    This is not a change to the Connector descriptor file or Connector SDK, but rather an internal change to the code associated with refresh tokens. This helps prepare for the future use of this functionality, when it is implemented in the descriptor and available for use when building a connector.

  • The @browsingType attribute in the Connector descriptor file is retired and should not be used when building a new connector, or making revisions to an existing connector. Both the "cloud" and "any" options for this attribute are retired, and if set, automatically change to "onpremise". When using the Developer tab on the Settings page to upload and manage your account’s connectors developed with the Connector SDK, the behavior is as follows:

    • New connectors — if your descriptor contains an entry for @browsingType, you receive a message when packaging the connector and uploading the descriptor, indicating that the attribute is retired and browsing is performed using containers associated with your account (local Runtimes, Runtime clusters, and Runtime clouds).
    • Existing connectors — if your descriptor contains an entry for @browsingType, it changes to onpremise (local Runtimes, Runtime clusters, and Runtime clouds).
    Attention

    This is not a change to the Connector descriptor file, but rather a change to the user interface code associated with the descriptor controlling the behavior of the @browsingType attribute, setting the default to "onprem". To learn more, see the topic Connector descriptor file.

Version 2.11.1​

22 September 2022
New
We added these features
  • Updated the Connector SDK artifact's dependencies so the wsdl4j-boomi artifact is available to developers as a top-level dependency of the connector-sdk-ws project. The wsdl4j-boomi artifact contains fixes, to provide security features for parsing.

Version 2.11.0​

11 September 2021

Features:

  • Enabled the ability in the connector descriptor file to add conditional fields for operations, and during import (Import Wizard), utilizing the visibilityCondition element. With conditional fields, you can determine whether a field appears, or does not appear, based on the selection of another field. You can add conditional fields based on the values of check boxes, radio buttons, and drop-down lists.

    To learn more about this element and how to implement conditional fields, see the topics Connector descriptor file and Implementing conditional fields.

  • Enabled the ability in the connector descriptor file to add conditional fields for connections utilizing the visibilityCondition element. With conditional fields, you can determine whether a field appears, or does not appear, based on the selection of another field. You can add conditional fields based on the values of check boxes, radio buttons, and drop-down lists.

    To learn more about this element and how to implement conditional fields, see the topics Connector descriptor file and Implementing conditional fields.

  • Updated the PayloadMetadata interface in the Common SDK model to enable the ability to set document-level Tracked Group Properties. With this update, process builders can retrieve document property group values, by key.

    To learn more about this interface and the methods the developer can use to set document-level Tracked Group Properties when creating the payload metadata, see the topic Connector SDK artifacts.

Version 2.10.0​

10 July 2021

Features:

  • Added the restrictedKey element to fields utilizing the customPropertiesConfiguration element, used when implementing Browse. Use this element in favor of the existing blackListedKey element.

    note

    The blackListedKey element is deprecated and will be retired at a future date. We recommend that you update your descriptor and connector code and replace the blackListedKey element with restrictedKey.

    To learn more about this element, see the topics Connector descriptor file and Implementing Browse.

  • Enabled the ability to add restricted keys in the connector descriptor file for fields, utilizing the restrictedKey element. Use this element in favor of the existing blackListedKey element.

    note

    The blackListedKey element is deprecated and will be retired at a future date. We recommend that you update your descriptor and connector code and replace the blackListedKey element with restrictedKey.

    To learn more about this element, see the topic Connector descriptor file.

  • Updated the sample Browser Implementation class (see the ) and removed the restrictedKey element, in favor of blackListedKey.

    note

    The blackListedKey element is deprecated and will be retired at a future date. We recommend that you update your descriptor and connector code and replace the blackListedKey element with restrictedKey.

Version 2.9.5​

12 June 2021

Feature:

  • Added the common-apache-http, connector-sdk-openapi, and connector-sdk-rest JAR files to the public Maven repository. To learn more about the public Maven repository, see the topic Connector SDK artifacts.
Fix
We fixed these issues
  • Provided a fix in the Connector SDK OpenAPI utility. Enumerated parameters set as optional (required: false) in the OpenAPI specification you create are automatically set to blank, allowing users to leave the field value blank.

Version 2.9.0​

9 January 2021

Features:

  • Enabled the ability to use the @overrideable attribute for custom properties fields for OperationFieldConfig.

Version 2.8.2​

14 November 2020

Features:

  • Updated the Connector SDK to align with development style requirements for line length, line breaks, etc. Additionally, removed unused and incorrect import statements.
  • Removed an unnecessary constructor from the WSConnector class.
  • Removed an unnecessary constructor from the SimpleOperationResponse class.
  • Updated the SimpleOperationResult class to follow development standards and use if statements rather than nested ternary operators.

Version 2.8.1​

10 October 2020

Features:

  • Updated the samples project in the connector-sdk-samples JAR file with an example demonstrating how to set document-level overrides when browsing (@overrideable attribute in the Connector descriptor file) and how to access the properties at execution time.
  • The samples project in the connector-sdk-samples.jar file currently contains an example for the CustomJsonResponseOperation class demonstrating an operation class using a custom JSON payload for the response and how to customize the response for the target system in a memory-efficient manner. The samples project is updated in this release with an example demonstrating how to customize the input stream before sending it to the target system.
  • Updated the samples project in the connector-sdk-samples.jar file with an example demonstrating how to determine the execution path based on document size.

Version 2.8.0​

12 September 2020

Features:

  • Enabled the ability to create connectors with dynamic operation properties using the @Overrideable attribute for OperationFieldConfig.

    Enabled the ability to declare the textarea value for an input string field's @displayType attribute, allowing support for more visible text fields with higher character limits.

Version 2.7.0​

8 August 2020
Fix
We fixed these issues
  • The custom-properties.xsd file is located in the model/src/main/resources/com/boomi/model/connector/ directory of the connector-sdk-model artifacts instead of model/src/main/resources/.

Version 2.6.0​

11 July 2020

Features:

  • BasePollingOperation now submits all payloads in a single batch. Previously, each payload was submitted as an individual execution.
  • Enabled the ability to configure the MAX_SIZE of an input document in the SizeLimitedUpdateOperation.java class using the new configurable container property, com.boomi.container.updateOperation.maxSize.

Version 2.5.2​

13 June 2020

Features:

  • Enabled the ability to declare the customProperty field type for a connection, operation, and in the import wizard. This lets users define a list of key-value pairs in the connection and operation components and dynamically apply them based on the property and use case.
  • Enabled the ability to create importable operation fields that are usable after an Import (browse). This feature is made possible through the addition of the new UI definition, browseField.xsd, and the ability to create BrowseField objects as a part of the getObjectDefinitions method.
  • Enabled the ability to configure the DistributionMode as a part of the SubmitOption for SDK Listen operations. The DistributionMode accepts the following values to determine how submitted process executions are distributed and executed in a multi-node molecule: “LOCAL_ONLY” and “PREFER_REMOTE”.
  • Enabled the ability to run Listen operations for SDK connectors in singleton mode. This feature is made possible through the addition of the SingletonListenOperation interface.
  • Updated the Javadoc links for non-SDK classes and methods so they work as expected from the Documentation and the Javadocs appear.

Version 2.3.0​

11 April 2020

Features:

  • Updated the Platform SDK Distribution to 2.3.0.

  • Added the "user" element for the trackedDocument attribute (@trackedDocument="user") to the Connector Descriptor to allow the user to choose the tracking direction on a per-operation basis.

  • Updated the demonstration (demo) connector descriptor file (connector-descriptor.xml) to provide an example of how you can use the @trackedDocument="user" attribute allowing users to select the tracking direction for an operation.

  • Updated the terms of the Connector SDK user agreement.

  • Enabled the ability to access the Atom configuration property values through the AtomConfig instance using the following methods:

    • getContainerProperty(String key) — Access Atom property String values.
    • getBooleanContainerProperty(String key) — Access Atom property Boolean values.
    • getLongContainerProperty(String key) — Access Atom property Numeric values. For each method, specify the key of the container property and the method returns the container property value.
    note

    If the property value does not exist for the specified key, you can specify a default value to be returned in the following format:

    • getContainerProperty(String key, String defaultValue)
    • getBooleanContainerProperty(String key, boolean defaultValue)
    • getLongContainerProperty(String key, long defaultValue)

  • Enabled the ability to create payload metadata by calling the createMetadata() method using the Listener instance.

Fix
We fixed these issues
  • The connector-sdk-model JAR contained schemas incorrectly stored in the root of the JAR file. These .xsd files are now nested in the com/boomi/model/connector/ directory within the connector-sdk-model JAR.

Version 2.2.0​

21 March 2020

Upgrade Considerations

If you upgrade to version 2.2.0, your project may not compile due to breaking changes in the SDK. For enhanced type safety, the ConnectorCacheFactory class now uses generics for the connector context. Since ConnectorContext does not contain all of the methods defined in the BrowseContext, you may receive compilation errors in classes that implement ConnectorCacheFactory. To resolve this issue, declare BrowseContext as the context type. For example, if you have a compiling issue related to WSConnector, here is how your code should look before and after declaring the context type:

  • Before:

    public class WSConnector extends BaseConnector
         implements ConnectorCacheFactory(WSCache.Key, WSCache), NetworkAuthenticatorConnector

  • After:

    public class WSConnector extends BaseConnector
         implements ConnectorCacheFactory(WSCache.Key, WSCache, BrowseContext), NetworkAuthenticatorConnector

Features

  • Updated the Platform SDK Distribution to 2.2.0 and added the new connector-sdk-model jar, which contains the following schemas:
    • genericconfig.xsd
    • genericconnector.xsd
    • genericconnectordesc.xsd
    • genericdeleteprofile.xsd
    • genericgetprofile.xsd
    • oauthconfig.xsd
    • oauthtypes.xsd
  • Enabled the ability to access Atom Proxy configuration values using the following method: getContext().getConfig().getProxyConfig();.
  • Enabled the ability for the SDK to expose custom properties in an OAuth2Token response so that connectors can access them. To access these additional properties, add a generic getProperty(key) method to Oauth2Token.

Version 2.1.0​

11 January 2020

Features

  • Enabled the ability for Connector listen operations to submit multiple payloads in a single process execution using batching.
  • New sample classes are added for batches: BatchByCountListenOperation and MultiMessageListenOperation.

Version 2.0.2​

6 December 2019

Features

  • Added the base class SizeLimitedUpdateOperation for filtering large input documents.
  • Added the following sample classes for batches: BatchByCountListenOperation and MultiMessageListenOperation.

Version 2.0.1​

21 November 2019

Upgrade considerations

  • If you upgrade to version 2.0.1, your project may not compile due to breaking changes in the SDK. For enhanced type safety, the BaseConnection class now uses generics for the connector context. Since ConnectorContext does not contain all of the methods defined in the BrowseContext, you may receive compilation errors in classes that extend BaseConnection. To resolve this issue, declare BrowseContext as the context type. For example, if you have a compiling issue related to WSConnection, here is how your code should look before and after declaring the context type:

    • Before:

      public class WSConnection extends BaseConnection {

    • After:

      public class WSConnection extends BaseConnection<BrowseContext> {

    In some cases, you may need to split the connection class into multiple connection classes that are each based on a type from the context hierarchy (ConnectorContext, BrowseContext, OperationContext). For example, in the samples project, there are the SimpleManagerConnection and SimpleOperationConnection classes.

Features

  • The samples project now is available.

  • The SDK license is now included in JAR files.

  • Added base classes to the public sdk-util project to help enhance or assist in the implementation of listen connectors:

    • BaseListenConnector — Base class for implementing a ListenConnector. You can extend this class rather than extending the BaseConnector class and then implementing ListenConnector.
    • BaseListenManager — Base class for implementing a ListenManager that stores the ConnectorContext for later access.
    • BaseListenOperation — Base class for implementing a ListenOperation that stores a BaseConnection for later access.
    • BasePollingManager — Base ListenManager that uses a ScheduledExecutorService to initiate polling on its managed BasePollingOperation instances. The schedule is blocked until BasePollingOperation#poll() has been completed on all managed operations.
    • BasePollingOperation — Base ListenOperation that can be used to poll for payloads and submit them in process executions. The associated BasePollingManager handles the polling schedule.
    • BaseWatchableManager — Base class for implementing a polling ListenManager for a WatchService.
    • BaseWatchableOperation — Base class for implementing a ListenOperation for a Watchable. The WatchService is managed by the associated BaseWatchableManager.
    • UnmanagedListenConnector — Base class for implementing a ListenConnector that doesn't need a ListenManager. Since managers are required for each listener, this provides a placeholder implementation that does nothing when started or stopped.
    • UnmanagedListenOperation — Base class for implementing a ListenOperation that does not have an associated ListenManager.

Retired

  • The BaseConnection.getOperationContext() method is retired. BaseConnection.getContext() now uses a generic return type and is preferred.
  • The com.boomi.connector.internal.api.BrowseContext and com.boomi.connector.internal.api.OperationType internal classes are retired.

Version 2.0​

21 October 2019

Features

  • The Listener API is enabled. You can use the ListenConnector interface to create listen operations for private connectors.

  • The common-webservices JAR is no longer packaged in the distribution zip file under the webservices directory.

  • common-ws is split into three projects:

    • common-webservices-model — Contains the classes generated from webservicesdescription.xsd.
    • common-webservices-lite — Depends on the common-webservices-model, contains additional classes that can be declared as a dependency in the sdk, and is not publicly available.
    • common-webservices — Depends on common-webservices-lite, contains any classes that use internal libraries, and is not publicly available.

  • Dependencies are declared on the following third-party JAR files and are downloadable from Maven Central or their respective public repo:

    • axis-jaxrpc-1.4.jar
    • commons-discovery-0.4.jar
    • wsdl4j-1.6.2.jar
    • wss4j-1.6.17.jar
    • xmlsec-1.5.7.jar

  • Refreshed the connector-sdk-api artifact's dependencies to have no external dependencies. The connector-sdk-api-<version>.jar found in the distribution file now only contains the class from com.boomi.connector.api. The following classes moved from connector-sdk-api to common-sdk:

    • BasePayload.java

    • ExtendedPayload.java

    • Payload.java

    • PayloadMetadataFactory.java

    • PayloadMetadata.java

    • PayloadUtil.java

    • PropertyReader.java

    • PropertyWriter.java The following class moved from connector-sdk-api to boomi-json-util:

    • JsonPayloadUtil.java

  • Refreshed the connector-sdk-test-util dependencies to have no external dependencies. The connector-sdk-test-util-<version>.jar found in the connector distribution file now only contains classes from the package com.boomi.connector.testutil.

    The following classes moved from sdk-test-util to boomi-util:

    • com.boomi.restlet.jaxb.JAXBUtil.class
    • com.boomi.jaxb.JAXBContexts.class
    • com.boomi.util.ObjectUtil.class
    • com.boomi.util.FileUtil.class
    • com.boomi.util.URLUtil.class
    • com.boomi.util.InvalidXMLCharacterException.class
    • com.boomi.util.ClassUtil.class
    • com.boomi.util.TempOutputStream.class
    • com.boomi.util.io.FastStringBuilderReader.class
    • com.boomi.util.io.FastByteArrayInputStream.class
    • com.boomi.util.io.FastByteArrayOutputStream.class
    • com.boomi.util.io.TruncatingStringWriter.class
    • com.boomi.util.io.FastStringReader.class
    • com.boomi.util.io.FastCharSequenceReader.class
    • com.boomi.util.io.FastStringWriter.class
    • com.boomi.util.io.SafeGZIPOutputStream.class
    • com.boomi.util.io.SafeZipOutputStream.class
    • com.boomi.util.StreamUtil.class
    • com.boomi.util.IOUtil.class
    • com.boomi.util.XMLUtil.class
    • com.boomi.util.ClassUtils.class
    • com.boomi.util.ToStringBuilder.class
    • com.boomi.util.ObjectUtils.class

Version 1.3.3​

9 November 2019

Features

  • Enable the ability to choose the document tracking direction for write and Execute operations with the @trackedDocument attribute.

Version 1.3.2​

22 June 2019

Features

  • Enhance the demonstration (demo) connector by adding implementation and test classes to showcase the SDK features.
  • Support creating an abstraction for results that can be added to an operation response, including the operation status, status code, status message, and payloads.
  • Provide support for adding radio buttons.
  • Provide an improved error message when executing Get and Delete operations without setting the Object ID parameter (Connector Shape dialog, Parameters tab).

Version 1.3.0​

2 February 2019

Features

  • Upgraded to Java 7.

Version 1.2.31.4​

23 July 2018
Fix
We fixed these issues
  • An error occurred when an empty query filter was passed into a connector Query action due to an unmarshalling failure. With this fix, the default minimum number of query expressions is changed from one to zero. As a result, if the query filter is empty, all objects of the specified type are returned.

Version 1.2.29​

16 May 2018
Fix
We fixed these issues
  • The proper SSL Context was not set up on the web service executor, resulting in failure on the part of connectors to add self-signed certificates to the Atom’s trust store. With this fix, connectors properly honor Atom-deployed certificates.
  • Re-importing profiles for custom operations were generating new profile components instead of updating the existing ones. The erroneous behavior did not occur when re-importing profiles for standard operations, and as such, standard operations are unaffected by this fix.

Version 1.2.27​

14 March 2018

Features

Version 1.2.26​

17 January 2018

Features

  • The OperationTest classes provide a way to set user defined dynamic properties in the SDK Test Utility.

Version 1.2.25​

11 December 2017

Features

  • The addition of OperationContext provides a new, easier way to create metadata in classes that don’t have access to the OperationResponse.
  • The GenericConnectionSettingsEditor and the GenericOperationSettingsEditor are upgraded so that the Options tabs in connections and operations display with the newest user interface styles.

Version 1.2.24​

24 October 2017

Features

  • Adds a Microsoft Word template, Connector_Documentation_Template.docx, that you can use to document your connector as part of the process to submit your connector to for review.
  • Adds a conf directory folder containing the THIRD-PARTY-connector-sdk-dist text file, which lists the open source software licenses that are distributed with as part of the Connector SDK.

Version 1.2.22​

19 September 2017

Features

  • Updates to the Connector SDK readme file.

Version 1.2.21​

21 August 2017

Features

  • Adds support to the GET_OBJECT_TYPES, GET_OBJECT_DEFINITIONS, and CUSTOM methods to perform a Test Connection.
  • Adds the NetworkAuthenticator class, the NetworkAuthenticatorContext class, and the NetworkAuthenticatorConnector class to implement authentication for a connector.

Version 1.2.16​

17 May 2017

Features

  • Adds ability to override addResult in the common WSExecuteOperation to support paging.
Fix
We fixed these issues
  • The previously packaged version of the connector-sdk-testutil-x.y.z was missing some common classes.

Version 1.2.15​

7 March 2017

Features

  • connectorTest.afterOperation allows exceptions that implementing tests are not forced to catch.
Fix
We fixed these issues
  • The Connector tester threw a parse error when a Runtime adds an empty schema for non-XML content types.
  • A WSDL for a Web Service SOAP client operation did not import correctly when an optional targetNamespace attribute was omitted.

Version 1.2.14​

8 December 2016

Features

  • Adds customTypeID so that developers can define custom operations not supported by the standard operations.
  • Adds customTypeLabel so that users see the name of the custom operation when they select the operation type.

Version 1.2.11​

21 September 2016

Features

  • Add Client Credentials to OAuth 2.0 authorizations.
  • Add Resource Owner Password Credentials to OAuth 2.0 authorizations.
Fix
We fixed these issues
  • Add FastStringWriter utility to the distribution.

Version 1.2.7​

18 March 2016

Features

  • Added a filter to limit the results returned to the platform to 500. The filter supports wild cards. The filter does not replace the implementation for NetSuite and Oracle EBS, which continue to use their own filters.
  • The global default for query operations using the Fields tab can set all fields to selected or unselected. This employs a new field ‘deSelectAllFields’ that has a default value of ‘false’.
  • Added an annotation property so that individual fields can be selected or unselected.

Version 1.2.5​

28 October 2015

Features

  • Added support at the field level for OAuth 2.0 connection settings extensions.

Version 1.2.1​

20 July 2015

Features

  • Added support for OAuth 2.0 configuration. This authorization supports browse time token generation and the capability to define fields as hidden or disabled.

Version 1.1.25​

3 December 2014

Features

  • Added support for implementing connections to SOAP-based web services requiring WS-Security encryption, signature or timestamp in any combination.

Version 1.1.24​

29 August 2014

Features

  • Added support for specifying schema annotations in JSON schemas to fully enable their use in the implementation of object browsing for Query operations and for mapping simple data types in objects to data types.
  • Added API methods to the OperationResponse class to enable association of multiple output documents with multiple input documents.

Version 1.1.19​

17 February 2014

Features

  • Added support for the generation of JSON profiles.

Version 1.1.17​

24 October 2013

Features

  • Added the getLogLevel method to the AtomConfig class to enable connectors to retrieve the current level of detail logged by the Runtime. This enables connectors to configure third-party logging APIs.
  • Added the optional networkConfig element and cookieScope attribute to the connector configuration file, which set how cookies are handled.

Version 1.1.16​

19 August 2013

Features

  • Added the generateConnectionInfo method to the BaseConnection class to enable connector operations to log connection information.

Version 1.1.15​

26 July 2013

Documentation

  • Refactored the demonstration connector Java source code to reflect best practices and for consistency with new connector projects created with the Connector SDK Tools Eclipse plug-in.

Version 1.1.12​

6 February 2013

Features

  • Added fieldSelectionLevels attribute to the Connector Descriptor to allow customization of the field selection depth for connector operations.

Version 1.1.11​

29 January 2013

Features

  • Added “publiccertificate” to the list of enumerated values for the connection field type attribute in the Connector Descriptor to enable addition of public (trusted) Certificate components to connections.
Fix
We fixed these issues
  • Updated ConnectorTester class in connector-sdk-test-util.jar to allow testing of the browse functionality of DELETE operations.

Version 1.1.10​

2 November 2012

Features

  • Added scope attribute to the Connector Descriptor to allow operation fields to be specified as browse only fields.
  • Added capability to implement connector operations for use in integrations with non-XML data sources.
  • Added support for the specification of data type mappings.

Version 1.1.0​

16 November 2010

Features

  • Added "browsingType" attribute to the Connector Descriptor.
  • Added option to enable "fieldSelection" to all operations.
  • Added option to enable "sorting" to QUERY operations.
  • Added option to enable the available filters and sort options to be limited by field type.

Version 1.0.15​

24 May 2010

Features

  • Added optional "sdkApiVersion" attribute to the Connector Config
  • Added optional OUTPUT profiles to the CREATE,UPDATE,UPSERT,DELETE operation types. These extra ObjectDefinitionRoles will only be available to a connector if the "sdkApiVersion" in the connector config is "1.0.15" or greater.
  • Added the XMLSplitter and XMLJoiner utilities for conveniently splitting a single XML document into multiple XML documents and joining multiple XML documents into a single XML document.
  • Updated the DemoUpdateOperation to show an example of an operation with paging support (batch object handling). Utilizes the new XMLSplitter and XMLJoiner utilities.
  • Date values passed in as query parameter values will be formatted using the internal Date format. This format can now be conveniently interpreted using the RequestUtil.parseAtomDateString() method.
Fix
We fixed these issues
  • Previously there was no way to create an ObjectDefinition cookie for a DELETE operation. Now, the DELETE operation will be allowed to generate a ObjectDefinition cookie through the normal Browser.getObjectDefinitions() call (any cookie added for the INPUT profile will be saved, and the profile information will be discarded). The getObjectDefinitions method will only be invoked for DELETE operations if the "sdkApiVersion" in the connector config is "1.0.15" or greater.

Version 1.0.14​

7 May 2010

Features

  • Added an optional "dateTimeFormat" attribute to the Connector Descriptor which allows the connector to indicate an alternate date/time format for generated profiles. This feature should only be used in rare circumstances when it is infeasible for the connector to support the standard XML Schema dateTime format.

Version 1.0.11​

2 March 2010

Features

  • Extended EXECUTE operation to include both INPUT and (optional) OUTPUT profiles.

Version 1.0.10​

17 February 2010

Features

  • Added the EXECUTE operation to the list of available operations.
  • Added the BrowseContext.getConnector() method for convenient access back to the Connector from the current operation.

Version 1.0.9​

15 July 2009

Features

Fix
We fixed these issues
  • Add ability for extra schemas in ObjectDefinition to define a systemId attribute so that they can be successfully included by another schema in the same ObjectDefinition, see ExtraSchema.getSystemId().

Version 1.0.8​

27 March 2009

Features

  • Added the OperationStatus.APPLICATION_ERROR status which allows connector implementations to distinguish between errors within the service itself (e.g. the data is not formatted correctly) and general errors (e.g. the service could not be contacted).

Version 1.0.7​

9 February 2009

Features

Version 1.0.6​

5 December 2008

Documentation

  • Added QUERY operation implementation to the demonstration connector.

Version 1.0.5​

1 December 2008

Documentation

  • Added demonstration connector implementation using the demo service on Google App Engine.