Oracle9iAS TopLink Getting Started Release 2 (9.0.3) Part Number B10061-01 |
|
This chapter includes the following information on installing TopLink:
Your system must meet certain minimum requirements to ensure that TopLink runs smoothly.
TopLink will run under any of the following operating systems:
TopLink hardware requirements are quite low, and in fact, the hardware required to run both Java and most database applications far exceeds TopLink's requirements.
However, as a guideline, your system should include at least the following to ensure the proper operation of TopLink:
TopLink requires the following supporting software:
Or any other Java environment compatible with the Sun JDK 1.2 (or higher).
Use this procedure to install Oracle9iAS TopLink (including the Foundation Library and Mapping Workbench).
Before installing TopLink, you should back up all existing project data.
If you downloaded the software, you must un-compress the installer.
<INSTALL_DIR>
\doc\index.html
for the latest release notes.
If you installed to the default directory, <INSTALL_DIR>
is C:\
<ORACLE_HOME>
\toplink
.
<INSTALL_DIR>
.
<INSTALL_DIR>
/docs/index.html
for the latest release notes.
If you installed to the default directory, <INSTALL_DIR>
is /
<ORACLE_HOME>
/toplink
.
You must properly configure your PATH and CLASSPATH environment variables before using TopLink. If the Mapping Workbench is open, close the Mapping Workbench and re-open it after modifying these settings.
Use these procedures to configure your PATH and CLASSPATH environment variables for Windows Environment or a Non-Windows Environment.
Add the following to the beginning of your PATH:
Add the following to the beginning of your CLASSPATH:
<INSTALL_DIR>
\core\lib\toplink.jar
<INSTALL_DIR>
\core\lib\xerces.jar
<INSTALL_DIR>
\core\lib\antlr.jar
where <INSTALL_DIR>
is the directory which contains TopLink (for example, C:\
<ORACLE_HOME>
\toplink
).
Add the following to the beginning of your PATH:
Add the following to the beginning of your CLASSPATH:
<INSTALL_DIR>
/core/lib/toplink.jar
<INSTALL_DIR>
/core/lib/xerces.jar
<INSTALL_DIR>
/core/lib/antlr.jar
where <INSTALL_DIR>
is the directory which contains TopLink (for example, /
<ORACLE_HOME>
/toplink
).
TopLink uses the following software:
jakarta.apache.org/ant/index.html
TopLink uses Antlr for EJBQL parsing. Antlr (ANother Tool for Language Recognition), is a language tool that provides a framework for constructing recognizers, compilers, and translators from grammatical descriptions containing C++ or Java actions. The ANTLR parser and translator generator is fully in the public domain.
www.w3.org/Consortium/Legal/copyright-software.html
The Document Object Model (DOM) is a specification that defines some programming language-neutral interfaces that can be used to manipulate XML and HTML documents. W3C maintains this specification. W3C also provides a Java "binding" for these interfaces. TopLink uses this "binding" to parse and manipulate XML documents.
Copyright © 1994 - 2002 World Wide Web Consortium, (Massachusetts Institute of Technology, Institut National de Recherche en Informatique et en Automatique, Keio University). All Rights Reserved.
hsqldb.sourceforge.net/2/General/license.html
This product includes Hypersonic SQL. The HSQL database shipped with the TopLink examples and demos is for development purposes only. Redistributions of source code must retain the copyright notice set forth below, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the copyright notice set forth below, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The HSQL software is provided "as is" and any expressed or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the Hypersonic SQL Group or its contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption). However caused any on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. Copyright © 1995-2000 by the Hypersonic SQL Group. All rights reserved.
The Java Runtime Environment is maintained by Sun Microsystems, Inc. The TopLink Mapping Workbench runs in a Windows JDK 1.3.1_03 VM by default, and may also be configured to run using other compliant Java 2 VMs. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc., in the U.S. and other countries.
The Simple API for XML (SAX) is an interface for event-based XML parsing, developed collaboratively by the members of the XML-DEV mailing list. TopLink uses this API to interact with the Apache Xerces parser.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/
). Copyright © 2000 The Apache Software Foundation. All rights reserved.
http://www.apache.org/
)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.
THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This section contains detailed information on configuring TopLink for your specific development environment.
By default, TopLink includes Java Runtime Environment 1.3.1_03 from Sun Microsystems for use by the TopLink Mapping Workbench.
To configure TopLink for a different version of the JRE or a JDK installation, change the setenv.cmd
, at the root of <INSTALL_DIR>
to point JAVA_HOME
to the new install directory.
For development purposes with the TopLink Foundation Library or to run the TopLink Examples, you must have either JDK 1.2 or 1.3 installed. Ensure the setenv.cmd
, at the root of <INSTALL_DIR>
points JAVA_HOME
to the JDK installation.
When using TopLink with VisualAge, you can speed the development of an application by:
To use TopLink inside the VisualAge environment you must import the TopLink classes.
toplink.jar
file in the <INSTALL_DIR>
\core\lib\
.
Repeat for any other .jar
s that you want to import into VisualAge.
You can import TopLink source files into the VisualAge environment to provide partial source for a project.
Note:
You must import the TopLink |
source.jar
file.
<INSTALL_DIR>
\core\lib\source.jar
as the file name.
Make sure your runnable classes using TopLink include the TopLink projects on their CLASSPATH.
Compile and execute the ConnectTest
class in the oracle.toplink.tutorials.gettingstarted
package.
Run the ConnectTest
class from the command line, passing appropriate database login information as parameters as follows:
java oracle.toplink.tutorials.gettingstarted.ConnectTest <username> <password> <database url> <jdbc driver class>
or
Modify the main()
method to contain appropriate database login information as parameters, as in the following example, then recompile and execute the class.
public static void main(String[] args) { ConnectTest test = new ConnectTest(); if (args.length > 0) { test.connect(args[0], args[1], args[2], args[3], args[4]); } // Add your login information below else { test.connect("<user>","<password>", "oracle.jdbc.driver.OracleDriver", "jdbc:oracle:thin:@oraserver:1521:orcl"; } }
If the code does not run successfully, check the error message and ensure that all of your settings are correct. If necessary, refer to "General Troubleshooting" for more information.
After installing and testing TopLink, refer to the Oracle9iAS TopLink Tutorial Guide for information on the tutorials that will help you learn about TopLink.
After installing TopLink, if you encounter problems either starting the application or connecting to a database, try the following solutions:
jdbc.log
file located in the installation folder for the SQL exception being generated.
.dll
files required by your driver.
.zip/.jar
files required by your JDBC driver.
Refer to the Oracle9iAS TopLink Troubleshooting Guide for more information.
|
Copyright © 2002 Oracle Corporation. All Rights Reserved. |
|