Nortel AS 5300 Скачать руководство пользователя страница 9 | Manualshive

Страница: 9 / 54

Nortel AS 5300 Скачать руководство пользователя страница 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

.

«
...
7
8
9
10
11
...
»

Содержание AS 5300

Страница 1: ...Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference Release 1 0 Document Revision 01 01 www nortel com NN42040 110...

Страница 2: ...is believed to be accurate and reliable except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT AS IS WITHOUT WARRANTY OR CONDITION OF ANY KIND EITHER EXPRESS OR IMPLIED The...

Страница 3: ...ripts 16 Files 16 Scripts 17 BPT conventions and examples 17 Method and file syntax conventions 17 Create and manage provisioning roles using the BPT 21 BPT Help option 24 BPT limitations 25 BPT mappi...

Страница 4: ...visioning Interface clients 39 Downloading the Axis toolkit 41 Retrieving the error codes 41 Configuring the class path 41 Downloading the WSDL file 42 Compiling the client stubs 42 Writing a client t...

Страница 5: ...er AS 5300 Release 1 0 This document is new for Nortel AS 5300 Release 1 0 Other changes Table 1 Revision history June 11 2008 Standard 01 01 This document is new for Nortel AS 5300 Release 1 0 Nortel...

Страница 6: ...6 New in this release Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networks...

Страница 7: ...ntals 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 Acc...

Страница 8: ...8 Introduction Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networks...

Страница 9: ...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 u...

Страница 10: ...e commands available through the OPI Communications between the BPT and the Provisioning server use the OPI OPI itself is the Simple Object Access Protocol SOAP over HTTP Attention Do not use the BPT...

Страница 11: ...run the BPT Table 2 Bulk Provisioning Tool requirements Minimum PC or terminal requirements Java 1 6 JRE in the system classpath For telnet remote access Compatible tested telnet terminals Windows Tel...

Страница 12: ...lication Programming Interface fundamentals Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Net...

Страница 13: ...option page 24 BPT limitations page 25 Install and launch the BPT For procedures on downloading installing and launching the BPT see Starting the Bulk Provisioning Tool page 35 BPT main menu The BPT m...

Страница 14: ...number at the prompt For example to access the Domain Operations submenu type 1 and press Enter The BPT displays the Domain Operations submenu Figure 2 Accessing the Domain Operations submenu Nortel...

Страница 15: ...age for a given method method name using parm a parm b Execute the given method with the required parameters The parameter list must be separated by commas and must adhere to the order presented in th...

Страница 16: ...vailable in a zip file OPIJavaDocs zip included on the AS 5300 Documentation CD To access the OPI Web services documentation see Accessing the OPI Java docs page 47 BPT files and scripts Files and scr...

Страница 17: ...script updated 2008 04 01 BPT conventions and examples This section describes the command syntax and usage conventions for Bulk Provisioning Tool BPT provisioning methods and an example of a provision...

Страница 18: ...to the screen by default Brackets Brackets are required around the parameters when shown in the BPT provisioning method syntax For example the following is the syntax for the getRole provisioning meth...

Страница 19: ...pically the bar is used for the data entry option entering the data in the command line or using data in a file For example the following is the syntax for the getRole provisioning method getRole usin...

Страница 20: ...ods require a fully qualified user name a user name that is complete with the domain name for example joe mydomain com This information is available in the Provisioning Client field descriptions Succe...

Страница 21: ...Name of the Provisioning Role Description of the Role The Provisioning Right Type The Read privilege The write privilege The delete privilege The Provisioning Right Type The Read privilege The write p...

Страница 22: ...od succeeded or failed as shown in the following figure Figure 3 BPT showing a successful add View the new provisioning role To view the new provisioning role in the BPT use the getRole provisioning m...

Страница 23: ...sed to create the new role see Define the new provisioning role page 21 Delete the new provisioning role To delete the new role use the provisioning method removeRole with the following syntax removeR...

Страница 24: ...and its associated text file For example to view the help on the addRole provisioning method enter help addRole or if using the BPT Main menu number shortcut enter help 1 The BPT displays the BPT OPI...

Страница 25: ...be aware of when using the Bulk Provisioning Tool Navigation BPT mapping to the Provisioning Client page 25 Batch processing page 26 Resource use page 26 Provisioning data visibility page 27 BPT mapp...

Страница 26: ...erforming bulk provisioning using files with a large number of entries use a BPT residing on a workstation Performing the task on a server can affect the performance of in progress sessions using the...

Страница 27: ...e instance of the Provisioning Manager However it can take up to five minutes before the same data is visible to clients connected to a second instance of a Provisioning Manager running in the system...

Страница 28: ...28 Using the Bulk Provisioning Tool Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networks...

Страница 29: ...OPI supports security through the use of opicert cer Secure Socket Layer SSL certificate file opitruststore key store file These files are required when you connect to the Provisioning Server through...

Страница 30: ...Authentication page 30 WS Security UsernameToken page 30 HTTP Basic Authentication Onboard Authentication The username and password of the user are configured in the HTTP Headers The following figure...

Страница 31: ...NET client this must be done differently The AS 5300 OPI currently supports HTTP and HTTPS authentication and the authentication headers must be set to Base64 encoded authentication on the client sid...

Страница 32: ...ate domains Widget com Gadget com and Sprocket com An administrator WidgetAdmin can be created with only Widget com in the list of provisionable domains This limits WidgetAdmin to provisioning activit...

Страница 33: ...he skeleton in the Provisioning Manager The skeleton translates the SOAP message back to an object and sends it to the Provisioning Manager data access processes The data access processes communicate...

Страница 34: ...or validation fails a SOAP fault is sent back to indicate the failure and the action is not performed Access stubs from the third party application When the interface accesses or invokes the stubs the...

Страница 35: ...workstation This facilitates the use of files and scripts without affecting the performance of the server hosting the Provisioning Manager Starting the Bulk Provisioning Tool Nortel AS 5300 Nortel Ap...

Страница 36: ...System folder 3 Click Tools The BPT download window appears Figure 11 BPT download window 4 Follow the instructions in the BPT download window to install the required files onto the local workstation...

Страница 37: ...dministrator username and password The Bulk Provisioning Tool main menu appears See Figure 1 BPT main menu page 14 End Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces...

Страница 38: ...38 Starting the Bulk Provisioning Tool Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networks...

Страница 39: ...opment be comfortable using DOS commands have the Java Developer Kit JDK 1 6 have the Java executable available in the system path have the AXIS toolkit version 1 3 Final Attention Toolkits other than...

Страница 40: ...he error codes page 41 Configuring the class path page 41 Downloading the WSDL file page 42 Compiling the client stubs page 42 Writing a client to perform some specific OPI operations page 43 Nortel A...

Страница 41: ...ieving the error codes Use this procedure to retrieve error codes Procedure Steps Step Action 1 Open Axis Fault file 2 Get FaultDetails from the AxisFault 3 Get the value for the child element with th...

Страница 42: ...Use the following procedure to download the WSDL file The WSDL file for the AS 5300 is stored on the System Manager server Procedure Steps Step Action 1 Retrieve the WSDL file from the loads director...

Страница 43: ...not compile You must edit this file by hand to split the large static block into two or three smaller ones so that it compiles This is a known issue due to the fact that the code is automatically gen...

Страница 44: ...the Provisioning Server to determine the version of the provisioning client and return data that the Provisioning Client can understand 6 Make the OPI provisioning method call for example getUser by...

Страница 45: ...f 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 5300 Nortel Application Serv...

Страница 46: ...ioning Interface clients Figure 13 Compiling the client class Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyrig...

Страница 47: ...ption Language WSDL version Each OPI web service has an associated WSDL version You must configure the appropriate WSDL version in the SOAP header for every OPI web service you request Procedure Steps...

Страница 48: ...use the AdminAuthe ntication OPI web service navigate to and click on the AdminAuthentication subfolder in the OPI Java Docs folder A list of sub folders and files related to the AdminAuthentica tion...

Страница 49: ...The javadoc for the AdminAuthentication OPI Web service opens in the browser You can go through the various links available in the javadoc to get a description of the AdminAuthentication Web service t...

Страница 50: ...50 Accessing the OPI Java docs Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networks...

Страница 51: ...tool presents details about the certificate and gives the fingerprint of the certificate for validation The tool prompts Trust this certificate no 4 If the certificate is correct enter yes OR If the c...

Страница 52: ...Importing a CA Certificate into the BPT Nortel AS 5300 Nortel Application Server 5300 Application Programming Interfaces Reference NN42040 110 01 01 Standard 11 June 2008 Copyright 2008 Nortel Networ...

Страница 53: ......

Страница 54: ...com documentfeedback www nortel com Sourced in Canada LEGAL NOTICE While the information in this document is believed to be accurate and reliable except as otherwise expressly agreed to in writing NO...

Отзывы:

Нет отзывов