Skip Headers
Oracle® Communications IP Service Activator OSS Integration Manager Guide
Release 7.2
E36051-01
Go to Documentation Home
Home		 Go to Table of Contents
Contents		 Go to Feedback page
Contact Us
Go to previous page
Previous		 Go to next page
Next
PDF · Mobi · ePub

2 Web Services

This chapter describes the Oracle Communications IP Service Activator Web services, which can be used to integrate IP Service Activator with Oracle Communications Order and Service Management (OSM).

About Web Services

IP Service Activator provides a Web services interface through which OSM can manage service activation transactions. For more information about OSM, see OSM Concepts.

Web services for IP Service Activator is an optional component that is available during IP Service Activator installation. For information about installing and configuring Web services, see IP Service Activator Installation Guide.

Web services is deployed on WebLogic Server. For information about WebLogic Server, see WebLogic Server documentation.

The Web service is an OSS/J-based interface that provides an external API for system integration. IP Service Activator transactions can be managed by the Web service. Each IP Service Activator request that is sent to the Web service contains a list of commands. These commands are then performed using a single transaction, without the need to specify the beginning and ending of the transaction. The Web service monitors these transactions and provides status notifications based on the result.

The external transport protocols for using Web services are HTTP, HTTPS, and JMS, and the data service formats are SOAP v1.1 and 1.2. Access-level security is provided through the implementation of the WebLogic WS-Policy specification, enforcing authentication. For more information about using SOAP as the data provider, see "OSM Data Providers".

About Web Services and OIM

The IP Service Activator Web service supports the use of multiple OSS Integration Manager (OIM) instances connected to a single instance of IP Service Activator. Use multiple OIMs to improve performance by allowing operations to be directed to OIMs on the basis of operation type, and also to allow for load sharing.

You can configure Web services to use previously configured OIMs using the Web Services configuration GUI. For information about configuring Web services at installation, see IP Service Activator Installation Guide. For information about the Configuration GUI, see IP Service Activator System Administrator's Guide.

Design Studio for IP Service Activator

An IP Service Activator activation cartridge is provided with the installation. This cartridge includes service action definitions that map to all IP Service Activator operations that are supported by the IP Service Activator Web services interface.

About Activation Tasks

Activation tasks within Design Studio provide integration between OSM and IP Service Activator. You must install OSM, IP Service Activator, and the IP Service Activator integration cartridge in Design Studio.

For information about working with activation tasks, see Design Studio online Help.

Configuring Web Services

Use the IP Service Activator configuration GUI to configure the Web service and deployment parameters, and to deploy or undeploy the Web service. For information about Web service parameters, see IP Service Activator Installation Guide, Post-Installation Tasks.

Note:

When you change IP Service Activator Web service parameters, re-deploy the Web service to ensure that the changes take effect.

For information about configuring other components in the configuration GUI, see IP Service Activator System Administrator's Guide.

Security

IP Service Activator Web Service access control security determines the functionality that each user has access to. To set up access control security, create a security role. Give this role the privilege to start IP Service Activator Web Services. When the Web service client needs to access the Web service, the client needs to authenticate itself to the Oracle WebLogic Server hosting IP Service Activator Web Service. See Oracle WebLogic Administration Guide for information about setting up access security.

Note:

Oracle WebLogic access control security protects only WebLogic Server resources and does not cover secure communication with IP Service Activator Web Services. As a result, SOAP messages transmitted between the Web service and its clients are in plain text.

Web Services allows only access level security. Clients must use a user id that is a member of group IPSA_WS_USERS_GROUP to communicate with IP Service Activator Web Services. The web.xml file defines the security role IPSA_WS_USERS and weblogic.xml file defines the security principal name as IPSA_WS_USERS_GROUP.

The installer creates a default user. For information about the default user names and passwords used with Web services, see IP Service Activator Installation Guide. This user is a member of the IPSA_WS_USERS_GROUP group. Due to limitations of the WebLogic console, information created by the command line tools, such as the role name, might not be available on the console.

OSM Data Providers

A data provider is used to retrieve data in an XML format from external systems.

The data provider type for IP Service Activator Web service is SOAP, which lets you access Web services from OSM and use the responses within behaviors. The required parameter is soap.endpoint, which is an element that identifies the URL to which the SOAP request is sent. Specify the soap.endpoint as:

  • http://ws_IP:Port/Oracle/IPSAView/Ws/Http

Where ws_IP:Port is the IP Service Activator Web service IP and port.

The soap.action parameter contains the URI that identifies the intent of the message. There are several actions that you can specify in the soap.action parameter for IP Service Activator Web services. Table 2-1 lists these actions and their corresponding parameters. For more information about the built-in SOAP data provider parameters, and about using data instance behaviors, see Order and Service Management Developer's Guide.

Table 2-1 Action Parameters

soap.action Parameters

tns/getObject

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getObject><-- Mandatory. Path to an object -->

</ws:getObject>

</soap:Body>

tns/getId

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getId><-- Mandatory. Path to an object -->

</ws:getId>

</soap:Body>

tns/getPath

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getPath><-- Mandatory. Object ID whose path is required -->

</ws:getPath>

</soap:Body>

tns/getName

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getName><-- Mandatory. Path to an object or its ID -->

</ws:getName>

</soap:Body>

tns/getParents

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getParents><-- Mandatory. Path to an object or its ID -->

</ws:getParents>

</soap:Body>

tns/getChildren

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getChildren><-- Mandatory. Path to an object or its ID -->

</ws:getChildren>

</soap:Body>

tns/getAttributes

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getAttributes>

<-- Mandatory. Path to an object or its ID -->

</ws:getAttributes>

</soap:Body>

tns/getTransactionStatus

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws: getTransactionStatus>

<-- Mandatory. Path to an object or its ID -->

</ws: getTransactionStatus>

</soap:Body>

tns/getTargets

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:getTargets>

<-- Mandatory. Path to a ParameterSetInstance object or its ID -->

</ws:getTargets>

</soap:Body>

tns/find

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:find>

<-- Mandatory. Path to an object or its ID. This is the start point of the search -->

<ws:objectId></ws:objectId>

<-- Mandatory. Type of object to find such as Device, Interface, etc. -->

<ws:type>Interface</ws:type>

<-- Mandatory. Name of the object to find. -->

<-- Wildcards are allowed: * (any number of characters), or ? (any single character) -->

<ws:name>Serial*</ws:name>

<-- Optional. Indicates the direction of the search. Possible values are: parent, child. -->

<-- parent - to search upwards through the hierarchy. -->

<-- child - to search downwards through the hierarchy (this is the default) -->

<ws:findDirection>child</ws:findDirection>

<-- Optional. attribute=value pairs on which to search. -->

<-- Wildcards are allowed in string arguments: * (any number of characters), or ? (any single character) -->

<ws:attr1Name></ws:attr1Name>

<ws:attr1Value></ws:attr1Value>

<ws:attr2Name></ws:attr2Name>

<ws:attr2Value></ws:attr2Value>

<ws:attr3Name></ws:attr3Name>

<ws:attr3Value></ws:attr3Value>

<ws:attr4Name></ws:attr4Name>

<ws:attr4Value></ws:attr4Value>

<ws:attr5Name></ws:attr5Name>

<ws:attr5Value></ws:attr5Value>

</ws:find>

</soap:Body>

tns/findParameters

<soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">

<ws:findParameters>

<-- Mandatory. Path to an object or its ID. This is the start point of the search -->

<ws:objectId><ws:objectId>

<-- Mandatory. Type of object to find such as Device, Interface, etc. -->

<ws:type>Interface</ws:type>

<-- Mandatory. Name of the object to find. -->

<-- Wildcards are allowed: * (any number of characters), or ? (any single character) -->

<ws:name>Serial*</ws:name>

<-- Optional. Indicates the direction of the search. Possible values are: parent, child. -->

<-- parent - to search upwards through the hierarchy. -->

<-- child - to search downwards through the hierarchy (this is the default) -->

Finding and Retrieving Data

Using parameters for search criteria, you can find and retrieve data, such as objects, in IP Service Activator. When searching, the supported wildcard characters are ”*” and ”?”.

For more information, see Order and Service Management Developer's Guide.

Finding Objects

Find objects parameters allow you to find objects in IP Service Activator. For information about objects in IP Service Activator, see OSS Integration Manager Guide.

Use the find objects parameters listed in Table 2-2 to find IP Service Activator objects.

Table 2-2 Find Objects Parameters

Find Objects Parameters Definition

parentID

The starting path for the IP Service Activator FIND command.

type

The type of object to find in IP Service Activator.

name

The name of the object to find in IP Service Activator.

direction

Search direction; either parent or child.

attr1Name

The first attribute name.

attr1Value

The first attribute value.

attr2Name

The second attribute name.

attr2Value

The second attribute value.

attr3Name

The third attribute name.

attr3Value

The third attribute value.

attr4Name

The fourth attribute name.

attr4Value

The fourth attribute value.

attr5Name

The fifth attribute name.

attr5Value

The fifth attribute value.

The following is an example service request:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <find xmlns="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">
      <parentId>/Policy:"policy"</parentId>
      <type>Concreteobject</type>
      <name>*</name>
      <direction>child</direction>
      <!--Optional:-->
      <att1Name>state</att1Name>
      <!--Optional:-->
      <att1Value>installed</att1Value>
      <!--Optional:-->
      <att2Name />
      <!--Optional:-->
      <att2Value />
      <!--Optional:-->
      <att3Name />
      <!--Optional:-->
      <att3Value />
      <!--Optional:-->
      <att4Name />
      <!--Optional:-->
      <att4Value />
      <!--Optional:-->
      <att5Name />
      <!--Optional:-->
      <att5Value />
    </find>
  </env:Body>
  </env:Envelope>
  Service Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <ws:findResponse xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">
      <ws:eomObject>
        <ws:objectId>1425</ws:objectId>
        <ws:objectName>1111 on Serial2/0/1.1/1/1/1:2</ws:objectName>
        <ws:objectType>ConcreteObject</ws:objectType>
      </ws:eomObject>
      <ws:eomObject>
        <ws:objectId>1430</ws:objectId>
        <ws:objectName>111 on Serial2/0/1.1/1/1/1:2</ws:objectName>
        <ws:objectType>ConcreteObject</ws:objectType>
      </ws:eomObject>
    </ws:findResponse>
  </env:Body>
  </env:Envelope>

Retrieving Objects

Use find parameters to retrieve objects in IP Service Activator.

Use the parameters listed in Table 2-3 to retrieve IP Service Activator objects to which a ParameterSetInstance object applies.

Table 2-3 Find Parameters for Retrieving Objects

findParameter Definition

parentID

The starting path for the IP Service Activator FIND command.

type

The type of object to find in IP Service Activator.

direction

Search direction; either parent or child.

attr1Name

The first attribute name.

attr1Value

The first attribute value.

attr2Name

The second attribute name.

attr2Value

The second attribute value.

attr3Name

The third attribute name.

attr3Value

The third attribute value.

attr4Name

The fourth attribute name.

attr4Value

The fourth attribute value.

attr5Name

The fifth attribute name.

attr5Value

The fifth attribute value.

The following is an example retrieval request:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <findParameters xmlns="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">
      <parentId>/</parentId>
      <type>devicetype</type>
      <direction>child</direction>
      <!--Optional:-->
      <att1Name />
      <!--Optional:-->
      <att1Value />
      <!--Optional:-->
      <att2Name />
      <!--Optional:-->
      <att2Value />
      <!--Optional:-->
      <att3Name />
      <!--Optional:-->
      <att3Value />
      <!--Optional:-->
      <att4Name />
      <!--Optional:-->
      <att4Value />
      <!--Optional:-->
      <att5Name />
      <!--Optional:-->
      <att5Value />
    </findParameters>
  </env:Body>
  </env:Envelope>
  Service Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <ws:findParametersResponse xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">
      <ws:objects>
        <ws:objectId>551</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine 80E</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>552</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine 5000E</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>553</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine NE5000EMulti</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>554</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine NE40E</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>555</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine NE20E-4</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>556</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine NE20E-8</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>557</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine 40-4</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>558</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine 40-2</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>559</ws:objectId>
        <ws:objectName>Huawei Quidway NetEngine 40-8</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>560</ws:objectId>
        <ws:objectName>Huawei Quidway Eudemon 500</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>561</ws:objectId>
        <ws:objectName>Huawei Quidway Eudemon 1000</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>562</ws:objectId>
        <ws:objectName>Foundry NetIron IMR 640</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>
      <ws:objects>
        <ws:objectId>563</ws:objectId>
        <ws:objectName>Foundry NetIron XMR 4000</ws:objectName>
        <ws:objectType>DeviceType</ws:objectType>
      </ws:objects>      <ws:objects>        <ws:objectId>564</ws:objectId>        <ws:objectName>Foundry NetIron XMR 8000</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>565</ws:objectId>        <ws:objectName>Foundry NetIron XMR 16000</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>566</ws:objectId>        <ws:objectName>Foundry NetIron MLX-4</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>567</ws:objectId>        <ws:objectName>Foundry NetIron MLX-8</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>568</ws:objectId>        <ws:objectName>Foundry NetIron MLX-16</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>569</ws:objectId>        <ws:objectName>Paradyne GranDSLAM 4200</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>570</ws:objectId>        <ws:objectName>RedBack Networks SMS 1000</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>      <ws:objects>        <ws:objectId>571</ws:objectId>        <ws:objectName>RedBack Networks SMS 500</ws:objectName>        <ws:objectType>DeviceType</ws:objectType>      </ws:objects>    </ws:findParametersResponse>  </env:Body>  </env:Envelope>

Retrieving Other Data

You can also use parameters to retrieve other data in IP Service Activator, for example, attributes, child objects, and immediate parent objects.

Use the parameters in Table 2-4 to retrieve other data in IP Service Activator.

Table 2-4 Find Parameters for Retrieving Other Data

findParameter Definition

getAttributes

Retrieves attributes of an object.

Path: the path/ID to the object.

getChildren

Retrieves immediate child objects of an object.

Path: the path/ID to the objects.

getId

Retrieves the ID of an object.

Path: the path/ID to the objects.

getName

Retrieves the name of an objects.

Path: the path/ID to the objects.

getOrderStatus

Retrieves the order status of an OSM order.

orderKey: the key of an OSM order.

getParents

Retrieves the immediate parent objects of an object.

Path: the path/ID to the objects.

getPath

Retrieves the path on an object.

Path: the path/ID to the object.

getTargets

Retrieves the targets that a ParameterSetInstance object applies to.

Path: the path/ID to the object.

The following is an example for getAttributes:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <getAttributes xmlns="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">[13]</getAttributes>
  </env:Body>
  </env:Envelope>
  Service Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
  <env:Header />
    <env:Body>
    <ws:getAttributesResponse xmlns:ws="http://www.oracle.com/cgbu/ipsa/osmipsa/ws/">
      <ws:attribute>
        <ws:attributeName>name</ws:attributeName>
        <ws:attributeValue />
      </ws:attribute>
      <ws:attribute>
        <ws:attributeName>remarks</ws:attributeName>
        <ws:attributeValue />
      </ws:attribute>
      <ws:attribute>
        <ws:attributeName>type</ws:attributeName>
        <ws:attributeValue>Any</ws:attributeValue>
      </ws:attribute>
      <ws:attribute>
        <ws:attributeName>id</ws:attributeName>
        <ws:attributeValue>13</ws:attributeValue>
      </ws:attribute>
    </ws:getAttributesResponse>
  </env:Body>
  </env:Envelope>

Web Service Operations

The set of operations described in Table 2-5 is provided.

Table 2-5 Web Service Operations

Operation Definition Parameter

createOrderByValue

Converts an OSM order to an IP Service Activator transaction.

OrderValue

cancelOrderByKey

The Web service rolls back the corresponding IP Service Activator transaction.

OrderId

abortOrderByKey

The Web service rolls back the corresponding IP Service Activator transaction.

OrderKey

Go to previous page
Previous		 Go to next page
Next
Go to Documentation Home
Home		 Go to Table of Contents
Contents		 Go to Feedback page
Contact Us