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