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