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