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