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