Transports

You can configure BEA AquaLogic Service Bus proxy services and business services to use one of the following transport protocols. The transport protocol you select depends on the service type, the type of authentication required, the service type of the invoking service, and so on. This section describes the transport protocols supported by AquaLogic Service Bus. They include:

Two other native transports are also supported by AquaLogic Service Bus and are documented separately:

Native MQ Transport User Guide describes the Native MQ Transport, which is used for inbound and outbound connectivity with IBM WebSphere® MQ.
SFTP Transport User Guide describes the SFTP transport protocol, which is used to transfer files over SSH File Transfer Protocol (SFTP) using SSH version 2.

E-mail

You can select the e-mail transport protocol when you configure a Messaging Type or Any XML Service type of proxy service or business service. The following sections describe

Configuring Proxy Services using E-mail Transport Protocol

When you configure a proxy service using the e-mail transport protocol, you must specify an endpoint URI in the following format:

mailserver-host: is the name of the host mail server
port: is the port used by the mailserver host

You can configure the following parameters for an e-mail transport proxy service:

Service Account: This is a mandatory parameter. This is the service account resource. The service account consists of a user name/password combination required to access the e-mail account.
Polling Interval: This is a mandatory parameter. This parameter specifies the interval in milliseconds. The default value is 60 ms.
E-mail protocol: This is a mandatory parameter. There are two types of protocol from which you can select, imap and pop3. The default protocol is pop3.
Read Limit: This is a mandatory parameter. This specifies the number of files to be read in each poll. The default value is 10.
Pass By Reference: If this parameter is enabled, the file is staged in the archive directory and passed as a reference in the message headers.
Post Read Action: This is a mandatory parameter. This specifies whether the files should be deleted, moved, or archived after being read by the service. By default the files are deleted after reading.
Attachments: This is a mandatory parameter. This parameter specifies if the attachments are to be archived or ignored. By default this parameter is set to ignore.
IMAP Move Folder: This is the destination of the messages if the Post Read Action is set to move.

Note: You must configure this field only if Post Read Action is set to move.

Download Directory: This is a mandatory parameter. It specifies the file system directory path to download the message.
Archive Directory: This is a mandatory parameter. A file URI that points to the directory where the files are archived. This field is active only when Post Read Action parameter is set to archive.
Error Directory: This is a mandatory parameter. This URI points to a directory in which the contents of the file will be stored in case of an error.
Request Encoding: This is an optional parameter. This parameter specifies the type of encoding to read the request message. The default encoding is iso-8859-1.

Configuring Business Services using E-mail Transport Protocol

When you configure a business service using the e-mail transport protocol, you must specify the endpoint URI in the following format:

You can configure the following parameters for an e-mail transport business service:

SMTP Server: You must select an SMTP Server from the drop-down list.

Note:

You must first create the SMTP Server resource.

Mail Session: This parameter is optional. It is the JNDI name of the configured mail session. You can select mail sessions from the drop-down list.

From Name: This is an optional parameter. This parameter specifies the name from which the reply should be sent.
From Address: This is an optional parameter. This parameter specifies the e-mail address from which the e-mail message should be sent.
Reply To Name: This is an optional parameter. This parameter specifies the name to which the reply should be sent.
Reply To Address: This is an optional parameter. This parameter specifies the e-mail address, to which the reply should be sent.
Connection Timeout: This is an optional parameter. You can use this parameter to specify time in milliseconds after which the connection to the SMTP server times out.
Request Encoding: This is an optional parameter. This parameter specifies the type of encoding to read the request message. The default encoding is iso-8859-1.

EJB

An EJB business service is a Transport Typed Service, that is, the type of the transport is determined by the configuration of the service. The EJB transport supports native Remote Method Invocation (RMI) of Stateless Session Beans deployed on WebLogic Server. The EJB transport can also be leveraged to directly expose an EJB as a Web service through AquaLogic Service Bus. For information about the EJB transport, see EJB Transport.

File

You can select the file transport protocol when you configure a Messaging Type or Any XML Service type of proxy service and the endpoint URI is of the form:

where root-dir/dir1 is the absolute path to the destination directory.
The following sections describe:

Configuring Proxy Services using File Transport Protocol

To configure the file transport for a proxy service you must specify the following fields:

File Mask: This is an optional parameter. This specifies the files that should be polled by the proxy service. If the URI is a directory and *.* is specified, then the service will poll for all the files in the directory.
Polling Interval: This is a mandatory parameter. This specifies the value for the polling interval in milliseconds. The default value is 60 ms.
Read Limit: This is a mandatory parameter. This specifies the number of files to be read in each poll. The default value is 10.

Note: If ‘0’ is specified, all the files are read.

Sort By Arrival: This is an optional parameter. This parameter indicates the sequence of events raised in the order of the arrival of files. The default value for this parameter is False.
Scan Subdirectories: This is optional. If enabled, the sub-directories are also scanned.
Pass By Reference: If this parameter is enabled, the file is staged in the archive directory and passed as a reference in the headers.
Post Read Action: This parameter is mandatory. This specifies whether the files should be deleted or archived after being read by the service. By default the files are to be deleted after reading.
Stage Directory: This is a mandatory parameter. This file URI points to the staging directory.
Archive Directory: This is a mandatory parameter. This file URI points to the directory where the files are archived. This field is active only when Post Read Action parameter is set to archive.
Error Directory: This is a mandatory parameter. This URI points to a directory, in which the contents of the file will be stored in case of a error.
Request Encoding: This is an optional parameter. This parameter specifies the type of encoding to read the request message. The default encoding is utf-8.

Configuring Business Services using File Transport Protocol

When you configure a business service using the file transport protocol you must specify the endpoint URI in the following format:

When you use this type of transport to configure a business service you must configure the following fields:

Prefix: This is an optional parameter. This parameter specifies the prefix to be attached to the filename.
Suffix: This is an optional parameter. This parameter specifies the suffix to be attached to the filename.
Request Encoding: This is an optional parameter. This specifies the type of encoding to read the message. The default encoding which will be used is utf-8.

FTP

You can select the FTP transport protocol when you configure a Messaging Type or Any XML Service type of proxy service and the endpoint URI is of the form:

hostname: is the name of the host on which the destination directory is stored.
port: is the port number at which the FTP connection is made.
directory: is the destination directory.

Configuring Proxy Services using FTP Transport Protocol

To configure the FTP transport for a proxy service you must specify the following fields:

User Authentication: You must select one of the following types of User Authentication:

anonymous: If you select anonymous, you do not require any login credentials to login to the FTP server, but you optionally supply your e-mail ID for identification.
external user: If you select external user, you have to reference a Service Account resource, which contains your user name/password for the FTP server.

Pass By Reference: This is an optional parameter. If this parameter is enabled, the file is staged in the archive directory and passed as a reference in the headers.
Remote Streaming: This is an optional parameter. Setting this parameter to True will poll FTP files directly from the remote server at processing time.
File Mask: This is a mandatory parameter. This specifies the files that should be polled by the proxy service. If the URI is a directory and *.* is specified, then the service will poll all the files in the directory.
Polling Interval: This is a mandatory parameter. This specifies the value for the polling interval in milliseconds. The default value is 60 ms.
Read Limit: This is a mandatory parameter. This specifies the value for the polling interval in milliseconds. The default value is 60 ms.
Post Read Action: This is a mandatory parameter. This specifies whether the files should be deleted or archived after being read by the service. By default the files are deleted after reading.
Transfer Mode: This parameter specifies whether the mode of file transfer is binary or ascii. By default the transfer is binary.
Stage Directory: This is a mandatory parameter. This file URI points to the staging directory.
Archive Directory: This is a mandatory parameter. This file URI points to the directory where the files are archived. This field is active only when Post Read Action parameter is set to archive.
Error Directory: This is a mandatory parameter. This URI points to a directory location, where the contents of the file will be stored in case of a error.
Request Encoding: This is an optional parameter. This parameter specifies the type of encoding to read the request message. The default encoding is utf-8.
Advanced Settings: Click the icon to expand the Advanced Settings section. Configuring parameters in this section is optional.

Scan Subdirectories: This is optional. If enabled the sub-directories are also scanned.
Sort By Arrival: This is an optional parameter. This parameter indicates the sequence of the events being raised in the order of the arrival of files. The default value for this parameter is False.
Timeout: This is an optional parameter. This parameter specifies the FTP timeout interval, in seconds, before the connection is dropped. The default value for this parameter is 0.
Retry: This is an optional parameter. This parameter specifies the maximum number of retries for the FTP connection failures.

Configuring Business Services using FTP Transport Protocol

You can select the FTP transport protocol when you configure a Messaging Type or Any XML Service type of business service and the endpoint URI is of the form:

hostname: is the name of the host on which the destination directory is stored.
port: is the port number at which the FTP connection is made.
directory: is the destination directory.

To configure the FTP transport for a business service you must specify the following fields:

User Authentication: You must select one of the following types of User Authentication:

anonymous: If you select anonymous, you do not require any login credentials to login to the FTP server. But you optionally supply your e-mail ID for identification.
external user: If you select external user, you have to reference a Service Account resource, which contains your user name/password for the FTP server.

Prefix for destination filename: This is a mandatory parameter. This parameter specifies the prefix to be attached to the filename.
Suffix for destination filename: This is a mandatory parameter. This parameter specifies the suffix to be attached to the filename.
Request Encoding: This is an optional parameter. This parameter specifies the encoding for the request message.

For more information on how to configure this transport, see Adding a Business Service: Transport Configuration in Using the AquaLogic Service Bus Console.

HTTP

Configuring Proxy Services using HTTP Transport Protocol

You can select HTTP as the transport protocol when you configure any type of proxy service and the endpoint URI is of the form:

To configure the HTTP transport for a proxy service you must specify the following fields:

Basic Authentication Required: If enabled, basic authentication is required to access this service.
Dispatch Policy: You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Request Encoding: This parameter specifies the character set encoding for the request messages.
Response Encoding: This parameter specifies the character set encoding for the response messages.

Configuring Business Services using HTTP Transport Protocol

You can select HTTP as the transport protocol when you configure any type of business service and the endpoint URI is of the form:

host: is the name of the system that hosts the service.
port: is the port number at which the connection is made.
someService: is a target service.

To configure the HTTP transport for a business service you must specify the following fields:

Timeout: This parameter specifies the HTTP timeout interval, in seconds, before the connection is dropped. The default value for this parameter is 0.
HTTP Request Method: This parameter enables you to select the get method or the post method for the HTTP requests.
Basic Authentication Required: If enabled, basic authentication is required to access this service.
Service Account: This resource contains the login credentials required for the Basic Authentication.
Follow HTTP redirects: Enabling this parameter allows the business to follow the HTTP redirects.
Dispatch Policy: You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Request Encoding: This parameter specifies the character set encoding for request messages.
Response Encoding: This parameter specifies the character set encoding for response messages.

HTTP(S)

You can select the HTTP(S) transport protocol when you configure any type of proxy service and the endpoint URI is of the form:

where someService is the name of a proxy service or a business service. Following sections describe:

Configuring Proxy Services using HTTP(S) Transport Protocol

To configure the HTTP(S) transport for a proxy service you must specify the following fields:

Client Authentication: The Client Authentication method provides you with three options:

None: This option enables one-way SSL. No client authentication is required.
Basic: This option enables one-way SSL. But this requires user/password client authentication.
Client Certificate: This option enables one-way SSL. But this requires user/password client-side and server-side authentication. BEA recommends this method of client authentication.

Dispatch Policy: You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Request Encoding: This parameter specifies the character set encoding for the request messages.
Response Encoding: This parameter specifies the character set encoding for the response messages.

Configuring Business Services using HTTP(S) Transport Protocol

You can select the HTTP(S) transport protocol when you configure any type of business service and the endpoint URI is of the form:

host: is the name of the system that hosts the service.
port: is the port number at which the connection is made.

To configure the HTTP(S) transport for a business service you must specify values for the following fields:

Timeout: This parameter specifies the HTTP timeout interval, in seconds, before the connection is dropped. The default value for this parameter is 0.
HTTP Request Method: This parameter enables you to select the get method or the post method for the HTTP requests.
Basic Authentication Required: Enabling basic authentication is required to access this service.
Service Account: This resource contains the login credentials required for the Basic Authentication.
Follow HTTP redirects: Enabling this parameter allows business services to follow HTTP redirects.
Dispatch Policy: You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Request Encoding: This parameter specifies the character set encoding for the request messages.
Response Encoding: This parameter specifies the character set encoding for the response messages.

JMS

You can select JMS as the transport protocol for all the types of proxy services. AquaLogic Service Bus is certified with the following JMS implementations:

WebLogic Server 9.x JMS
IBM WebSphere MQ/JMS release 5.3
TIBCO Enterprise Message ServiceTM release 4.2

Configuring Proxy Services using JMS Transport Protocol

You can select the JMS transport protocol when you configure any type of proxy service and the endpoint URI is of the form:

host: is the name of the system that hosts the service.
port: is the port number at which the connection is made.
[,host:port]*: indicates that you can configure multiple hosts with corresponding ports.
factoryJndiName: The name of the JNDI Connection Factory. For more information on how to define a connection factory queue, see Configure resources for JMS system modules in Administration Console Online Help.
destJndiName: is the name of the JNDI destination.

To target a JMS destination to multiple servers, use the following format of the URI: jms://

host1:port,host2:port/QueueConnectionFactory/destJndiName

where QueueConnectionFactory is name of the connection factory queue. For more information on how to define a connection factory queue, see Configure resources for JMS system modules in Administration Console Online Help.

To configure a proxy service using JMS transport protocol you must specify values for the following fields:

Destination Type: You must specify the destination to be of one of the following:

Queue: This defines a point-to-point destination type. You can use this destination type for peer asynchronous communications. A message, which is delivered to a queue is distributed to only one destination.
Topic: This defines a publish or a subscribe destination type. You can use this destination type for peer asynchronous communications. A message, which is delivered to a topic is distributed to all the subscribers of the topic.

Is Response Required: If you expect a response to the outbound message, you must specify the following parameters for the response message:

Response Correlation Pattern: This configures the design pattern for JMS response message to be one of the following:

JMS Correlation ID: You must select JMS Correlation ID design pattern for your message if you want to correlate by JMS Correlation ID and send the response to the URI configured in the Response URI field.

Note: The Response URI field is active only when you select JMS Correlation ID design pattern for your response message.

JMS Message ID: You can JMS Message ID design pattern for your message if you want to correlate by JMS Message ID and send the response to the JMSReplyTo Destination by configuring the Response Connection Factory field.

Note: The Response Connection Factory field is active only when you select JMS Message ID design pattern for your response message.

Response Message Type: You can set type of the response message to Bytes or Text.
Response Encoding: You can set the encoding for the response message. The default encoding is UTF-8.
Client Response Timeout: This parameter specifies the response timeout interval, in seconds.

Request Encoding: You can set the encoding for the request message. The default encoding is UTF-8.
Dispatch Policy: This specifies the dispatch policy for the endpoint. You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Advanced Settings: Click the icon to expand the Advanced Settings section. Configuring parameters in this section is optional.

You can set the following parameters in the section:

Use SSL: This specifies whether the connections can be made over SSL or not.
Message Selector: You can use this field to specify the criteria for selecting messages.
Durable Subscription: You can check if the subscription is durable only if the destination type is Topic.
Retry Count: In this field you can configure the maximum number of retries for the connection.
Retry Interval: In this field you can configure the time interval in milliseconds between consecutive retries.
Error Destination: In this field you can configure the name of the target destination for the messages, which have reached the maximum number of retry count.
Expiration Policy: In this field you can specify the message expiration policy to be used when you encounter an expired message at a WebLogic Server or a JMS destination.
JMS Service Account: In this field you can specify the name of the service account resource to be used to make the connection over the secured socket layer.

Configuring Business Services using JMS Transport Protocol

You can select the JMS transport protocol when you configure any type of business service and the endpoint URI is of the form:

host: is the name of the system that hosts the service.
port: is the port number at which the connection is made.
[,host:port]*: indicates that you can configure multiple hosts with corresponding ports.
factoryJndiName: The name of the JNDI Connection Factory. For more information on how to define a connection factory queue, see Configure resources for JMS system modules in Administration Console Online Help.
destJndiName: is the name of the JNDI destination.

To target a target a JMS destination to multiple servers, use the following format of the URI: jms://host1:port,host2:port/QueueConnectionFactory/destJndiName

When you register a JMS business service, you must manually edit the URI from the WSDL file when adding it to the service definition. The URI format is as follows:

To configure a business service using the JMS transport protocol you must specify values for the following fields:

Destination Type: You can specify the destination to be of one of the following:

Queue: This defines a point-to-point destination type. You can use this destination type for peer asynchronous communications. A message, which is delivered to a queue is sent to only one destination.
Topic: This defines a publish or a subscribe destination type. You can use this destination type for peer asynchronous communications. A message, which is delivered to a topic is distributed to all the subscribers of the topic.

Is Response Required: You can specify if you expect a response to the outbound message. If you expect a response you must specify the following parameters for the response message:

Response Correlation Pattern: You can configure the design pattern for JMS response message to be one of the following:

JMS Correlation ID: You must select a JMS Correlation ID design pattern for your message if you want to correlate by JMS Correlation ID and send the response to the URI configured in the Response URI field.

Note: The Response URI field is active only when you select JMS Correlation ID design pattern for your response message.

JMS Message ID: You must select JMS Message ID design pattern for your message if you want to correlate by JMS Message ID and send the response to the JMSReplyTo Destination by configuring the Response Connection Factory field.

Note: The Response Connection Factory field is active only when you select JMS Message ID design pattern for your response message.

Response Message Type: You can set type of the response message to Bytes or Text.
Response Encoding: You can set the encoding for the response message. The default encoding is UTF-8.
Client Response Timeout: This parameter specifies the response timeout interval, in seconds.

Request Encoding: You can set the encoding for the request message. The default encoding is UTF-8.
Dispatch Policy: You can specify the dispatch policy for the endpoint. You must configure Work Managers in the WebLogic Server Administration Console in order to have other dispatch policies in addition to the default dispatch policy. For more information on how to configure a Work Manager, see Create a Global Work Manager in WebLogic Server Administration Console.
Advanced Settings: To configure the advance settings click on icon on the right hand side to expand the advanced settings section. Configuring parameters in this section is optional.

You can set the following parameters in the section:

Use SSL: This specifies if the connections can be made over SSL or not.
Expiration: This specifies the time interval in milliseconds after which the message will expire. Default value is 0, which means that the message never expires.
Unit Of Order: This is a value added feature of WebLogic, which enables a message producer to group messages into a single unit with respect to the order of processing. This single unit is called the Unit of Order. All the messages in a unit must be processed sequentially in the same order they were created.

Note:

This is supported by WebLogic Server 9.0.

JNDI Service Account: You can select the service account resource to be used for JNDI lookups.
JMS Service Account: You can select the service account resource to be used for the JMS server connection.

Local

Every proxy service is associated with a protocol that determines the level of communication used by the clients to send requests to the proxy service. In AquaLogic Service Bus there two categories of proxy services—the proxy services of first category are invoked directly by the clients; those of the second category are invoked by other proxy services in the message flow. The proxy services of the second category use a new transport called the local transport. For more information on Local Transport, see Local Transport.

Tuxedo

BEA AquaLogic Service Bus and BEA Tuxedo can inter-operate to use the services each of them offer. The Tuxedo transport is secure, reliable, high performing, and provides bi-directional access to the Tuxedo domain from AquaLogic Service Bus. You can access domains in AquaLogic Service Bus from Tuxedo. Also you can access tuxedo domains from AquaLogic Service Bus. For more information about Tuxedo transport, see Interoperability Solution for Tuxedo.

Data Services Platform (DSP)

AquaLogic Service Bus provides optimized transport for 1-way or 2-way communication for invoking services on AquaLogic Data Services Platform Data using a native Data Services Platform (DSP) transport. You access the AquaLogic Data Services Platform from AquaLogic Service Bus thus allowing an AquaLogic Service Bus client to make full use of data services. For detailed information on accessing AquaLogic Data Services Platform from AquaLogic Service Bus, see


http://download.oracle.com/docs/cd/E13171_01/alsb/docs26/pdf/aldsp_transport_for_alsb2_6.pdf

You can select the DSP transport protocol when you configure SOAP or XML business service types. To learn more, see “ Adding a Business Service” in Using the AquaLogic Service Bus Console.

If you create a proxy service from a DSP transport business service, AquaLogic Service Bus will switch the transport type of the proxy service to HTTP. This is because the DSP transport cannot be used for proxy services. You can then change the transport type of the proxy service to any other available transport.

To learn more, see “ Adding a Proxy Service” in Using the AquaLogic Service Bus Console.

User Guide

Transports

E-mail

Configuring Proxy Services using E-mail Transport Protocol

Configuring Business Services using E-mail Transport Protocol

EJB

File

Configuring Proxy Services using File Transport Protocol

Configuring Business Services using File Transport Protocol

FTP

Configuring Proxy Services using FTP Transport Protocol

Configuring Business Services using FTP Transport Protocol

HTTP

Configuring Proxy Services using HTTP Transport Protocol

Configuring Business Services using HTTP Transport Protocol

HTTP(S)

Configuring Proxy Services using HTTP(S) Transport Protocol

Configuring Business Services using HTTP(S) Transport Protocol

JMS

Configuring Proxy Services using JMS Transport Protocol

Configuring Business Services using JMS Transport Protocol

Local

Tuxedo

Data Services Platform (DSP)