Creating Custom SOAP or REST Cloud Connectors
The CloudStreams Development plug-in provides a wizard and editors you use to create and configure a cloud connector.
To create a custom cloud connector
3. Right-click the Connectors folder and select New Cloud Connector (or right-click the CloudStreams Provider project you just created and select New Cloud Connector). Complete the fields in the New Cloud Connector wizard as follows.
Parameter | Description |
Project | Click Browse and select the CloudStreams Provider project you just created. |
Name | Assign a name for the cloud connector. The name must start with an alpha character and may contain numerals and the following special characters:  - (hyphen) _ (underscore) ' (apostrophe) , (comma) " (double quotes) . (period) & (ampersand) () (parentheses) ! (exclamation) |
Version | Assign a version identifier for the cloud connector. The version identifier is a required attribute that you should increment when a connector is modified to indicate that the cloud connector has been updated. This is a "public" version identifier that Designer shows to developers when it displays the list of connectors. The name may contain numerals and the following special characters: - (hyphen) _ (underscore) . (period) |
ID | Assign a unique identifier for the connector. This value must start with an alpha character and may contain numerals and the following special characters: - (hyphen) _ (underscore) . (period) |
Provider Group | Optional. You can specify that the connector should belong to a particular group. A group is a logical grouping of a collection of connectors. For example, if you have multiple connectors for the same provider, you might want to group them together for convenience. Suppose you have two connectors for the Amazon provider: one connector that is provided by Software AG, for example, the webMethods CloudStreams Amazon EC2 Connector, and another connector for the Amazon provider that was custom-built. You might want to group them together into a group called AmazonProvider. To specify a group for the connector, type a group name in this field or select an existing group name from the drop-down list. The name must start with an alpha character and may contain numerals and the following special characters: - (hyphen) _ (underscore) ' (apostrophe) , (comma) " (double quotes) . (period) & (ampersand) () (parentheses) ! (exclamation) |
| If you do not specify a group, the connector will be added to your CloudStreams Provider project. If you specify a group, the connector will be added to the <group_name> folder (under CloudStreams > Providers). Note: | The group will be visible in the Integration Server Administrator's Connector List (under Solutions > CloudStreams > Providers) if at least one connector is in the deployed state. |
|
Metadata Handler | CloudStreams provides two kinds of metadata handlers, which provide the appropriate SOAP data model for the SaaS provider. Click Browse and select a metadata handler. For a SOAP-based SaaS provider, select the SOAP metadata handler WsdlConnectorMetadataHandler. For a REST-based SaaS provider, select the REST metadata handler RestConnectorMetadataHandler. |
Description | Optional. Type a description of the cloud connector. |
4. Click Next and create a cloud connector service based on the provider's WSDL or XSD that you specify as follows.
Note: | Optionally, instead of clicking Next you can click Finish. If you choose to click Finish, you can create the cloud connector service later, using the Services Configuration page as described in Configuring Cloud Connector Services
(SOAP). |
Parameter | Description |
WSDL (SOAP only) | Specify the SaaS provider's WSDL that CloudStreams will use to generate the document types by selecting either: File. Specify the WSDL file name, or click Browse and select the WSDL from your local file system. URL. Specify the URL of the WSDL. |
XSD (REST only) | Specify the SaaS provider's XSD that CloudStreams will use to generate the document types by selecting either: Namespace. Specify the XSD's namespace (for example myConnector_v1.doctypes). Alternatively, click Browse and select a doctype that has already been generated in Integration Server. XSD. Specify the URL of the XSD in the text field, or click Browse and select an XSD. |
Package | Assign a name for the DocTypes package, which will be deployed to the CloudStreams target server. The name must be a valid resource name on your operating system. The name must not be null and cannot be an empty string. The name cannot contain: Reserved words and characters that are used in Java or C/C++ (such as for, while, and if). Digits as their first character. Spaces. Control characters and special characters like periods (.), including: Characters outside of the basic ASCII character set, such as multi-byte characters. CloudStreams will generate the document types from the provider's WSDL or XSD. However, if the Namespace option is chosen in the XSD field, then doctypes will not be generated. CloudStreams automatically generates a name for the namespace that will contain the provider's document types. The name's form is: packageName.connector_ID.doctypes. When additional services are added, CloudStreams adds the document types to this namespace. |
Description | Optional. Type a description of the cloud connector service. |
5. Click Finish.
The new cloud connector is added to your CloudStreams Provider project.
In addition, if you completed page two of the wizard, CloudStreams creates a service for the cloud connector, based on the WSDL or XSD you specified in the wizard.
