Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Adapter Library

Adapter Library

Ensemble provides many adapters, and you can define your own. Ensemble provides adapters for the following scenarios:

Email

Receives email messages via the POP3 protocol and sends email messages via the Simple Mail Transfer Protocol (SMTP).

See Using Email Adapters with Ensemble.

File

Reads and writes files on the local network. Able to open, create, delete, modify, and move files. The file content can be character or binary data.

See Using File Adapters with Ensemble.

Also see “Business Host Classes That Use File Adapters,” later in this chapter.

FTP

Receives and sends files between local and remote systems via the File Transfer Protocol (FTP). The file content can be characters or binary data. The adapters support FTP over SSL and SFTP.

See Using FTP Adapters with Ensemble.

Also see “Business Host Classes That Use FTP Adapters,” later in this chapter.

HTTP

Provides an HTTP listener for custom port listening, XML listening, or raw HTML handling. Supports the standard HTTP operations Post, Get, Put, and Delete. Allows the use of proxy servers.

See Using HTTP Adapters with Ensemble.

Also see “Business Host Classes That Use HTTP Adapters,” later in this chapter.

LDAP

The outbound LDAP adapter can send requests to an LDAP server and receive responses.

See the EnsLib.LDAP.OutboundAdapter entry in the Class Reference.

MQSeries

Receives and sends messages in IBM WebSphere MQ (MQ Series) format. Message content can be a specific data type or a binary data stream. The adapter can simply send the message, or send it and then pull the corresponding response from the message queue.

See Using IBM WebSphere MQ Adapters with Ensemble.

Pipe

Able to execute a shell command and communicate with it via pipes. Capable of handling character data or a binary data stream.

See the EnsLib.Pipe.InboundAdapter and EnsLib.Pipe.OutboundAdapter entries in the Class Reference.

SAP

Allows Ensemble to interface with the SAP Java Connector (SAP JCo).

See Using the SAP Java Connector with Ensemble for details.

Siebel

A subclass of the HTTP adapter that sends requests to a Siebel server and returns responses.

See the EnsLib.Siebel.HTTPOutboundAdapter entry in the Class Reference.

SOAP

Listens for SOAP requests on a local TCP port or via a standard web server. Dispatches outbound requests by acting as a SOAP client to an external SOAP server. In this special case, adapters are not necessarily involved.

See Creating Web Services and Web Clients with Ensemble.

Also see “Business Host Classes That Use SOAP,” later in this chapter.

SQL

Executes SQL statements against a remote database via an ODBC-defined or JDBC-defined connection.

See Using SQL Adapters with Ensemble.

TCP

Manages an incoming or outgoing TCP connection. Allows simultaneous handling of multiple connections. Supports character and binary data streams, and counted data blocks. The adapters also supported framed protocols.

See Using TCP Adapters with Ensemble.

Also see “Business Host Classes That Use TCP Adapters,” later in this chapter.

Telnet

Directly initiates and manages a Telnet connection.

See the EnsLib.Telnet.OutboundAdapter entry in the Class Reference.

To use an adapter, you define a business host class that uses the adapter class. For a general description of this process, see Developing Ensemble Productions. The books in the previous list provide details that apply to the specific adapters.

As noted previously, you can also define your own adapters. For information, see Developing Ensemble Productions.

Feedback