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