Downloads  |  Product Documentation  |  Support

   All Blogs Corporate Site CRM On Demand Discussion Forums Documentation Education PartnerNetwork (Public Only) Technology Network Video and Multimedia  

OTN Home      Oracle Forums      Community     

HTTP and Poller Transports User Guide

Transports

You can use different types of transports to configure proxy services or business services in Oracle Service Bus. 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.

Poll-based transports are transports with transport pollers pinned to a managed server. These transports use the JMS framework to ensure that the processing of a message is done at least once. E-mail, File, FTP, and SFTP are poll-based transports. This section describes the poll-based transports and the HTTP transport. For information on SFTP, see SFTP Transport.

This document includes the following sections:

HTTP Transport

The HTTP transport lets you send messages between clients and service providers through Oracle Service Bus using the http/s protocol. The HTTP transport also provides support for working with REST (Representational State Transfer) environments, as described in REST Support.

You can select the HTTP transport protocol when you configure any type of proxy or business service. Use the following endpoint URI formats:

where someService is the name of proxy service or a business service

Configuring Proxy Services using the HTTP Transport

Table 1-1 describes the parameters you can specify to configure the HTTP transport for a proxy service.

For more information on how to configure HTTP transport based proxy services and advanced settings, see Transport Configuration in Using the Oracle Service Bus Console.

Configuring Business Services using the HTTP Transport

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

http://<host:port/someService>

where:

Table 1-2 describes all the parameters you can specify to configure HTTP transport for a business service.

For more information on how to configure this transport, see Transport Configuration in Using the Oracle Service Bus Console.

REST Support

The HTTP transport provides support for working with REST (Representational State Transfer) environments through Oracle Service Bus, whether you have REST clients that need to interact with non-REST service providers, non-REST clients that need to interact with REST-based service providers, or REST-to-REST services you want to expose through Oracle Service Bus.

In a REST pattern, you invoke HTTP methods (such as GET, PUT, HEAD, POST, and DELETE) on resources that are located at specific URLs. For example, when a user updates his own profile information in a Web application that uses REST, a POST action updates the user information in the database through the service’s REST API.

Oracle Service Bus provides the following placeholder variables for handling REST-based requests for inbound and outbound communication:

REST in Proxy Services

With an Oracle Service Bus proxy service, you have the flexibility to interact with REST patterns, whether you are receiving REST-based requests or generating REST-based actions.

For example, if your team wants to develop REST-based applications and invoke services in a non-REST service provider, you can send REST operations through a proxy service and transform those operations into a format the service provider understands; or you could transform a non-REST request into a resource URL and invoke an operation in a REST-based service provider.

XQuery Examples

Following are XQuery examples of URI parsing using HTTP variables in a proxy server.

Relative-URI

A proxy service has a URI http://localhost:7001/weather, and you want to capture the relative URI parts of a request. You create the following XQuery:

<relative-URI>
{
for $c in
fn:tokenize($inbound/ctx:transport/ctx:request/http:relative-URI, "/")
where fn:string-length($c) != 0
return
<part>
{$c}
</part>
}
</relative-URI>

If a request comes with the URI of http://localhost:7001/weather/temperature/35457, the relative-URI will be /temperature/35457, and the XQuery output will be:

<relative-URI>
    <part>temperature</part>
    <part>35457</part>
</relative-URI>

Query-String

A proxy service has a URI http://localhost:7001/weather, and you want to capture the URL query string. You create the following XQuery:

<query-params>
{
for $c in
fn:tokenize($inbound/ctx:transport/ctx:request/http:query-string, "&amp;")
return 
<param name="{fn:substring-before($c,"=")}"
value="{fn:substring-after($c,"=")}"></param>
}
</query-params>

If a request comes with a URI of http://server:7001/weather?operation=temperature&pincode=35457, the query-string will be operation=temperature&pincode=35457, and the XQuery output will be:

<query-params>
    <param name=’operation’ value=’temperature’/>
    <param name=’pincode’ value=’35457’/>
</query-params>

Headers

If your service requires specific headers to handle HTTP/REST methods, create user-defined HTTP header variables in your proxy service message flow.

REST in Business Services

With an Oracle Service Bus business service, you can invoke REST-based services.

For REST operations, the HTTP transport uses the value in the $outbound/transport/request/http:http-method variable. If that variable does not supply an HTTP method, the HTTP transport lets you select one of the following HTTP Request Methods in the transport configuration: POST, PUT, HEAD, GET, AND DELETE.

Using the $outbound/transport/request-http/http-method variable, you can also supply your own methods. For example, you can use COPY, MOVE, and LOCK for WebDAV environments (Web-based Distributed Authoring and Versioning).

Use the following guidelines for setting $outbound variables:

Response Codes for HTTP Business Services

The HTTP transport provides the following response codes for HTTP methods:

E-mail Transport

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 topics describe how to configure proxy services and business service using the E-mail transport.

Configuring Proxy Services using the E-mail Transport

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

mailfrom:<mailserver-host:port>

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

Table 1-3 describes the parameters you can configure for an e-mail transport based proxy service.

For more information on how to configure e-mail services, see Transport Configuration in Using the Oracle Service Bus Console.

Configuring Business Services using the E-mail Transport

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

mailto:<name@domain_name.com>

where <name@domain_name.com> is the e-mail destination.

Table 1-4 describes the parameters you can configure for an e-mail transport based proxy service.

For more information on how to configure this transport, see Transport Configuration in Using the Oracle Service Bus Console.

File Transport

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:

file:///<root-dir/dir1>

where root-dir/dir1 is the absolute path to the destination directory.

Configuring Proxy Services using the File Transport

Table 1-5 describes the parameters you can specify to configure the file transport for a proxy service.

For more information on how to configure file transport based proxy services, see Transport Configuration in Using the Oracle Service Bus Console.

Configuring Business Services using the File Transport

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

file:///<root-dir/dir1>

where root-dir/dir1 is the absolute path to the destination directory.

Table 1-6 describes the parameters you can specify to configure the file transport for a proxy service.

For more information on how to configure this transport, see Transport Configuration in Using the Oracle Service Bus Console.

FTP Transport

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:

ftp://<hostname:port/directory>

where

Configuring Proxy Services using the FTP Transport

Table 1-7 describes the parameters you can specify the parameters to configure the FTP transport for a proxy service.

For more information on how to configure file transport based proxy services, see Transport Configuration in Using the Oracle Service Bus Console.

Configuring Business Services using the FTP Transport

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:

ftp://<hostname:port/directory> 

where

Table 1-8 describes the parameters you must specify to configure the FTP transport for a business service.

For more information on how to configure this transport, see Transport Configuration in Using the Oracle Service Bus Console.

Copyright © 1994, 2016, Oracle and/or its affiliates. All rights reserved.