Manuals / Nortel Networks / Computer Equipment / Network Router

Nortel Networks AS 5300 manual Introduction, Navigation, Audience, Related documents

Models: AS 5300

1 54

Download 54 pages 16.04 Kb

Page 7

Introduction

.

7

Introduction

This document discusses the Nortel Application Server (AS) 5300 Application Programming Interface (API) available to third party clients for provisioning and administering the 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

•"Application Programming Interface fundamentals" (page 9)

•"Using the Bulk Provisioning Tool" (page 13)

•"Using the Open Provisioning Interface" (page 29)

•"Starting the Bulk Provisioning Tool" (page 35)

•"Creating Open Provisioning Interface clients" (page 39)

•"Accessing the OPI Java docs" (page 47)

•"Importing a CA Certificate into the BPT" (page 51)

Audience

This document is for programmers and administrators, and assumes that the reader is familiar with object-oriented programming.

Related documents

The following AS 5300 documents contain related material:

•Personal Agent User Guide, NN42040-105

•Alarm and Log Reference, NN42040-701

Nortel AS 5300

Nortel Application Server 5300 Application Programming Interfaces Reference

NN42040-110 01.01 Standard

11 June 2008

Copyright © 2008 Nortel Networks

Image 7

Nortel Networks AS 5300 manual Introduction, Navigation, Audience, Related documents, Using the Bulk Provisioning Tool page

Contents

Nortel AS Nortel Application Server Application ProgrammingInterfaces Reference NN42040-110All other trademarks are the property of their respective owners Nortel AS Release Publication NN42040-110 Document status StandardDocument release date 11 June Copyright 2008 Nortel Networks All Rights Reserved Sourced in Canada LEGAL NOTICENew in this release ContentsUsing the Bulk Provisioning Tool Using the Open Provisioning InterfaceImporting a CA Certificate into the BPT Accessing the OPI Java docsStarting the Bulk Provisioning Tool Creating Open Provisioning Interface clientsNortel AS New in this releaseOther changes Revision historyCopyright 2008 Nortel Networks 6 New in this releaseNortel AS NN42040-110 01.01 Standard 11 JuneIntroduction Using the Bulk Provisioning Tool pageUsing the Open Provisioning Interface page Accessing the OPI Java docs pageCopyright 2008 Nortel Networks 8 IntroductionNortel AS NN42040-110 01.01 Standard 11 JuneBulk Provisioning Tool fundamentals page Application Programming Interface fundamentalsOpen Provisioning Interface fundamentals Open Provisioning Interface fundamentals pageBulk Provisioning Tool fundamentals Why use the Bulk Provisioning ToolBulk Provisioning Tool requirements Copyright 2008 Nortel Networks 12 Application Programming Interface fundamentalsNortel AS NN42040-110 01.01 Standard 11 JuneBPT main menu Using the Bulk Provisioning ToolInstall and launch the BPT Install and launch the BPT page BPT main menu pageAccessing the Domain Operations submenu 14 Using the Bulk Provisioning ToolBPT main menu Description BPT main menu commandsCommand method name using * intoFiles BPT provisioning methodsBPT ﬁles and scripts NavigationScripts Create and manage provisioning roles using the BPT pageSuccess indication on remove methods page Unknown error messages page BPT conventions and examplesAngle brackets getRole using Role name file file name optional into file nameOptional syntax BracketsgetRole using Role name file file name optional into file name Square bracketsFully qualified user name newguy,mysecret,John,Edwards,Active,,,, ,,,,,DefaultAdmin,,English,Devices only,yourcompany.com Comma separated stringsDefine the new provisioning role page Unknown error messagesCreate and manage provisioning roles using the BPT Define the new provisioning roleView the new provisioning role addRole using file D\prov\addexample.txtgetRole using AddExample Add the new provisioning rolegetRole method invoked in the BPT Delete the new provisioning rolehelp addRole BPT Help optionResource use page Provisioning data visibility page BPT limitationsBPT mapping to the Provisioning Client BPT mapping to the Provisioning Client page Batch processing pageResource use Batch processingBulk provisioning of users Provisioning data visibility Copyright 2008 Nortel Networks 28 Using the Bulk Provisioning ToolNortel AS NN42040-110 01.01 Standard 11 JuneSecurity page Authentication page Authorization page Using the Open Provisioning InterfaceSecurity, authentication, and authorization Security, authentication, and authorization pageWS-Security UsernameToken AuthenticationHTTP Basic Authentication - Onboard Authentication HTTP Basic Authentication - Onboard Authentication pageSample WS-Security header/SOAP message A special note for .NET authentication headersDomain-level authorization page Provisioning-level authorization page AuthorizationDomain-level authorization Provisioning-level authorizationGet the WSDL Implement interface accessing stubs pageAccess stubs from the third-party application page Third-party client developmentAccess stubs from the third-party application Implement interface accessing stubsStarting the Bulk Provisioning Tool Starting the Bulk Provisioning ToolDownloading the Bulk Provisioning Tool to a workstation page Procedure StepsDownloading the Bulk Provisioning Tool to a workstation Launching the BPT on a workstationNortel AS 2 Enter your administrator username and passwordThe BPT application launches Launching the BPT on a workstationCopyright 2008 Nortel Networks 38 Starting the Bulk Provisioning ToolNortel AS NN42040-110 01.01 Standard 11 JunePrerequisites for creating OPI clients Creating Open Provisioning Interface clientsCreating OPI clients Writing a client to perform some specific OPI operations page Downloading the Axis toolkit page Retrieving the error codes pageConfiguring the class path page Downloading the WSDL file page Compiling the client stubs pageD\axis-14\webapps\axis\WEB-INF\lib Retrieving the error codesDownloading the Axis toolkit Conﬁguring the class pathloadname/wsdl/opi Downloading the WSDL ﬁleCompiling the client stubs D\opiclientStep Action t\opi\serviceWriting a client to perform some speciﬁc OPI operations Procedure StepsExample - 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 clientsCompiling the client class Nortel ASProcedure Steps Accessing the OPI Java docsStep Action OPIJavadocs file unzipped AdminAuthentication subfolder in the OPI Java Docs folderAccessing the javadocs for the AdminAuthentication OPI web service Copyright 2008 Nortel Networks 50 Accessing the OPI Java docsNortel AS NN42040-110 01.01 Standard 11 JuneProcedure Steps Importing a CA Certiﬁcate into the BPTThe tool prompts Trust this certificate? no keytool -list -v -keystore opitruststoreCopyright 2008 Nortel Networks 52 Importing a CA Certificate into the BPTNortel AS NN42040-110 01.01 Standard 11 JunePage Nortel AS