Skip Headers
Oracle® Communications Service Broker Signaling Domain Configuration Guide
Release 6.0

Part Number E23526-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
View PDF

9 Configuring the Web Services Signaling Server Unit

This chapter describes how to configure the Service Broker Web Services Signaling Server Unit (SSU) using the Service Broker Administration Console and Java MBeans.

About the Web Service SSU

The Web Services SSU enables Service Broker Processing Tier components to communicate with external entities using SOAP or REST over HTTP. Service Broker can act as a Web services server or client to external entities through the Web Services SSU.

In general, you control Web service traffic through the Service Broker Signaling Tier using the following Web Services SSU components:

The Processing Tier components that rely on the Web Services SSU are the Web Services IM (WS-IM) and Service Broker applications, such as Top Up or Subscriber Provisioning. These applications expose SOAP APIs that clients use to configure and manage their services.

Enabling access to the SOAP APIs involves the following general configuration steps:

  1. Opening an HTTP listening port in the Web Services SSU configuration.

  2. Configuring SSL security or authentication requirements for the connection.

  3. Configuring an incoming routing rule that directs incoming client requests to the Web Service endpoint within Service Broker.

This chapter provides information about configuring the Web Services SSU. For more information about a particular SOAP API, see the implementation guide applicable to the Service Broker application, such as Service Broker Subscriber Data User's Guide.

The following procedures describe how to perform a task in the Administration Console. Alternatively, you can perform the configuration task by accessing the corresponding configuration MBean from any JMX MBean client. The following sections identify the configuration MBeans that contain the attributes that correspond to the GUI fields.

Configuring Incoming Routing Rules

You use the Incoming Routing Rules tab to define how the Web Services SSU routes incoming Web service messages to internal Service Broker IMs and other applications.

To configure incoming routing rules for Web service messages:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. In the SSU WS tab, click the Incoming Routing Rules tab.

    The Incoming Routing Rules pane contains a table in which each row represents one Web services endpoint.

  6. Click the New button.

    The New dialog box appears.

  7. In the dialog box, provide values for the fields listed in Table 9-1.

    Table 9-1 Web Services Incoming Routing Rules Parameters

    Field Description

    Name

    A unique name for the routing rule.

    Service Name

    The service name of the Service Broker Web service endpoint.

    Setting this field to Any causes all incoming web service messages to be routed to the specified module instance. This value is generally used to create a rule that routes incoming Web services messages to a default IM in the absence of a more specific routing rule.

    For the incoming routing rules for Service Broker applications that expose SOAP APIs, use the following service names:

    • BalanceManagerService: Use for the routing rule for the Top Up and Balance Manager API service.

    • SubscriberProvisioning: Use for the routing rule for the Subscriber Provisioning API service.

    Alias

    A logical name that specifies the Service Broker IM or application to which the Web Services SSU routes an incoming Web services message. The format differs depending upon whether you are routing to an internal service or an IM.

    The alias has the following format for IMs:

    ssu:IM_instance_name.IM_type@domain_id

    The alias has the following format for internal service:

    ssu:domain_Id/application_id

    Where:

    • IM_instance_name: Name of the destination IM instance. This is the IM name you specified when you added this IM in the IM configuration pane.

    • IM_type: Type of the destination IM instance.

    • domain-id: Name of the Processing Domain or Processing Domain Group where the relevant IM or application is deployed. This parameter is required only when your Service Broker deployment includes two or more Processing Domains.

      Use the name given to the domain when it was created. This name is specified by the axia.domain.id property.

      To set a Processing Domain Group, you must specify the group name. See "Managing Processing Domain Groups" in the Oracle Communications Service Broker Processing Domain Configuration Guide for more information.

    • application_id: Name of the destination Service Broker application.

      This is a static name assigned to each Service Broker application. This is topup for the Balance Manager API service and provisioning for the Subscriber Provisioning API service.

    For the Service Broker SOAP API services, use the following alias values (given the default domain ID of ocsb):

    • ssu:ocsb/topup: The alias for the Balance Manager API service.

    • ssu:ocsb/provisioning: The alias for the Subscriber Provisioning API service.


  8. Click OK to save the new incoming routing rule configuration.

To create the routing rule through the MBean interface, invoke the WSIncomingRoutingRulesMBean.createWSIncomingRoutingRule() operation. You can then modify the attributes of the new WSIncomingRoutingRuleMBean instance, which correspond to the fields in Table 9-1.

Configuring Outgoing Routing Rules

You use the Outgoing Routing Rules tab to define how the Web Services SSU routes outgoing Web service messages to external Web service endpoints.

In the rule, you specify the address of each external Web service endpoint and assign an alias to each endpoint. IMs and Service Broker applications use the alias to refer to an external Web service destination.

To configure outgoing routing rules for Web service messages:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General tab.

  5. In the SSU WS tab, click the Outgoing Routing Rules tab.

    The Outgoing Routing Rules pane contains a table in which each row represents one Web services endpoint.

  6. Click the New button.

    The New dialog box appears.

  7. In the dialog box, provide values for the fields listed in Table 9-2

    Table 9-2 Web Services Outgoing Routing Rules Parameters

    Field Description

    Name

    A unique routing rule name.

    Alias

    A logical name that you assign to the Web services endpoint.

    Web Service URI

    The Uniform Resource Identifiers (URI) used to address the Web services endpoint. The format of the address is similar to Web Uniform Resource Locators (URLs).

    For example:

    http://webservices.example.com/eventnotification

    Heartbeat

    Whether the Web Services SSU periodically checks the Web services endpoint availability. Select ON to activate periodic availability check, or OFF to disable it.

    Hearbeat Method

    The HTTP method used to check endpoint availability. Service Broker supports the GET only.

    This field is ignored if you set the Heartbeat field to OFF.

    Response Timeout

    The amount of time, in seconds, Service Broker waits for a response from the Web services endpoint before the endpoint is considered unavailable.

    This field is ignored if you set the Heartbeat field to OFF.

    Active Interval

    The amount of time, in seconds, between consecutive endpoint availability checks if the last availability check showed that the endpoint was available.

    Inactive Interval

    The amount of time, in seconds, between consecutive endpoint availability checks if the last availability check showed that the endpoint was unavailable.


  8. Click OK to save the new outgoing rule configuration.

To create the routing rule through the MBean interface, invoke the WSOutgoingRoutingRulesMBean.createWSOutgoingRoutingRule() operation. You can then modify the attributes of the new WSOutgoingRoutingRuleMBean instance, which correspond to the fields in Table 9-2.

Configuring HTTP Access Settings

To enable HTTP connections between Service Broker and external entities, you must configure the HTTP connection settings in the Web Services SSU.

The HTTP connection settings specify the port on which Service Broker listens for HTTP requests, timeout settings, security requirements, and general connection settings.

Configuring HTTP Server General Settings

The general HTTP server settings apply to connections to Service Broker through the Web Services SSU that are initiated by an external client.

To specify general timeout settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the HTTP tab.

    The General configuration pane under the Server subtab appears.

  6. Set the value of the Timeout field to the maximum number of milliseconds that Service Broker can use to process a request. If this time expires, Service Broker returns an error response to the client.

    Set to any value from 1000 and 60000. The default is 30000.

  7. Click Apply to save your change.

To configure the general HTTP server settings through the MBean interface, use httpConfigMBean.serverConfigMBean.

Configuring HTTP Server Network Access Settings

The network access point specifies the port on which the Web Services SSU listens for HTTP traffic, including HTTP traffic in the form of SOAP and REST messages.

To configure HTTP server network access settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the HTTP tab.

  6. In the Server subtab, click the Network Access subtab.

  7. Click the New button.

    The New dialog box appears.

  8. In the dialog box, provide values for the fields listed in Table 9-3.

    Table 9-3 HTTP Network Access Parameters

    Field Description

    Server Address

    The local IP address or hostname bound to this HTTP listener.

    Server Port

    An available port number on which the Signaling Server listens for HTTP traffic. Be sure to avoid entering a port number already in use by the system.

    Protocol

    The protocol used for the port, either HTTP or HTTPS for Secure HTTP.

    SSL Client Auth

    Whether to enable SSL client authentication for this access point.

    Set to true to enable SSL client authentication. Enable SSL client authentication only if this network access point uses HTTPS protocol. If enabled, clients attempting to connect to this access point must present a client certificate that matches one in the truststore.

    Set to false to disable SSL client authentication.

    For more information on security, see Service Broker Administration Guide.

    Keystore ID

    The identifier of the security keystore for the connection in the Credential Store. Only applicable if this network access point uses HTTPS.

    See Service Broker Administration Guide for more information on using the Credential Store.

    Truststore ID

    The identifier of the security truststore in the Credential Store. Only applicable if this network access point uses HTTPS.

    See Service Broker Administration Guide for more information on using the Credential Store.

    Target

    The target Signaling Server to which this configuration applies. If empty, it applies to all servers.


  9. Click OK to save the new HTTP access configuration.

To create the HTTP network access point through the MBean interface, invoke the serverConfigMBean.addNetworkAccessPoint() operation. You can then modify the attributes of the new networkAccessPointMBean instance, which correspond to the fields in Table 9-3.

Creating or Modifying HTTP Server Security Contexts

You use the Security Context tab to apply authentication requirements to the resources exposed by Service Broker through the Web Services SSU. When authentication is required, Service Broker validates the credentials provided in incoming requests.

Note:

The HTTP server security context applies HTTP Basic Authentication requirements to requests. Alternatively, you can require credentials in the form of Web Service Security (WSSE) UsernameToken credentials. See "Authenticating SOAP Requests with WSSE UsernameToken Credentials" for more information.

You associate a security requirement to a resource by configuring a security context by URI path.

For instance, the default REST root URI context is exposed at /rest. If HTTP Basic Auth is enabled for this address, any resource available under the REST root URI (such as /rest/subscriber) has the same requirement, unless a more specific security context applies to it.

To configure a security context for HTTP access:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the HTTP tab.

  6. In the Server subtab, click the Security Context subtab.

  7. In the Security Context pane, you can either:

    • Click New to create a new context.

    • Select an existing context in the list and click Update to modify its values.

  8. In the dialog box, provide values for the fields listed in Table 9-4.

    Table 9-4 HTTP Security Context Parameters

    Field Description

    Context URI

    The URI to which the security requirement applies.

    Auth Method

    The authentication method applied to the resource. Options are:

    • NONE: No authentication is required.

    • BASIC: HTTP Basic Authentication is required to access the resource.

    Realm

    The security realm value to be presented to clients who do not provide credentials.

    Username

    The required user name to be included in the requests.

    Credential Key

    A key that identifies the credential in the Credential Store. This key is a name for the credential provided when loading the password associated with the user in the Credential Store.

    See Service Broker Administration Guide for more information on the Credential Store.


  9. Click OK to save the new security context configuration.

To create the security context through the MBean interface, invoke the serverConfigMBean.addSecurityContext() operation. You can then modify the attributes of the new securityContextMBean instance, which correspond to the fields in Table 9-4.

Configuring HTTP Client Settings

The HTTP client settings apply to outgoing connections. In this case, Service Broker acts as a client to external HTTP servers through the Web Services SSU.

To configure HTTP client settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the HTTP tab.

  6. Click the Client tab.

  7. Modify, if required, the default settings for the outgoing connection listed in Table 9-5.

    Table 9-5 HTTP Client Parameters

    Field Description

    Connect Timeout

    The amount of time, in milliseconds, Service Broker allows for establishing an HTTP connection to a remote server. If the timeout expires before receiving data, the connect attempt is abandoned.

    The default value is 50000 milliseconds. Value must be from 1000 to 60000.

    Read Timeout

    The amount of time, in milliseconds, Service Broker allows for reading data from a remote server on the established connection. If the timeout expires, the read attempt is aborted.

    The default value is 30000 milliseconds. Value must be from 1000 to 60000.


  8. Click Apply to save your changes to the configuration.

To configure the HTTP client settings through the MBean interface, use httpConfigMBean.clientConfigMBean.

Configuring SOAP Web Service Access

As an HTTP-based protocol, SOAP is subject to the common HTTP connection settings configured in the HTTP tab. These include, for example, the port on which Service Broker listens for HTTP traffic, Basic Authentication security, and so on. See "Configuring HTTP Access Settings" for information on configuring common HTTP access settings.

In addition, you can configure specific settings that apply to SOAP-based communication with external SOAP clients or servers.

Configuring SOAP Server Settings

The SOAP server settings apply to client connections to Service Broker in which Service Broker acts as the Web Service provider or server front-end. These include connections made to the Subscriber Profile API and Balance Manager API services.

To enable the SOAP services, you must configure HTTP access settings. You can then configure specific settings for SOAP access as described in this section.

Configuring Common SOAP Server Settings

To configure general SOAP access settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the SOAP tab.

    The Server settings pane appears.

  6. Verify and, if required, modify the default settings listed in Table 9-6.

    Table 9-6 SOAP Server Parameters

    Field Description

    Root URI

    The path root for the SOAP API services provided by Service Broker. The default is /soap.

    Together with the service location, this root path forms the complete URI for accessing the SOAP resource at the Service Broker Signaling Domain.

    For example, given the default path for the root URI and Subscriber Provisioning service, the full path would be:

    https://hostname:port/soap/SubscriberProvisioning

    Timeout

    The maximum amount of time, in milliseconds, Service Broker may take to generate a response before returning an error response to the client.

    The default value is 10000 milliseconds. Values can be from 1000 to 60000.


  7. Click Apply to save your changes to the configuration.

To configure the SOAP server settings through the MBean interface, use wsSoapConfigMBean.serverConfigMBean.

Configuring the URI Path for a Specific SOAP Service

To view or change the URI path of a SOAP service, follow these steps:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Select the name of the service for which you want to modify the existing URI path, either Subscriber Provisioning or Balance Manager.

  5. In the End Point tab, click the URI context for the service.

  6. Click the Update button.

  7. Set the URI field to the value of the new path. The path value should be preceded by a forward slash character, as in the default value.

    By default, this is /SubscriberProvisioning for the Subscriber Provisioning SOAP service, and /BalanceManagerService for the Balance Manager SOAP service. Together with the root URI path, this path makes up the URI at which clients address the SOAP service.

  8. Click OK.

See "Authenticating SOAP Requests with WSSE UsernameToken Credentials" for information on configuring the authentication fields for the SOAP service.

To configure the Web service paths through the MBean interface, use either endpointMBean (for Subscriber Store Web Service) or endpointMBean (for Top Up Web Service).

Configuring SOAP Client Parameters

The SOAP client settings apply to outgoing connections. In this case, Service Broker acts as a client to external SOAP Web service providers.

To configure SOAP client settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the SOAP tab.

  6. Click the Client subtab.

  7. Enter values for the fields listed in Table 9-7.

    Table 9-7 SOAP Client Parameters

    Field Description

    Connect Timeout

    The amount of time, in milliseconds, Service Broker allows for establishing a connection to a remote server. If the timeout expires before Service Broker establishes the connection, the connect attempt is abandoned.

    The default value is 5000. Values can be from 1000 to 60000. To disable time outs, set this value to 0.

    Read Timeout

    The amount of time, in milliseconds, Service Broker allows for reading data from a remote server on an established connection. If the timeout expires, the read attempt is aborted.

    The default value is 30000. Values can be from 1000 to 60000. To disable time outs, set the value to 0.


  8. Click Apply to save your changes to the configuration.

To configure the SOAP client settings through the MBean interface, use wsSoapConfigMBean.clientConfigMBean.

Authenticating SOAP Requests with WSSE UsernameToken Credentials

Service Broker can authenticate incoming SOAP requests that contain WSSE UsernameToken credentials, as specified by OASIS UsernameToken Profile 1.0. For general information on WSSE UsernameToken, see the OASIS Web Service Security specifications at:

http://www.oasis-open.org/

You enable WSSE UsernameToken credential requirement by SOAP service. That is, it can be enabled for the Subscriber Provisioning service and disabled for the Balance Manager service, for example.

A service that requires WSSE UsernameToken authentication should not be configured to require an HTTP Basic Authentication credential as well. See "Creating or Modifying HTTP Server Security Contexts" for more information about HTTP Basic Authentication security contexts.

Service Broker validates the WSSE UsernameToken credential against credentials stored in the Service Broker Credential Store. Before configuring service authentication as described below, add the credential to be authenticated to the Credential Store. See Service Broker Administration Guide for information about the Credential Store.

To apply WSSE UsernameToken credential authentication to incoming SOAP service requests, follow these steps:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the SOAP tab.

  6. Click the Credential Store subtab.

  7. In the Key field, enter an alias for the credential.

  8. In the Password field, enter the password value for the credential.

  9. Verify that HTTP Basic Authentication is disabled for the underlying HTTP security context for the SOAP service as follows:

    1. Click the HTTP tab under the SSU Web Services node.

    2. In the Server subtab, click the Security Context subtab.

    3. Verify that the Auth Method value is NONE for the Context URI path applicable to the Web service. By default, the context path for all SOAP Web services exposed by Service Broker is /soap.

    4. If necessary, select the security context item and click the Update button to change the Auth Method.

  10. Under the OCSB navigation tree, expand, if necessary, the Signaling Tier node and then the SSU Web Services node.

  11. Click the name of the service for which you want to require WSSE UsernameToken authentication, either BALANCE MANAGER or SUBSCRIBER PROVISIONING.

  12. In the End Point tab, click on the URI context for the service.

  13. Click the Update button.

  14. For the Authentication Method value, choose USERNAME_TOKEN.

  15. For the Username value, enter the user name portion of the credential to be authenticated by WSSE UsernameToken authentication.

  16. For the Credential Key value, enter the credential alias you used when storing the password to be validated into the Credential Store.

  17. Click OK to save your changes to the configuration.

Clients of the service must submit valid WSSE UsernameToken credentials with their service requests.

To configure the SOAP authentication for the services through the MBean interface, use the interface of endpointMBean (for Subscriber Store Web Service) or endpointMBean (for Top Up Web Service).

Configuring REST Web Service Access

As an HTTP-based protocol, REST-based communication is subject to the common HTTP connection settings configured in the HTTP tab. These include, for example, the port on which Service Broker listens for HTTP traffic, Basic Authentication security, and so on. See "Configuring HTTP Access Settings" for information on configuring common HTTP access settings.

In addition, you can configure specific settings that apply to REST-based communication with external REST clients or servers.

Configuring REST Server Parameters

The REST server settings apply to client connections made to Service Broker in which Service Broker acts as the server or server front-end for a REST API service.

To configure REST server settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the REST tab.

  6. In the Server tab, verify and, if required, modify the default settings listed in Table 9-8.

    Table 9-8 REST Server Parameters

    Field Description

    Root URI

    The URI path at which Service Broker exposes REST APIs. This path value forms the root of the address that clients use to access REST resources.

    For example, given the default path of /rest, the full address of a REST resource would be:

    https://hostname:port/rest/subscriber/carol

    Timeout

    The amount of idle time, in milliseconds, after which Service Broker releases a client connection on which it is awaiting data.

    The default value is 10000 milliseconds. Values can be from 1000 to 60000. To disable timeout, set the timeout to 0.


  7. Click Apply to save your changes to the configuration.

To configure the REST server settings through the MBean interface, use wsRestConfigMBean.clientConfigMBean.

Configuring REST Client Parameters

The REST client settings apply to outgoing connections. In this case, Service Broker acts as a client to external REST Web service providers.

To configure REST client settings:

  1. In the navigation tree in the domain navigation pane, expand OCSB.

  2. Expand Signaling Tier.

  3. Expand the SSU Web Services node.

  4. Click the General item.

  5. Click the REST tab.

  6. Click the Client subtab.

  7. Verify and, if required, modify the default settings listed in Table 9-9.

    Table 9-9 REST Client Parameters

    Field Description

    Connect Timeout

    The amount of time, in milliseconds, Service Broker allows to establish a connection to a remote server. If the timeout expires before receiving data, the connection attempt is abandoned.

    The default value is 5000. Values can be from 1000 to 60000. To disable timeout, set the timeout to 0.

    Read Timeout

    The amount of time, in milliseconds, Service Broker allows for reading data from a remote server on an established connection. If the timeout expires, the read attempt is abandoned.

    The default value is 30000 milliseconds. Values can be from 1000 to 60000. To disable timeout, set the timeout to 0.


  8. Click Apply to save your changes to the configuration.

To configure the REST client settings through the MBean interface, use wsRestConfigMBean.serverConfigMBean.

Web Services SSU Configuration MBeans Reference

Figure 9-1 shows the hierarchy of the configuration MBeans that you use to configure the Web Services SSU.

Figure 9-1 Web Services SSU and Related Configuration MBeans

Surrounding text describes Figure 9-1 .

The following sections provide reference information for the Web Services SSU 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.

WebServicesSsuMBean

The root MBean for the Web Services SSU configuration.

Object Name

com.convergin:Type=WebServicesSsu,Version=2.0.0.0,Location=AdminServer,Name=ssuws.ssuws

Factory Method

Created automatically

Attributes

Operations

None


WSIncomingRoutingRulesMBean

A container for instances of WsIncomingRoutingRulesMBean, which represent the Web Services SSU inbound routing rule configuration.

Object Name

com.convergin:Type=WSIncomingRoutingRules,Version=2.0.0.0,Location=AdminServer,Name=ssuws.ws_inbound_routing

Factory Method

Created automatically

Attributes

The list of WSIncomingRoutingRuleMBean instances.

Operations

createWSIncomingRoutingRule()

Creates a new instance of WSIncomingRoutingRuleMBean.

destroyWSIncomingRoutingRule()

Removes an existing instance of WSIncomingRoutingRuleMBean.

lookupWSIncomingRoutingRule()

Searches for an instance of WSIncomingRoutingRuleMBean.


WSIncomingRoutingRuleMBean

An instance of an incoming routing rule. Each rule specifies how to route inbound Web services messages to a Service Broker IM or internal application.

For each rule, you specify a service name and the address alias of the internal application or IM destination.

Object Name

com.convergin:Type=WSIncomingRoutingRule,Version=2.0.0.0,Location=AdminServer,Name=ssuws.instance_name

Factory Method

WSIncomingRoutingRulesMBean.createWSIncomingRoutingRule()

Attributes

See Table 9-1 for information about these attributes.


WSOutgoingRoutingRulesMBean

A container for instances of WSOutgoingRoutingRuleMBean, which represent Web Services SSU outbound routing rules.

Object Name

com.convergin:Type=WSOutgoingRoutingRules,Version=2.0.0.0,Location=AdminServer,Name=ssuws.ws_outbound_routing

Factory Method

Created automatically

Attributes

The list of WSOutgoingRoutingRuleMBean instances.

Operations

createWSOutgoingRoutingRule()

Creates a new instance of WSOutgoingRoutingRuleMBean.

destroyWSOutgoingRoutingRule()

Removes an existing instance of WSOutgoingRoutingRuleMBean.

lookupWSOutgoingRoutingRule()

Searches for an instance of WSOutgoingRoutingRuleMBean.


WSOutgoingRoutingRuleMBean

An instance of an outgoing routing rule. Each rule specifies how to route outbound Web services messages to external Web service end points.

For each rule, you specify an address, an alias, and how to check the availability of the endpoint.

Object Name

com.convergin:Type=WSOutgoingRoutingRule,Version=2.0.0.0,Location=AdminServer,Name=ssuws.instance_name

Factory Method

WSOutgoingRoutingRulesMBean.createWSOutgoingRoutingRule

Attributes

See Table 9-2 for information about these attributes.


httpConfigMBean

A container for instances of clientConfigMBean and serverConfigMBean, which provide common settings applicable to HTTP connections for the Web Services SSU.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.http,version=2.0.0,name0=httpConfig

Factory Method

Created automatically


clientConfigMBean

The HTTP client settings for the Web Services SSU. The settings apply to HTTP connections initiated by Service Broker to external HTTP servers.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.http,version=2.0.0,name0=httpConfig,name1=clientConfig

Factory Method

Created automatically

Attributes

See Table 9-5 for information about these attributes.


serverConfigMBean

The HTTP server settings for the Web Services SSU. The settings apply to HTTP connections made to Service Broker by HTTP clients.

This MBean also acts as a container for instances of networkAccessPointMBean and securityContextMBean.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.http,version=2.0.0,name0=httpConfig,name1=serverConfig

Factory Method

Created automatically

Attributes

See "Configuring HTTP Server General Settings" for information about this attribute.

Operations

addNetworkAccessPoint()

Creates a new networkAccessPoint MBean.

removeNetworkAccessPoint()

Removes an existing networkAccessPoint MBean.

addSecurityContext()

Creates a new HTTP securityContext MBean instance.

removeSecurityContext()

Removes an existing securityContext MBean instance.


networkAccessPointMBean

An instance of an HTTP network access point. The network access point defines port number on which Service Broker listens for HTTP traffic.

For each access point, you specify the protocol type (HTTP or HTTPS), listen port number, and any SSL-level security requirements for connections.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.http,version=2.0.0,name0=httpConfig,name1=serverConfig,name2=networkAccessPoint[instance_number]

Factory Method

httpConfig.serverConfig.addNetworkAccessPoint()

Attributes

See Table 9-3 for information about these attributes.


securityContextMBean

An instance of an HTTP security context. The security context defines HTTP-level client authentication requirements for accessing resources by URI.

The HTTP-level client authentication mechanisms are SSL client certificate authentication and HTTP Basic Authentication. See "serverConfigMBean" for information on configuring an authentication requirement based on WSSE UsernameToken credentials.

For each security context, you specify the protocol type (HTTP or HTTPS), listen port number, and any SSL-level security requirements for connections.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.http,version=2.0.0,name0=httpConfig,name1=serverConfig,name2=securityContext[instance_number]

Factory Method

Created automatically

Attributes

See Table 9-4 for information about these attributes.


wsSoapConfigMBean

The root MBean for the settings that apply to HTTP connections used to pass REST traffic between Service Broker and external clients or servers.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.soap,version=2.0.0,name0=wsSoapConfig

Factory Method

Created automatically


clientConfigMBean

The SOAP client settings for the Web Services SSU. The settings apply to HTTP connections used to pass SOAP traffic between Service Broker and external servers.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.soap,version=2.0.0,name0=wsSoapConfig,name1=clientConfig

Factory Method

Created automatically

Attributes

See Table 9-7 for information about these attributes.


serverConfigMBean

The SOAP server settings for the Web Services SSU. The settings apply to HTTP connections used to pass SOAP traffic between Service Broker and external clients.

Note that to configure WSSE UsernameToken authentication requirements, set a credential in the Credential Store by using the following MBean:

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.soap,version=2.0.0,name0=CredentialStore

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.soap,version=2.0.0,name0=wsSoapConfig,name1=serverConfig

Factory Method

Created automatically

Attributes

See Table 9-6 for information about these attributes.


wsRestConfigMBean

The root MBean for the settings that apply to HTTP connections used to pass REST traffic between Service Broker and external clients or servers.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.rest,version=2.0.0,name0=wsRestConfig

Factory Method

Created automatically


clientConfigMBean

The REST client settings for the Web Services SSU. The settings apply to HTTP connections used to pass REST traffic between Service Broker and external servers.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.rest,version=2.0.0,name0=wsRestConfig,name1=clientConfig

Factory Method

Created automatically

Attributes

See Table 9-9 for information about these attributes.


serverConfigMBean

The REST server settings for the Web Services SSU. The settings apply to HTTP connections used to pass REST traffic between Service Broker and external clients.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.protocol.ws.rest,version=2.0.0,name0=wsRestConfig,name1=serverConfig

Factory Method

Created automatically

Attributes

See Table 9-8 for information about the attributes.


endpointMBean (for Subscriber Store Web Service)

An automatically created instance MBean that specifies the URI path on which the Web Services SSU exposes the Subscriber Store SOAP API.

For information on using the Subscriber Store API, see Service Broker Subscriber Data User's Guide.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.ocsb.app.rcc.service.subscriber_store.provisioning.soap_ws,version=6.0.0.SNAPSHOT, name0=webServiceSoap,name1=endpoint[0]

Factory Method

oracle.ocsb.app.rcc.service.subscriber_store.provisioning.soap_ws.webServiceSoap.addEndpoint()

Attributes

See Table 9-8 for information about the attribute.


endpointMBean (for Top Up Web Service)

An automatically created instance MBean that specifies the URI path on which the Web Services SSU exposes the Top Up SOAP API.

For information on using the Top Up API, see Service Broker Online Mediation Implementation Guide.

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.ocsb.app.rcc.feature.topup.ws.soap_ws,version=6.0.0.SNAPSHOT,name0=webServiceSoap, name1=endpoint[0]

Factory Method

oracle.ocsb.app.rcc.feature.topup.ws.soap_ws.webServiceSoap.addEndpoint()

Attributes

See Table 9-8 for information about the attribute.