NN42040-110
Nortel Application Server Application Programming
Interfaces Reference
Nortel AS
All Rights Reserved Sourced in Canada LEGAL NOTICE
Nortel AS Release Publication NN42040-110 Document status Standard
Document release date 11 June Copyright 2008 Nortel Networks
All other trademarks are the property of their respective owners
Using the Open Provisioning Interface
Contents
Using the Bulk Provisioning Tool
New in this release
Creating Open Provisioning Interface clients
Accessing the OPI Java docs
Starting the Bulk Provisioning Tool
Importing a CA Certificate into the BPT
Revision history
New in this release
Other changes
Nortel AS
NN42040-110 01.01 Standard 11 June
6 New in this release
Nortel AS
Copyright 2008 Nortel Networks
Accessing the OPI Java docs page
Using the Bulk Provisioning Tool page
Using the Open Provisioning Interface page
Introduction
NN42040-110 01.01 Standard 11 June
8 Introduction
Nortel AS
Copyright 2008 Nortel Networks
Open Provisioning Interface fundamentals page
Application Programming Interface fundamentals
Open Provisioning Interface fundamentals
Bulk Provisioning Tool fundamentals page
Why use the Bulk Provisioning Tool
Bulk Provisioning Tool fundamentals
Bulk Provisioning Tool requirements
NN42040-110 01.01 Standard 11 June
12 Application Programming Interface fundamentals
Nortel AS
Copyright 2008 Nortel Networks
Install and launch the BPT page BPT main menu page
Using the Bulk Provisioning Tool
Install and launch the BPT
BPT main menu
Accessing the Domain Operations submenu
14 Using the Bulk Provisioning Tool
BPT main menu
method name using * into
BPT main menu commands
Command
Description
Navigation
BPT provisioning methods
BPT files and scripts
Files
BPT conventions and examples
Create and manage provisioning roles using the BPT page
Success indication on remove methods page Unknown error messages page
Scripts
Brackets
getRole using Role name file file name optional into file name
Optional syntax
Angle brackets
Square brackets
getRole using Role name file file name optional into file name
Comma separated strings
newguy,mysecret,John,Edwards,Active,,,, ,,,,,Default
Admin,,English,Devices only,yourcompany.com
Fully qualified user name
Define the new provisioning role
Unknown error messages
Create and manage provisioning roles using the BPT
Define the new provisioning role page
Add the new provisioning role
addRole using file D\prov\addexample.txt
getRole using AddExample
View the new provisioning role
Delete the new provisioning role
getRole method invoked in the BPT
BPT Help option
help addRole
BPT mapping to the Provisioning Client page Batch processing page
BPT limitations
BPT mapping to the Provisioning Client
Resource use page Provisioning data visibility page
Resource use
Batch processing
Bulk provisioning of users
Provisioning data visibility
NN42040-110 01.01 Standard 11 June
28 Using the Bulk Provisioning Tool
Nortel AS
Copyright 2008 Nortel Networks
Security, authentication, and authorization page
Using the Open Provisioning Interface
Security, authentication, and authorization
Security page Authentication page Authorization page
HTTP Basic Authentication - Onboard Authentication page
Authentication
HTTP Basic Authentication - Onboard Authentication
WS-Security UsernameToken
A special note for .NET authentication headers
Sample WS-Security header/SOAP message
Provisioning-level authorization
Authorization
Domain-level authorization
Domain-level authorization page Provisioning-level authorization page
Third-party client development
Implement interface accessing stubs page
Access stubs from the third-party application page
Get the WSDL
Implement interface accessing stubs
Access stubs from the third-party application
Starting the Bulk Provisioning Tool
Starting the Bulk Provisioning Tool
Launching the BPT on a workstation
Procedure Steps
Downloading the Bulk Provisioning Tool to a workstation
Downloading the Bulk Provisioning Tool to a workstation page
Launching the BPT on a workstation
2 Enter your administrator username and password
The BPT application launches
Nortel AS
NN42040-110 01.01 Standard 11 June
38 Starting the Bulk Provisioning Tool
Nortel AS
Copyright 2008 Nortel Networks
Prerequisites for creating OPI clients
Creating Open Provisioning Interface clients
Creating OPI clients
Compiling the client stubs page
Downloading the Axis toolkit page Retrieving the error codes page
Configuring the class path page Downloading the WSDL file page
Writing a client to perform some specific OPI operations page
Configuring the class path
Retrieving the error codes
Downloading the Axis toolkit
D\axis-14\webapps\axis\WEB-INF\lib
D\opiclient
Downloading the WSDL file
Compiling the client stubs
loadname/wsdl/opi
Procedure Steps
t\opi\service
Writing a client to perform some specific OPI operations
Step Action
Example - Writing a client
The client class can be compiled similarly to the compilation of the OPI 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
46 Creating Open Provisioning Interface clients
Compiling the client class
NN42040-110 01.01 Standard 11 June
Procedure Steps
Accessing the OPI Java docs
Step Action
AdminAuthentication subfolder in the OPI Java Docs folder
OPIJavadocs file unzipped
Accessing the javadocs for the AdminAuthentication OPI web service
NN42040-110 01.01 Standard 11 June
50 Accessing the OPI Java docs
Nortel AS
Copyright 2008 Nortel Networks
keytool -list -v -keystore opitruststore
Importing a CA Certificate into the BPT
The tool prompts Trust this certificate? no
Procedure Steps
NN42040-110 01.01 Standard 11 June
52 Importing a CA Certificate into the BPT
Nortel AS
Copyright 2008 Nortel Networks
Page
Nortel AS