Nortel Networks AS 5300 manual Application Programming Interface fundamentals

Page 9

.

9

Application Programming Interface fundamentals

The Application Server (AS) 5300 provides Application Programming Interface (API) support for third-party client applications. This support consists of one main API and one tool:

Open Provisioning Interface (OPI)

Bulk Provisioning Tool (BPT)

Open Provisioning Interface (OPI) is an API for third-party client applications, and is the foundation for the Bulk Provisioning Tool (BPT). The BPT facilitates the provisioning of the AS 5300 system with large (bulk) amounts of data. It also retrieves large (bulk) amounts of data from the AS 5300 system.

Navigation

"Open Provisioning Interface fundamentals" (page 9)

"Bulk Provisioning Tool fundamentals" (page 10)

Open Provisioning Interface fundamentals

The OPI is used to remotely provision the AS 5300 system. OPI is based on version 1.1 of the Simple Object Access Protocol (SOAP) and the emerging Web services standard. SOAP is a cross-platform, cross-language, text-based protocol, utilizing the benefits of Extensible Markup Language (XML). SOAP is commonly used as a tool in distributed applications named Web services. SOAP is not transport dependent, therefore OPI uses Hyper Text Transfer Protocol (HTTP) as a transport protocol.

OPI supports version 1.1 of the industry-standard Web Services Description Language (WSDL). WSDL is an XML language that contains information about the interface, semantics, and administration of a call to a 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

Image 9
Contents NN42040-110 Legal Notice Contents Starting the Bulk Provisioning Tool Other changes New in this releaseNew in this release Navigation IntroductionAudience Related documentsIntroduction Open Provisioning Interface fundamentals Application Programming Interface fundamentalsBulk Provisioning Tool fundamentals Why use the Bulk Provisioning ToolFollowing table lists the requirements to run the BPT Bulk Provisioning Tool requirementsApplication Programming Interface fundamentals Using the Bulk Provisioning Tool Install and launch the BPTBPT main menu BPT main menu Quit BPT files and scripts BPT provisioning methodsNavigation FilesBPT conventions and examples ScriptsMethod and file syntax conventions Brackets Optional syntaxAngle brackets GetSysRoles optional into file nameBar Square bracketsComma separated strings Fully qualified user nameSuccess indication on remove methods Unknown error messages Create and manage provisioning roles using the BPTDefine the new provisioning role GetRole using AddExample AddRole using file D\prov\addexample.txtAdd the new provisioning role View the new provisioning roleDelete the new provisioning role Help addRole BPT Help optionBPT mapping to the Provisioning Client BPT limitationsResource use Batch processingProvisioning data visibility Using the Bulk Provisioning Tool Using the Open Provisioning Interface Security, authentication, and authorizationSecurity Authentication Http Basic Authentication Onboard AuthenticationWS-Security UsernameToken Special note for .NET authentication headers Domain-level authorization Provisioning-level authorization AuthorizationGet the Wsdl Third-party client developmentGenerate stubs WsdlAccess stubs from the third-party application Implement interface accessing stubsStarting the Bulk Provisioning Tool Starting the Bulk Provisioning ToolProcedure Steps Downloading the Bulk Provisioning Tool to a workstationLaunching the BPT on a workstation Launching the BPT on a workstation Starting the Bulk Provisioning Tool Creating Open Provisioning Interface clients Prerequisites for creating OPI clientsCreating OPI clients Task flow for creating OPI clients Downloading the Axis toolkit Retrieving the error codesConfiguring the class path \axis-14\webapps\axis\WEB-INF\libCompiling the client stubs Downloading the Wsdl file\opiclient Loadname/wsdl/opiWriting a client to perform some specific OPI operations \opi\serviceExample Writing a client Writing a client to perform some specific OPI operations Compiling the client class Procedure Steps Accessing the OPI Java docsAdminAuthentication subfolder in the OPI Java Docs folder Writing a client to perform some specific OPI operations Accessing the OPI Java docs Importing a CA Certificate into the BPT Tool prompts Trust this certificate? noKeytool -list -v -keystore opitruststore Importing a CA Certificate into the BPT Page Nortel AS
Related manuals
Manual 92 pages 3.24 Kb