Nortel AS 5300 Application Programming Interface
  1. Manuals
  2. Brands
  3. Nortel Manuals
  4. Server
  5. AS 5300
  6. Application programming interface
Nortel AS 5300 Application Programming Interface

Nortel AS 5300 Application Programming Interface

Application programming interfaces reference
Hide thumbs Also See for AS 5300:
Table of Contents

Advertisement

Quick Links

Download this manual
Nortel AS 5300
Nortel Application Server 5300
Application Programming
Interfaces Reference
Release: 1.0
Document Revision: 01.01
www.nortel.com
NN42040-110
.

Advertisement

Table of Contents
loading

Related Manuals for Nortel AS 5300

Summary of Contents for Nortel AS 5300

  • Page 1 Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference Release: 1.0 Document Revision: 01.01 www.nortel.com NN42040-110...
  • Page 2 While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to change without notice.

  • Page 3: Table Of Contents

    Using the Open Provisioning Interface Security, authentication, and authorization 29 Security 29 Authentication 30 Authorization 32 Third-party client development 33 Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 4 Writing a client to perform some specific OPI operations 43 Accessing the OPI Java docs Importing a CA Certificate into the BPT Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 5: New In This Release

    This document is new for Nortel AS 5300 Release 1.0. Other changes Table 1 Revision history June 11, 2008 Standard 01.01. This document is new for Nortel AS 5300 Release 1.0. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008...
  • Page 6 6 New in this release Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 7: Introduction

    AS 5300 system from a remote workstation. Attention: Some services/features referred to in this document are not supported in AS 5300 Release 1.0. For more information about what services/features are supported in AS 5300 Release 1.0, see Nortel Application Server 5300 Overview, (NN42040-100). Navigation •...
  • Page 8 8 Introduction Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 9: Application Programming Interface Fundamentals

    Web service. WSDL enables service providers to provision their AS 5300 system with existing and custom applications. By supporting the WSDL Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 10: Bulk Provisioning Tool Fundamentals

    Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 11: Bulk Provisioning Tool Requirements

    Log on requirement To begin a BPT session, the administrator needs to be, at minimum, a provisioned general administrator. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 12 12 Application Programming Interface fundamentals Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 13: Using The Bulk Provisioning Tool

    The BPT main menu lists the various categories of available BPT provisioning methods. After successfully logging on to the workstation, the BPT main menu appears. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 14 For example, to access the Domain Operations submenu, type 1 and press Enter. The BPT displays the Domain Operations submenu. Figure 2 Accessing the Domain Operations submenu Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 15 1000 users, and you want to save the output. For information about BPT command syntax conventions and examples, see "BPT conventions and examples" (page 17). Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 16: Bpt Provisioning Methods

    CSV file content. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 17: Scripts

    "Fully qualified user name" (page 20) • "Success indication on remove methods" (page 20) • "Unknown error messages" (page 21) Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 18 Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 19 BPT command line. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008...
  • Page 20 If the domain is valid and the user is not preexisting, then a success indication is returned, because the user is not configured on the system. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008...

  • Page 21: Create And Manage Provisioning Roles Using The Bpt

    (D:\prov) of your work station. The contents of the file (on one line in the file) are as follows: [AddExample,BPT add example,[[Domain Management,true,true,false],[Device Management,true,false,false],[Admin,true,true,true]]]. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 22 To view the new provisioning role in the BPT, use the getRole provisioning method with the following syntax: getRole using (AddExample) Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 23 (AddExample) The BPT indicates whether the provisioning method succeeded or failed, as shown in the following figure. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 24: Bpt Help Option

    The BPT displays the BPT (OPI) provisioning method syntax, followed by the required file syntax, as shown in the following figure. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 25: Bpt Limitations

    Provisioning Client screens. Most, but not all, individual BPT provisioning methods map to a provisioning screen in the Provisioning Client. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 26: Batch Processing

    Nortel recommends using the BPT during off-peak times or maintenance windows when large amounts of information are being added. Bulk provisioning of users Bulk provisioning of users (through BPT or an OPI client) puts a large load on the database in the AS 5300 system.

  • Page 27: Provisioning Data Visibility

    Manager. However, it can take up to five minutes before the same data is visible to clients connected to a second instance of a Provisioning Manager running in the system. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 28 28 Using the Bulk Provisioning Tool Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 29: Using The Open Provisioning Interface

    (opitruststore). For instructions, see "Importing a CA Certificate into the BPT" (page 51). Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 30: Authentication

    The user’s username and password are configured in the WS Security Headers. A sample WS-Security header/SOAP message with the required information is shown in the following figure. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 31 .NET client. The code must be added in the stub class so that it may hijack the request and add the headers to it. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008...

  • Page 32: Authorization

    (Domains, Users, Telephony Routes, and so on). The provisioning system enables the creation of various administrator roles Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 33: Third-Party Client Development

    Provisioning Module listens on port 8080 for the SOAP over HTTP messages, and port 8443 for the SOAP over HTTPS messages. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 34: Implement Interface Accessing Stubs

    (whatever type of object), and sends it to the Provisioning Manager data store, which stores it in the database. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 35: Starting The Bulk Provisioning Tool

    Provisioning Manager. Starting the Bulk Provisioning Tool Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 36: Downloading The Bulk Provisioning Tool To A Workstation

    Use this procedure to launch the BPT on a remote workstation. Procedure Steps Step Action Execute the bpt.bat (Windows) or bpt.sh (Solaris) script. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 37 Enter your administrator username and password. The Bulk Provisioning Tool main menu appears. See Figure 1 "BPT main menu" (page 14) --End-- Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 38 38 Starting the Bulk Provisioning Tool Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 39: Creating Open Provisioning Interface Clients

    OPI clients using the WSDL file. Creating OPI clients The following task flow shows the processes involved in creating OPI clients. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 40 "Compiling the client stubs" (page 42) • "Writing a client to perform some specific OPI operations" (page 43) Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 41: Downloading The Axis Toolkit

    In the DOS window, open a command prompt. Set the classpath for all the jar files found in the directory D:\axis-1_4\webapps\axis\WEB-INF\lib. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 42: Downloading The Wsdl File

    Run the WSDL2JAVA tool on the WSDL file. For example: java org.apache.axis.wsdl.WSDL2Java -O -1 -d Session -Nurn:OPI com.client.opi.service opi.wsdl Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 43: Writing A Client To Perform Some Specific Opi Operations

    OPI provisioning method calls can be made using the following procedure. Procedure Steps Step Action Instantiate the OPIServiceLocator. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 44 The following figure shows an example of writing a client. In the example, the class is placed under D:\opiclient. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 45 Stubs, and executed. The OPI Stub classes and AXIS toolkit jars must be present in the classpath during execution, as demonstrated in the following figure. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 46 46 Creating Open Provisioning Interface clients Figure 13 Compiling the client class Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 47: Accessing The Opi Java Docs

    OPI web service available. Each sub-folder is named the same as the OPI web service category it represents. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 48 AdminAuthentication subfolder in the OPI Java Docs folder. A list of sub-folders and files related to the AdminAuthentica tion OPI web service opens. Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 49 AdminAuthentication Web service, the associated OPI provisioning methods, and the bean objects. --End-- Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...
  • Page 50 50 Accessing the OPI Java docs Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 51: Importing A Ca Certificate Into The Bpt

    (on one line): keytool -list -v -keystore opitruststore The tool displays the contents of the BPT trust store. --End-- Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 52: Nortel As

    52 Importing a CA Certificate into the BPT Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040-110 01.01 Standard 11 June 2008 Copyright © 2008 Nortel Networks...

  • Page 54: Nortel Application Server 5300 Application Programming Interfaces Reference

    While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to change without notice.

Table of Contents