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