Oracle 9i. Oracle 9i Supplied Java Packages Reference

784 Pages·2001·4.466 MB·English

by  Melnick J.

Oracle9i
Oracle9i Supplied Java Packages Reference
Release 1 (9.0.1)
June 2001
Part No. A88898-01
Oracle9i Oracle9i Supplied Java Packages Reference, Release 1 (9.0.1)
Part No. A88898-01
Copyright © 2001, Oracle Corporation. All rights reserved.
Primary Author: Jack Melnick
Contributing Authors: Shelley Higgins, Kev MacDowell, Denis Raphaely, Jim Rawles, John Russell,
Chitra Sharma
Contributors: Anish Karmarkar, Anjana Manian, Ravi Murthy, Bhagat Nainani, Visar Nimani, Mark
Scardina, Rama Vissapragada, Vikram Yavagal
The Programs (which include both the software and documentation) contain proprietary information of
Oracle Corporation; they are provided under a license agreement containing restrictions on use and
disclosure and are also protected by copyright, patent, and other intellectual and industrial property
laws. Reverse engineering, disassembly, or decompilation of the Programs is prohibited.
Theinformationcontainedinthisdocumentissubjecttochangewithoutnotice.Ifyoufindanyproblems
in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this
document is error free. Except as may be expressly permitted in your license agreement for these
Programs, no part of these Programs may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.
If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on
behalf of the U.S. Government, the following notice is applicable:
Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial
computer software" and use, duplication, and disclosure of the Programs, including documentation,
shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.
Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer
software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR
52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500
Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy, and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the
Programs.
Oracle, Oracle Call Interface, Oracle Forms, and SQL*Plus are registered trademarks of Oracle
Corporation. Net8, Oracle7, Oracle7 Server, Oracle8, Oracle8 Server, Oracle8i, Oracle9i, PL/SQL, Pro*C,
Pro*C/C++, Pro*Cobol, and SQL*Net are trademarks of Oracle Corporation. Other names may be
trademarks of their respective owners.
Contents
Send Us Your Comments................................................................................................................... xi
Preface.......................................................................................................................................................... xiii
What’s New in Java Supplied Packages?............................................................................. xvii
1 Package oracle.AQ
Package oracle.AQ Description........................................................................................................ 1-3
AQDriverManager.............................................................................................................................. 1-5
AQSession............................................................................................................................................ 1-7
AQConstants...................................................................................................................................... 1-13
AQAgent............................................................................................................................................. 1-14
AQQueueTableProperty.................................................................................................................. 1-16
AQQueueProperty............................................................................................................................ 1-21
AQQueueTable.................................................................................................................................. 1-24
AQQueueAdmin............................................................................................................................... 1-28
AQQueue............................................................................................................................................ 1-36
AQEnqueueOption........................................................................................................................... 1-39
AQDequeueOption.......................................................................................................................... 1-41
AQMessage........................................................................................................................................ 1-45
AQMessageProperty........................................................................................................................ 1-47
AQRawPayload................................................................................................................................. 1-51
AQObjectPayload............................................................................................................................. 1-52
AQException...................................................................................................................................... 1-53
iii
AQOracleSQLException.................................................................................................................. 1-54
2 Package oracle.jms
Package oracle.jms Description........................................................................................................ 2-4
AdtMessage.......................................................................................................................................... 2-7
AQjmsAdtMessage............................................................................................................................. 2-9
AQjmsAgent...................................................................................................................................... 2-26
AQjmsBytesMessage........................................................................................................................ 2-30
AQjmsConnection............................................................................................................................ 2-45
AQjmsConnectionMetaData.......................................................................................................... 2-53
AQjmsConstants............................................................................................................................... 2-58
AQjmsConsumer............................................................................................................................... 2-60
AQjmsDestination............................................................................................................................ 2-68
AQjmsDestinationProperty............................................................................................................ 2-77
AQjmsException............................................................................................................................... 2-81
AQjmsFactory.................................................................................................................................... 2-83
AQjmsInvalidDestinationException............................................................................................. 2-90
AQjmsInvalidSelectorException................................................................................................... 2-91
AQjmsMapMessage......................................................................................................................... 2-92
AQjmsMessage................................................................................................................................ 2-108
AQjmsMessageEOFException...................................................................................................... 2-131
AQjmsMessageFormatException................................................................................................. 2-132
AQjmsMessageNotReadableException...................................................................................... 2-133
AQjmsMessageNotWriteableException..................................................................................... 2-134
AQjmsObjectMessage................................................................................................................... 2-135
AQjmsOracleDebug....................................................................................................................... 2-139
AQjmsProducer............................................................................................................................... 2-141
AQjmsQueueBrowser.................................................................................................................... 2-155
AQjmsQueueConnectionFactory................................................................................................. 2-160
AQjmsQueueReceiver................................................................................................................... 2-163
AQjmsQueueSender...................................................................................................................... 2-166
AQjmsSession................................................................................................................................. 2-168
AQjmsStreamMessage................................................................................................................... 2-205
AQjmsTextMessage........................................................................................................................ 2-219
AQjmsTopicConnectionFactory................................................................................................... 2-223
iv
AQjmsTopicPublisher................................................................................................................... 2-226
AQjmsTopicReceiver..................................................................................................................... 2-230
AQjmsTopicSubscriber................................................................................................................. 2-234
TopicReceiver................................................................................................................................... 2-237
3 Package oracle.ODCI
Package oracle.ODCI Description................................................................................................... 3-2
ODCIArgDesc..................................................................................................................................... 3-3
ODCIArgDescList............................................................................................................................... 3-6
ODCIArgDescRef............................................................................................................................... 3-9
ODCIColInfo..................................................................................................................................... 3-11
ODCIColInfoList.............................................................................................................................. 3-14
ODCIColInfoRef............................................................................................................................... 3-17
ODCICost........................................................................................................................................... 3-19
ODCICostRef..................................................................................................................................... 3-22
ODCIFuncInfo................................................................................................................................... 3-24
ODCIFuncInfoRef............................................................................................................................ 3-27
ODCIIndexCtx................................................................................................................................... 3-29
ODCIIndexCtxRef............................................................................................................................ 3-32
ODCIIndexInfo................................................................................................................................. 3-34
ODCIIndexInfoRef........................................................................................................................... 3-37
ODCIObject....................................................................................................................................... 3-39
ODCIObjectList................................................................................................................................ 3-42
ODCIObjectRef................................................................................................................................. 3-45
ODCIPredInfo................................................................................................................................... 3-47
ODCIPredInfoRef............................................................................................................................. 3-50
ODCIQueryInfo................................................................................................................................ 3-52
ODCIQueryInfoRef......................................................................................................................... 3-55
ODCIRidList...................................................................................................................................... 3-57
ODCIStatsOptions........................................................................................................................... 3-60
ODCIStatsOptionsRef..................................................................................................................... 3-63
4 Package oracle.xml.parser.v2
Description........................................................................................................................................... 4-2
AttrDecl................................................................................................................................................. 4-4
v
DefaultXMLDocumentHandler....................................................................................................... 4-9
DOMParser......................................................................................................................................... 4-15
DTD..................................................................................................................................................... 4-22
ElementDecl....................................................................................................................................... 4-30
NodeFactory....................................................................................................................................... 4-36
NSName.............................................................................................................................................. 4-40
NSResolver......................................................................................................................................... 4-42
oraxsl.................................................................................................................................................... 4-43
SAXAttrList........................................................................................................................................ 4-45
SAXParser........................................................................................................................................... 4-51
XMLAttr.............................................................................................................................................. 4-55
XMLCDATA....................................................................................................................................... 4-63
XMLComment................................................................................................................................... 4-66
XMLDocument.................................................................................................................................. 4-69
XMLDocumentFragment................................................................................................................. 4-83
XMLDocumentHandler................................................................................................................... 4-86
XMLElement...................................................................................................................................... 4-91
XMLEntityReference...................................................................................................................... 4-103
XMLNode......................................................................................................................................... 4-105
XMLParseException........................................................................................................................ 4-118
XMLParser........................................................................................................................................ 4-122
XMLPI............................................................................................................................................... 4-128
XMLText............................................................................................................................................ 4-131
XMLToken........................................................................................................................................ 4-135
XMLTokenizer................................................................................................................................. 4-141
XSLException................................................................................................................................... 4-147
XSLProcessor.................................................................................................................................... 4-148
XSLStylesheet.................................................................................................................................. 4-154
5 Package oracle.AQ.xml
Package Oracle.AQ.xml Description............................................................................................... 5-3
AQxmlCallback................................................................................................................................... 5-4
AQxmlDataSource.............................................................................................................................. 5-7
AQxmlCallbackContext................................................................................................................... 5-10
AQxmlServlet.................................................................................................................................... 5-13
vi
AQxmlServlet20................................................................................................................................ 5-18
AQxmlDebug..................................................................................................................................... 5-23
AQxmlException............................................................................................................................... 5-25
6 Oracle XML SQL Utility (XSU) Java API
OracleXMLQuery................................................................................................................................ 6-2
OracleXMLSave................................................................................................................................. 6-18
OracleXMLSQLException............................................................................................................... 6-32
OracleXMLSQLNoRowsException............................................................................................... 6-35
7 Package oracle.XML.parser.schema
XMLSchema......................................................................................................................................... 7-2
XSDBuilder.......................................................................................................................................... 7-3
XSDException...................................................................................................................................... 7-8
8 Package oracle.xml.xsql
Res.......................................................................................................................................................... 8-3
XSQLActionHandler........................................................................................................................ 8-13
XSQLActionHandlerImpl............................................................................................................... 8-15
XSQLCommandLine........................................................................................................................ 8-17
XSQLDiagnostic................................................................................................................................ 8-18
XSQLHttpUtil.................................................................................................................................... 8-20
XSQLPageRequest............................................................................................................................ 8-22
XSQLPageRequestImpl................................................................................................................... 8-29
XSQLParserHelper........................................................................................................................... 8-38
XSQLRequest..................................................................................................................................... 8-40
XSQLServlet....................................................................................................................................... 8-46
XSQLServletPageRequest............................................................................................................... 8-49
XSQLStylesheetProcessor............................................................................................................... 8-53
XSQLUtil............................................................................................................................................ 8-55
9 Package oracle.xml.classgen
CGDocument....................................................................................................................................... 9-2
CGNode................................................................................................................................................ 9-4
vii
CGXSDElement................................................................................................................................... 9-9
DTDClassGenerator......................................................................................................................... 9-12
InvalidContentException................................................................................................................. 9-14
oracg..................................................................................................................................................... 9-15
SchemaClassGenerator.................................................................................................................... 9-16
10 Transviewer Beans
Package oracle.xml.async................................................................................................................. 10-2
DOMBuilder...................................................................................................................................... 10-3
DOMBuilderBeanInfo................................................................................................................... 10-14
DOMBuilderErrorEvent................................................................................................................ 10-16
DOMBuilderErrorListener............................................................................................................ 10-18
DOMBuilderEvent.......................................................................................................................... 10-19
DOMBuilderListener..................................................................................................................... 10-21
ResourceManager............................................................................................................................ 10-23
XSLTransformer............................................................................................................................... 10-25
XSLTransformerBeanInfo.............................................................................................................. 10-30
XSLTransformerErrorEvent........................................................................................................... 10-32
XSLTransformerErrorListener....................................................................................................... 10-34
XSLTransformerEvent.................................................................................................................... 10-35
XSLTransformerListener................................................................................................................ 10-37
Package oracle.xml.dbviewer........................................................................................................ 10-38
DBViewer......................................................................................................................................... 10-38
Package oracle.xml.dbviewer........................................................................................................ 10-53
DBViewerBeanInfo........................................................................................................................ 10-53
Package oracle.xml.srcviewer....................................................................................................... 10-54
XMLSourceView............................................................................................................................. 10-54
Package oracle.xml.srcviewer....................................................................................................... 10-66
XMLSourceViewBeanInfo............................................................................................................ 10-66
Package oracle.xml.transviewer................................................................................................... 10-67
DBAccess.......................................................................................................................................... 10-67
DBAccessBeanInfo......................................................................................................................... 10-74
XMLTransformPanel....................................................................................................................... 10-75
XMLTransformPanelBeanInfo...................................................................................................... 10-76
XMLTransViewer............................................................................................................................. 10-77
viii
Package oracle.xml.treeviewer..................................................................................................... 10-78
XMLTreeView.................................................................................................................................. 10-78
XMLTreeViewBeanInfo................................................................................................................. 10-81
11 Class AppCtxManager
AppCtxManager................................................................................................................................ 11-2
ix
x