Using the Oracle B2B Web Services

Introduction to Oracle B2B Web Services

Oracle B2B exposes web services to retrieve the document details in Oracle JDeveloper. These are partner-facing web services, where the user can send messages to Oracle B2B. Similarly, Oracle B2B provides a web service exposed to the back end to receive the messages, and process and send to partner, based on the agreements deployed in Oracle B2B.

To use the Oracle B2B web services, create a web service proxy in your application in Oracle JDeveloper. The Web Services Description Language (WSDL) files for the web services are available at the following URLs on the system where Oracle B2B is installed.

http://host_name:port_number/b2b/services/

A URL suffixed with just a URL pattern of Servlet entered in the Web browser, without any URI, provides the list of WSDLs available for download (with no security restrictions).

Oracle B2B provides the following web service APIs:

Outbound Web Service API provides a built-in internal listening channel. See Using the Outbound Web Service for more information.
Query API helps to retrieve the configured details in Oracle B2B. See Using the Query API for more information.

Security For Oracle B2B Web Services

Oracle Web Services Manager allows integrating various types of policies without impacting the runtime and flow of the web service, and it provides security of service infrastructure. Signing, encryption/decryption, authentication, authorization, auditing, and reporting will be provided by this tool kit. Hence, this web service implementation will not address the details of security, signing, and encryption. Web service methods hold the business logic instead of security details. Based on the policy enforced in Oracle Weblogic Server console, the web service client must attach security details with the web services port.

Using the Outbound Web Service

The Outbound Web Service is exposed as a built-in internal listening channel, and messages are enqueued to this service. Based on the details and headers in soap:body, agreement identification is done and the message are routed to the partner.

The following SOAP headers are used to pass information required to find a trading partner agreement in the case of B2B web services:

<To xmlns="http://com.oracle.b2b/soap">GlobalChips</To>
<DocVersion xmlns="http://com.oracle.b2b/soap">4010</DocVersion>
<From xmlns="http://com.oracle.b2b/soap">Acme</From>
<DocType xmlns="http://com.oracle.b2b/soap">850</DocType>

Table 20-1, Table 20-2, and Table 20-3 describe the Outbound Web Service request, response and fault notification message parameters.

Table 20-1 Outbound Web Service Request Parameters

Header	Data Type	Description	Required
from	String	Host name or identification value	No
to	String	Trading Partner name or identification value	Yes
@type	String Example: `DUNS`	Identification type	No
documentProtocolVersion	String Example: `4010`	Document type version	Yes^*
documentTypeName	String Example: `850`	Document type name	Yes^*
action	String Example: `PurchaseOrder`	ebMS action name	Yes ^*
service	String Example: `OrderProcessing`	ebMS service name	Yes ^*
serviceType	String Example: `string` Default: `string`	ebMS service type	Yes ^*
messageId	String Example: `123456789`	Message ID given in this parameter is used to create `APP_Message`.	No
replyToMessageId	String Example:`<reply_msgID>:collaborationID`	Holds the message ID of which message this reply goes to, along with the collaboration ID.	No
messageType	String Examples: INVALID (0) REQ (1) RESP (2) ACK (3) IN_BAND_EXCEPTION (4) OUT_OF_BAND_EXCEPTION (5 STATUS_REQ (6) STATUS_RESP (7) PULL (8) FUNCTIONAL_ACK (9) BATCH_REQ (10) OTHER (99) PING (11) PONG (12) TA1(13)	Type of the message	No
encoding	String Example: `ISO-8859-1` Default: `UTF-8`	Encoding format	No
payload	Xsd:anyType	Holds the payload	Yes
attachment	Xsd:anyType	Attachment, if any	No

^*Either documentProtocolVersion and documentTypeName must be present, or action, service, and serviceType must be present. A custom generic case only requires action and not the others.

Table 20-2 Outbound Web Service Response Parameters

Header	Data Type	Description	Required
isTransmitted	Boolean	If `true`, the message was successfully transmitted to Oracle B2B; otherwise `false`.	Yes

Table 20-3 Outbound Web Service Fault Message Parameters

Header	Data Type	Description
ExceptionMessage	String	If a fault is found, the Exception Stack Trace is transmitted.

Using the Query API

The Query API retrieves the configured details from Oracle B2B, and share them with applications.

Before initiating a message transmission from applications, a health check request is made for the given parameters. This check finds if any configurations exist, and how many are active. If no configuration is found, the application can stop message flow in its layer with the message "no configuration found in B2B."

The following APIs are provided:

Is Trading Partner Agreement Setup returns true if agreement found for the given inputs. See Is Trading Partner Agreement Setup Parameters for parameter details.
Get Trading Partner Agreement Information returns agreement details. See Get Trading Partner Agreement Information Parameters for parameter details.

Is Trading Partner Agreement Setup Parameters

Table 20-4, Table 20-5, and Table 20-6 describe the Trading Partner Agreement Setup message parameters.

Table 20-4 Is Trading Partner Agreement Setup Request Parameters

Header Data Type Description Required

from

String

Host name or identification value

No

to

String

Trading Partner name or identification value

No

@type

String

Example: DUNS

Identification type

No

Table 20-5 Is Trading Partner Agreement Setup Response Parameters

Header	Data Type	Description	Required
MatchedTPACount	integer	Number of Agreements present in an active state in the Oracle 2B Repository	Yes

Table 20-6 Is Trading Partner Agreement Setup Fault Message Parameters

Header	Data Type	Description
ExceptionMessage	String	If a fault is found, the Exception Stack Trace is transmitted.

Get Trading Partner Agreement Information Parameters

Table 20-7, Table 20-8, and Table 20-9 describe the Trading Partner Agreement Information message parameters.

Table 20-7 Get Trading Partner Agreement Information Request Parameters

Header	Data Type	Description	Required
from	String	Host name or identification value	No
to	String	Trading Partner name or identification value	No
@type	String Example: `DUNS`	Identification type	No
document	String Example: `Sales Order`	Name of the internal application document or AIA EBO to be sent out	No
action	String Example: `Update`	A sub-classification which identifies the specific interaction with the Trading Partner	No

Table 20-8 Get Trading Partner Agreement Information Response Parameters

Header	Data Type	Description	Required
AgreementID	String	Unique Agreement ID of the matching agreement	Yes
B2BDocumentDef	String	Document definition in Oracle B2B used for creating the Oracle B2B document type	Yes
B2BDocumentType	String	Document type defined in Oracle B2B for the requested application document and action	Yes
B2BDocumentRevision	String	Document revision defined in Oracle B2B for the requested application document and action	Yes
B2BDocumentProtocol	String	Document Protocol name defined in Oracle B2B for the requested application document and action	Yes
Direction	String	Document direction	Yes
XSLTFile	String	XSLT file to be used by the AIA layer to generate the Oracle B2B TP document	No
DCName	String	Delivery Channel associated with the Trading Partner Agreement	Yes
ExchangeProtocol	String	Type of transport protocol to exchange messages with trading partner	Yes
SyncMode	True/False	True is Request Response; false is one-way	Optional for FTP and SMTP; required for HTTP/WS.

Table 20-9 Get Trading Partner Agreement Information Fault Message Parameters

Header	Data Type	Description
ExceptionMessage	String	If a fault is found, the Exception Stack Trace is transmitted.

Securing Oracle B2B Web Services

Web services exposed in B2B must be secured to hide the configuration details from intruders. The Oracle Web Services Manager policy approach provides the facility to secure the web services based on your requirements.

Web services endpoints are registered dynamically and programmatically using the oracle.webservices.provider.ProviderConfig.addService(...) API. Because these endpoints are not displayed in Oracle Enterprise Manager Fusion Middleware Control Console, Oracle B2B maintains the life cycle of Web services and their policies.

Limitations

There is no way to control the policy only for the particular endpoint. Whatever the policy specified, it is applicable for all the endpoints.

Removing already specified policy URI by clearing the Webservice Policy field does not work. You must enter some string in the field, such as "none".

No metrics are displayed for Oracle B2B Web service usage in Oracle Enterprise Manager Fusion Middleware Control Console.

To specify a policy and attach it to the web services endpoints:

In Oracle B2B Console, go to Administration>Configuration tab.
Enter the appropriate value in the Webservice Policy field in the Non Purgeable section.

Enter either the Oracle Web Services Manager policy URI to secure just the endpoints, or enter the whole <policy> tag to uptake RM, Addressing, and Logging. See the examples below.

See "Which OWSM Policies Are Supported for Java EE Web Services?" in Oracle Fusion Middleware Securing WebLogic Web Services for Oracle WebLogic Server for a listing of available Oracle WSM policies.
Click Save.

Based on the policy attached here, WSDL URL will start publishing/describing the policy details which need to be used while creating the proxy client for this service.

No restart of B2B is required to uptake the policy changes.

Example 20-1 Examples

Example 1: Enter the following URI in Webservice Policy to apply security policy oracle/wss_username_token_service_policy.

oracle/wss_username_token_service_policy

Example 2: Enter the following XML in Webservice Policy, which applies Security and RM policy.

<policy><policy-references><policy-reference uri="oracle/wss_username_token_ service_policy" category="security"/><policy-reference uri="oracle/wsrm11_policy"  category="wsrm"/></policy-references></policy>