java.properties revision df9bb5a637fb6be2657d938a957b4170ede4e440
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# CDDL HEADER START
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews# The contents of this file are subject to the terms of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Common Development and Distribution License, Version 1.0 only
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater# (the "License"). You may not use this file except in compliance
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# with the License.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# You can obtain a copy of the license at
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# trunk/opends/resource/legal-notices/OpenDS.LICENSE
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# or https://OpenDS.dev.java.net/OpenDS.LICENSE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# See the License for the specific language governing permissions
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# and limitations under the License.
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# When distributing Covered Code, include this CDDL HEADER in each
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# file and include the License file at
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# add the following below this CDDL HEADER, with the fields enclosed
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# by brackets "[]" replaced with your own identifying information:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Portions Copyright [yyyy] [name of copyright owner]
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# CDDL HEADER END
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# Portions Copyright 2007 Sun Microsystems, Inc.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# This file contains the java properties that the different command lines will
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# use when launched. You can specify the location of the java binaries to be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# used and the java arguments to be passed to the command line.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# For instance you can specify to use the -server argument for the start-ds
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# command with an initial heap size of 256 Mb by setting
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# start-ds.java-args=-server -Xms256m
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# (the example assumes that the Java virtual machine supports those options).
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# To set the java virtual machine to be used for a given command-line you must
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# set the property <command-line-name>.java-home and to specify java arguments
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# you must set the property <command-line-name>.java-args.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# There are certain command-lines (import-ldif, export-ldif, backup, restore)
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# that can work on two modes: online and offline. When they run in online mode
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (the server is running and the user specifies LDAP parameters to launch the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# operation) the operation is not actually performed in the Java Virtual Machine
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# of the command-line but on the server side. This is why when launching these
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# command-lines on online-mode it is preferred to use the -client argument for
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# the java virtual machine (and even limit the maximum size of the heap).
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# However when these command-lines are launched in offline mode it is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# recommended to use the -server argument to launch the command-line.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# This is the reason why you can specify different java properties for both
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# modes (for instance import-ldif.offline.java-args and
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# IMPORTANT NOTE: Once you have modified this file and set the java properties
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# that you want the command-lines to use you must run the command-line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# bin/dsjavaproperties for the different scripts to be updated with the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# specified settings.
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# Specify to overwrite the content of the environment variable OPENDS_JAVA_HOME
03c0efc6892ef2ed17338b2ecbb2c5f23fbad0c9Tinderbox User# (i.e. the contents of this properties file for the java home will be analyzed
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# before checking whether OPENDS_JAVA_HOME is specified in the environment):
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User# overwrite-env-java-home=true
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# Specify to overwrite the content of the environment variable OPENDS_JAVA_ARGS
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater# (i.e. the contents of this properties file for the java args will be analyzed
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# before checking whether OPENDS_JAVA_ARGS is specified in the environment):
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# overwrite-env-java-args=true
2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User# Specify to use a particular Java Virtual Machine for the offline import:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Specify to use -client argument when running dsconfig:
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews# Specify to use -server argument when running import-ldif on server mode:
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater# Specify to use the java home for all the command-lines that have not
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews# an associated property defined:
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# Specify to use the -client argument for all the command-lines that have not
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# an associated property defined: