35 Configuring IM-WS

The following sections describe how to configure IM-WS using the Service Broker Administration Console and Java MBeans.

About IM-WS

IM-WS is a network-facing module that enables Service Broker to receive messages from, and send messages to, web services using Simple Object Access Protocol (SOAP) or Representative State Transfer (REST) protocol.

In conjunction with application-facing modules, IM-WS provides a solution for routing messages from applications to web services.

IM-WS communicates with web services as follows:

• Sending messages from IM-WS to a web service:

  IM-WS receives a SAL message from an application-facing IM. For example, it might be an event notification submitted by an application and translated to the SAL format by an application-facing IM. IM-WS translates this message into a SOAP or REST message and send it to a web service through the WS SSU.

  See "Outbound Routing" in "Configuring the Web Services Signaling Server Unit" of the Oracle Communications Service Broker Signaling Domain Configuration Guide for more information about setting up rules for routing messages to web services.

• Sending messages from a web service to IM-WS:

  IM-WS receives a SOAP message sent by a web service through the WS SSU. IM-WS translates this message from SOAP or REST to a SAL message and sends it to the OE. The OE routes the message to an appropriate IM based on the orchestration logic.

  See "Inbound Routing" in "Configuring the Web Services Signaling Server Unit" of the Oracle Communications Service Broker Signaling Domain Configuration Guide for more information about setting up rules for routing messages to IM-WS instances.

To set up the communication between web services and IM-WS, you need to configure the following parameters:

• Web service parameters, which define the web service to which IM-WS sends a message. See "Configuring the Web Service Parameters" for more information.

• Monitoring parameters of IM-WS. See "Configuring Monitoring Parameters" for more information.

Configuring the Web Service Parameters

To route a message sent by an application to a web service and translated to the SAL format by an application-facing IM, IM-WS translates the SAL message into a SOAP or REST message. You can specify the parameters that IM-WS sets in the SOAP or REST message using the Administration Console or Java MBeans.

Configuring the Web Service Parameters with the Administration Console

To configure web service parameters:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Expand Interworking Modules.

4. Select the instance of IM-WS that you want to configure.

   The IM-WS configuration pane appears.

5. In the IM-WS configuration pane, click the Web Service tab.

6. Fill in the fields described in Table 35-1.

   Table 35-1 Web Service Parameters

   Field	Descriptions
   Web Service Alias	Specifies the address of the web service to which IM-WS sends the request. Service Broker resolves the alias into a physical address of a web service based on the configuration of outgoing routing rules of the WS SSU. See "Configuring Routing Rules for Outgoing Web Service Messages" in "Configuring the Web Services Signaling Server Unit" of the Oracle Communications Service Broker Signaling Domain Configuration Guide.
   Web Service Type	Specifies the type of the web service to which IM-WS sends the request. Possible values: SOAP REST Default value: SOAP
   Web Service Body Type	Specifies the content type of the message body that IM-WS sends. If the message is an event notification, set this parameter to eventnotification.

   
   

Configuring the Web Service Parameters with Java MBeans

To configure the web service parameters with Java MBeans, you use ImwsMBean. Figure 35-1 shows the hierarchy of the Web Service MBeans. See "IM-WS Configuration MBeans Reference" for the object names of these MBeans.

Figure 35-1 IM-WS Web Service Configuration MBeans

To configure the web service parameters:

• Set the following attributes of WebServiceMBean:

  • WebServiceAlias

  • WebServiceType

  • WebServiceBodyType

  See Table 35-1 for more information about these attributes.

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-WS. For more information about configuring monitoring, see "Configuring Monitoring with the Administration Console".

IM-WS Configuration MBeans Reference

The following sections provide reference information for the IM-WS configuration MBeans.

Note:

MBeans described in this guide may include additional advanced attributes, which are not described in the guide. Advanced attributes are reserved for internal use. Do not change these attributes.

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java MBeans":

• MonitoringGeneralMBean

• ThresholdCrossedNotificationRulesMBean

• ThresholdCrossedNotificationRuleMBean

• StateChangedNotificationRulesMBean

• StateChangedNotificationRuleMBean

---

ImwsMBean

ImwsMBean is the root MBean for IM-WS configuration.

Object Name

com.convergin:Type=IMWS,Version=MBean_Version,Location=AdminServer,Name=IM-WS.IM-WS

Factory Method

Created automatically.

Attributes

None

Operations

None

---

WebServiceMBean

WebServiceMBean enables you to set up the parameters of the web service to which IM-WS routes the message.

Object Name

com.convergin:Type=WebService,Version=MBean_Version,Location=AdminServer,Name=IM-WS.Instance_Name

Factory Method

Created automatically.

Attributes

• WebServiceAlias

• WebServiceType

• WebServiceBodyType

See Table 35-1 for more information about these attributes.

Operations

None