IBM Lotus Domino Designer 7: Java/CORBA Classes Programming Guide

需积分: 3 155 浏览量更新于2024-08-02 收藏 11.08MB PDF 举报

"LotusScript编程指导(第3卷)(英文)" 是关于使用Java和CORBA在Lotus Domino Designer 7环境下进行编程的详细指南。本卷主要关注Java类的编码规范以及如何与Lotus Domino的Java API进行交互。本指南的初衷是在使用前阅读“注意事项”部分，这是所有IBM产品文档的标准提示。第一版发布于2005年12月，适用于Lotus Domino Designer 7及其后续版本和更新。主要内容涵盖： 1. **Java类的编码指南** - 这部分详述了编写符合最佳实践的Java代码的规则和建议。它可能包括变量声明、方法设计、异常处理、类和对象的使用等方面的指导。 - **运行Java程序** - 首先介绍如何在Lotus Domino环境中执行Java程序。 - **需求** - 列出了运行Java程序所需的各种条件，包括服务器需求（例如Java虚拟机版本）和Designer需求（开发环境的配置）。 - **运行时需求** - 强调了在实际运行Java代码时系统必须满足的条件。 - **调用lotus.dominopackage** - 解释如何访问和利用Lotus Domino提供的Java包来与Domino服务器通信。 - **使用lotus.dominoclasses** - 描述了如何直接操作Domino的Java类库，以便与数据库、文档、视图等进行交互。 - **示例：运行Java程序** - 提供实际代码示例，展示如何编写和运行简单的Java程序，这些程序可以访问和操作Domino数据。 2. **CORBA类** - CORBA（Common Object Request Broker Architecture）是一种标准的分布式计算模型，用于在不同操作系统和编程语言之间实现对象间的互操作性。这部分可能涉及如何在Lotus Domino中集成和使用CORBA，包括创建和配置ORB（Object Request Broker）、定义接口和服务、以及如何在Java代码中使用CORBA对象。通过本指南，开发者能够掌握如何在Lotus Domino平台上有效地利用Java和CORBA技术，实现更高效、跨平台的应用程序开发。这包括访问和操作Domino数据库、创建动态Web服务、以及构建分布式系统等高级功能。

gotoFirstDocument method . . . . . . . 1190

gotoLast method . . . . . . . . . . . 1190

gotoLastDocument method . . . . . . . 1191

gotoNext method . . . . . . . . . . . 1192

gotoNextCategory method . . . . . . . . 1193

gotoNextDocument method . . . . . . . 1193

gotoNextSibling method . . . . . . . . 1194

gotoParent method . . . . . . . . . . 1194

gotoPos method . . . . . . . . . . . 1195

gotoPrev method . . . . . . . . . . . 1195

gotoPrevCategory method . . . . . . . . 1196

gotoPrevDocument method . . . . . . . 1196

gotoPrevSibling method . . . . . . . . 1197

Index . . . . . . . . . . . . . . 1199

xvi Programming Guide, Volume 3: Java/CORBA Classes

Chapter 1. Java Classes Coding Guidelines

These are guidelines for writing Java programs using the Domino Objects. See ″Java Classes A-Z″ for a

reference.

Running a Java program

You can call the Domino Objects from a Java program by importing the lotus.domino package. The

program can be coded as an application, a Domino agent, an applet, or a servlet. Local calls access

run-time code on the local computer, which must have Domino installed. CORBA-based remote (IIOP)

calls access run-time code from a remote Domino server; in this case, the local computer need not have

Domino installed. Compilation must be on a computer with Domino Designer installed.

Note: Notes/Domino Release 7 supports the Sun Java(TM) 2 Platform, Technology Edition, v 1.4.2. To

avoid incompatibilities: do not run Java agents compiled under Release 7 on earlier Domino servers or

Notes clients; do not use Release 7 Java archives (Notes.jar, NCSO.jar, domtags.jar) on Java platforms

earler than v. 1.4.2.

Note:

The lotus.domino package has the same content as the Release 4.6 lotus.notes package plus new

classes, methods, and other enhancements. The Release 4.6 lotus.notes package continues to be supported

for backward compatibility only; it does not contain the new classes, methods, and other enhancements.

Requirements

Server requirements

CORBA-based remote (IIOP) calls require access to a Domino server.

The server tasks HTTP and DIIOP must be running. Ensure that the server notes.ini file contains the

following line:

ServerTasks=<any other tasks>,http,diiop

Or you can start the tasks later with the load console command.

Note: The JavaMaxHeapsize should not be decreased below a value of 64M, or a runtime error will occur

when attempting to execute nhttp.exe. If a value for JavaMaxHeapsize is not set in the server notes.ini

file, a value of 64M will be used.

The server document in the Domino Directory (under Server\Servers) must permit and restrict remote

calls as desired. Right-click on a field description to display an extended description.

v Under Security:

– Under Server Access, fill in ″Access server,″ ″Not access server,″ ″Create new databases,″ and ″Create

replica databases″ as desired.

– Under Programmability Restrictions, fill in ″Run unrestricted methods and operations″ and ″Run

restricted LotusScript Java agents″ as desired. These fields apply to all programmable interfaces and

must be filled in for remote access.

Note:

These settings are new with Release 6.

– Under Internet Access - For ″Internet authentication,″ specify a more inclusive or less inclusive view

for validating user names.

Note:

This verification is new for Release 5.0.1.

v Under Ports:

– Under Internet Ports - For ″IIOP,″ indicate whether access is permitted by name and password, and

whether anonymous access is allowed.

Under Internet Protocols:

– Under HTTP R5 - For ″Basics,″ indicate whether HTTP clients can browse databases. A ″no″

specification disallows DbDirectory.getFirstDatabase for the database.

Note:

This verification is new for Release 5.0.1.

– Under IIOP, specify the number of threads to be allocated for handling remote calls.

Note:

This restriction does not apply as of Release 6.

server refreshes its cache of security options approximately every half hour. The console command ″tell

diiop refresh″ forces an immediate refresh.

SSL security for CORBA-based Domino Object applications/applets builds on the Web Server SSL

security. You must first set up the Web server security using the ″Domino R5 Certificate Authority″

application.

Designer requirements

Compilation of a Java program using the lotus.domino package requires installation of Domino Designer

Release 5 or greater.

For stand-alone applications, include Notes.jar from the Notes program directory and

domino\java\NCSO.jar or domino\java\NCSO.cab from the Notes data directory in the classpath. For

example:

set CLASSPATH=.;c:\notes\data\domino\java\NCSO.jar;c:\notes\Notes.jar

Notes.jar contains the high-level lotus.domino package, the lotus.domino.local package for local calls, and

the old lotus.notes package. The NCSO archive contains the high-level lotus.domino package and the

lotus.domino.cso package for remote calls. Strictly, you do not need the NCSO archive if you are not

compiling remote calls and you do not need Notes.jar if you are not compiling local calls or old calls.

The two NCSO archives have identical content but differ in the archiving technique:

v NCSO.jar uses the JDK JAR utility with compression.

v NCSO.cab uses the Microsoft CABARC utility.

Note:

Earlier releases used NCSO.jar (uncompressed) and NCSOC.jar (compressed).

Your

class code must import the high-level lotus.domino package:

import lotus.domino.*;

Run-time requirements

A computer running a Java application that makes local Domino calls must contain Domino Server,

Domino Designer, or Notes Client, and must include Notes.jar in the classpath.

A computer running a Java application that makes remote Domino calls need not contain Domino or

Notes, but must contain one of the NCSO archives and must include it in the classpath.

A computer running a Domino agent that makes Domino calls must include Notes.jar in the classpath.

A computer running an applet that makes Domino calls needs no Domino software or classpath

assignments. The applet must be loaded from a computer containing a Domino server.

2 Programming Guide, Volume 3: Java/CORBA Classes

Note: Do not use NCSOW.jar in the classpath for executing remote (IIOP) calls in a WebSphere

environment. NCSOW.jar is no longer kitted as it was starting with Release 5.0.4. You can continue to run

programs that use NCSOW.jar on R5 servers, but not on Release 6 servers. The NCSO archives work with

both R5 and Release 6 servers.

Calling the lotus.domino package

The following guidelines apply to Java programs calling into the lotus.domino package:

v An application or servlet that makes local calls uses the NotesThread class, which extends

java.lang.Thread. You can extend NotesThread, implement the Runnable interface, or use the static

NotesThread methods sinitThread() and stermThread(). If you extend NotesThread, the entry point to

the functional code must be public void runNotes(). If you implement Runnable, the entry point must

be public void run(). If you use the static NotesThread methods, be sure to call stermThread exactly

one time for each call to sinitThread. An application that makes remote calls does not use the

NotesThread class. See the examples for clarification.

Each thread of an application making local calls must initialize a NotesThread object. This includes

AWT threads that access the Domino Objects. Listener threads must use the static methods because

they cannot inherit from NotesThread.

Memory management is a consideration for long running programs and programs that create a large

number of objects. See the recycle method and ″Multithreading issues″ under the NotesThread class.

v An agent extends the AgentBase class, which extends the NotesThread class. The class that contains the

agent code must be public. The entry point to the functional code must be public void NotesMain().

See the examples for clarification.

v An applet extends AppletBase and puts its functional code in the methods notesAppletInit(),

notesAppletStart(), and notesAppletStop(). You do not have to distinguish between local and remote

access in the main code. AppletBase makes local calls if the applet is running through the Notes client

and remote calls if it is running through a browser. Remote calls go to the Domino server on the

computer that loaded the applet.

If an applet creates a thread containing Domino calls, the thread code must use NotesThread for local

Domino calls but not remote (IIOP) calls. Use AppletBase.isLocal() to determine the environment. Use

NotesThread.sinitThread for initialization and NotesThread.stermThread for termination. Thread

creation includes handling AWT events.

See the examples for clarification.

For applets stored in a Domino database, ″Applet uses Notes CORBA classes″ under Java Applet - Java

Applet Properties must be checked.

v The Session class is the root of the Domino back-end object containment hierarchy. For applications

making local calls, use the method NotesFactory createSession(), createSessionWithFullAccess(),

createSession(null, null, String pwd), createSessionWithFullAccess(String pwd), createSession(null,

String user, String pwd), or createSession(null, ″″, ″″) to create a Session object. For applications making

remote calls, use the method createSession(String host, ″″, ″″) or createSession(String host, String user,

String pwd). For agents, use the method AgentBase.getSession(). For applets, use the method

AppletBase.openSession() or openSession(String user, String pwd) and closeSession(Session session).

See the examples for clarification.

The user and pwd parameters of NotesFactory.createSession and AppletBase.openSession must be a

user name and Internet password in the Domino Directory on the server being accessed. If a name and

password are not specified, anonymous access must be permitted by the server.

For Single Sign-on to a Domino or WebSphere server, use createSession(String host, String token),

createSession(String host, org.omg.SecurityLevel2.Credentials token), createSession(String host, null), or

createSession(String host, HttpServletRequest request).

Note: Single Sign-on is new with Release 5.0.5.

To enable SSL (Secure Sockets Layer), use NotesFactory.createSession(String host, String args[], String

user, String pwd) and specify ″-ORBEnableSSLSecurity″ for args(0).

Chapter 1. Java Classes Coding Guidelines 3

v For foreground agents, System.out and System.err output goes to the Java debug console. For locally

scheduled agents, System.out and System.err output goes to the Domino log.

v For output to Web browsers from agents (but not applets), you must assign a java.io.PrintWriter object

with the getAgentOutput() method of AgentBase, and write using the println method of the

PrintWriter object. This method works for output to Notes clients as well. See the examples for

clarification.

v System.exit must not be used to terminate a program using the NotesThread class (and by extension

the AgentBase class). In an agent, System.exit throws SecurityException. In an application, System.exit

may cause corruption problems.

Using the lotus.domino classes

The lotus.domino classes allow you to access named databases, views, documents, and other back-end

objects. The following lotus.domino classes are for direct, public use:

v ACL represents a collection of all the access control list entries for a database.

v ACLEntry represents a single entry in an access control list.

v AdministrationProcess represents the administration process.

v Agent represents the attributes of an agent.

v AgentContext represents the context of the current agent if the program is running as an agent.

v ColorObject represents a color.

v Database represents a Domino database.

v DateRange represents a range of dates and times.

v DateTime represents a Domino date-time.

v DbDirectory represents the database files on a server or the local computer.

v Document represents a document in a database.

v DocumentCollection represents a collection of documents.

v DXLExporter represents the conversion of Domino data to DXL (Domino XML).

v DXLImporter represents the conversion of DXL (Domino XML) to Domino data.

v EmbeddedObject represents embedded objects, links, and file attachments.

v Form represents a form in a database.

v International represents the international settings in the operating system.

v Item represents an item of data in a document.

v Log represents actions and errors that occur during execution of a script.

v MIMEEntity represents an item of type MIME (Multipurpose Internet Mail Extensions).

v MIMEHeader represents a MIME header.

v Name represents a user or server name.

v Newsletter represents a summary document that contains information from, or links to, several other

documents.

v NoteCollection represents a collection of Domino design and data elements in a database.

v Outline represents an outline.

v OutlineEntry represents an entry in an outline.

v Registration represents the creation or administration of an ID file.

v Replication represents the replication attributes of a Domino database.

v ReplicationEntry represents the replication settings for a pair of servers in a database.

v RichTextDoclink represents a doclink in a rich text item.

v RichTextItem represents items that contain rich text.

v RichTextNavigator represents a means of navigation in a rich text item.

v RichTextParagraphStyle represents rich text paragraph style attributes.

4 Programming Guide, Volume 3: Java/CORBA Classes

剩余1238页未读，继续阅读

annian

粉丝: 0
资源: 4

IBM Lotus Domino Designer 7: Java/CORBA Classes Programming Guid...

最新资源

IBM Lotus Domino Designer 7: Java/CORBA Classes Programming Guid...

从Visual Basic到LotusScript编程指南

LotusScript编程教程：从入门到精通

"Lotus Domino 6.5程序设计：公式与LotusScript编程

LotusScript编程指导(第2卷)(英文)

LotusScript编程指导(第一卷)(英文)

LotusScript

如何通过LotusScript编程在用户界面上创建按钮，并使用这些按钮来触发文档的创建和编辑？

LotusScript学习

LotusScript语法

lotusScript语法

最新资源