java.properties revision b1dce270ec218b8ad86ce6d745d295da038a5c88
436aad11e01e916f75e68a2e9cb89ac217a990d3Tinderbox User# CDDL HEADER START
18920d790825d96ca3943aa2dcb6eb80dc611c5fTinderbox User# The contents of this file are subject to the terms of the
18920d790825d96ca3943aa2dcb6eb80dc611c5fTinderbox User# Common Development and Distribution License, Version 1.0 only
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User# (the "License"). You may not use this file except in compliance
e9e4257668ff6c4e583b0c0db2508650b0b677b8Tinderbox User# with the License.
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews# You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
1f4c645185bd8fc70048e0a69eee46193a284e5cTinderbox User# or http://forgerock.org/license/CDDLv1.0.html.
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# See the License for the specific language governing permissions
bed0874e1a09e810575328c4bfc346a47514b69fMark Andrews# and limitations under the License.
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User# When distributing Covered Code, include this CDDL HEADER in each
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# file and include the License file at legal-notices/CDDLv1_0.txt.
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# If applicable, add the following below this CDDL HEADER, with the
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# fields enclosed by brackets "[]" replaced with your own identifying
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# information:
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews# Portions Copyright [yyyy] [name of copyright owner]
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews# CDDL HEADER END
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# Copyright 2008-2010 Sun Microsystems, Inc.
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews# Portions Copyright 2011 ForgeRock AS
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# This file contains the java properties that the different command lines will
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# use when launched. You can specify the location of the java binaries to be
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# used and the java arguments to be passed to the command line.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# For instance you can specify to use the -server argument for the start-ds
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews# command with an initial heap size of 256 Mb by setting
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# start-ds.java-args=-server -Xms256m
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# (the example assumes that the Java virtual machine supports those options).
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# To set the java virtual machine to be used for a given command-line you must
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# set the property <command-line-name>.java-home and to specify java arguments
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# you must set the property <command-line-name>.java-args.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User# There are certain command-lines (import-ldif, export-ldif, backup, restore)
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# that can work on two modes: online and offline. When they run in online mode
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User# (the server is running and the user specifies LDAP parameters to launch the
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews# operation) the operation is not actually performed in the Java Virtual Machine
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# of the command-line but on the server side. This is why when launching these
dc238a06bffa79de141ee7655765e2df91498a8aTinderbox User# command-lines on online-mode it is preferred to use the -client argument for
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# the java virtual machine (and even limit the maximum size of the heap).
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# However when these command-lines are launched in offline mode it is
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# recommended to use the -server argument to launch the command-line.
24934f08b9ff81c2be711e566e8002d145573031Tinderbox User# This is the reason why you can specify different java properties for both
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# modes (for instance import-ldif.offline.java-args and
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# IMPORTANT NOTE: Once you have modified this file and set the java properties
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt# that you want the command-lines to use you must run the command-line
710bce1a85c96e85ca1a90471382055acd29d51fTinderbox User# bin/dsjavaproperties for the different scripts to be updated with the
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# specified settings.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# Specify to overwrite the content of the environment variable OPENDJ_JAVA_HOME
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater# (i.e. the contents of this properties file for the java home will be analyzed
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# before checking whether OPENDJ_JAVA_HOME is specified in the environment):
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# overwrite-env-java-home=true
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# Specify to overwrite the content of the environment variable OPENDJ_JAVA_ARGS
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# (i.e. the contents of this properties file for the java args will be analyzed
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# before checking whether OPENDJ_JAVA_ARGS is specified in the environment):
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# overwrite-env-java-args=true
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# Specify to use a particular Java Virtual Machine for the offline import:
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater# import-ldif.offline.java-home=/usr/jdk1.7
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews# Specify to use -client argument when running dsconfig:
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews# Specify to use -server argument when running import-ldif on server mode:
950d203b64f512b85fcc093ee1e9e3e531a1aea3Tinderbox User# Specify to use the java home for all the command-lines that have not
950d203b64f512b85fcc093ee1e9e3e531a1aea3Tinderbox User# an associated property defined:
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# Specify to use the -client argument for all the command-lines that have not
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User# an associated property defined: