fa9e4066f08beec538e775443c5be79dd423fcabahrens# CDDL HEADER START

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# The contents of this file are subject to the terms of the

fa9e4066f08beec538e775443c5be79dd423fcabahrens# Common Development and Distribution License, Version 1.0 only

fa9e4066f08beec538e775443c5be79dd423fcabahrens# (the "License"). You may not use this file except in compliance

fa9e4066f08beec538e775443c5be79dd423fcabahrens# with the License.

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# You can obtain a copy of the license at legal-notices/CDDLv1_0.txt

fa9e4066f08beec538e775443c5be79dd423fcabahrens# or http://forgerock.org/license/CDDLv1.0.html.

fa9e4066f08beec538e775443c5be79dd423fcabahrens# See the License for the specific language governing permissions

fa9e4066f08beec538e775443c5be79dd423fcabahrens# and limitations under the License.

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# When distributing Covered Code, include this CDDL HEADER in each

fa9e4066f08beec538e775443c5be79dd423fcabahrens# file and include the License file at legal-notices/CDDLv1_0.txt.

fa9e4066f08beec538e775443c5be79dd423fcabahrens# If applicable, add the following below this CDDL HEADER, with the

fa9e4066f08beec538e775443c5be79dd423fcabahrens# fields enclosed by brackets "[]" replaced with your own identifying

fa9e4066f08beec538e775443c5be79dd423fcabahrens# information:

fa9e4066f08beec538e775443c5be79dd423fcabahrens# Portions Copyright [yyyy] [name of copyright owner]

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# CDDL HEADER END

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# Copyright 2008-2010 Sun Microsystems, Inc.

fa9e4066f08beec538e775443c5be79dd423fcabahrens# Portions Copyright 2011 ForgeRock AS

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# This file contains the java properties that the different command lines will

fa9e4066f08beec538e775443c5be79dd423fcabahrens# use when launched. You can specify the location of the java binaries to be

fa9e4066f08beec538e775443c5be79dd423fcabahrens# used and the java arguments to be passed to the command line.

fa9e4066f08beec538e775443c5be79dd423fcabahrens# For instance you can specify to use the -server argument for the start-ds

fa9e4066f08beec538e775443c5be79dd423fcabahrens# command with an initial heap size of 256 Mb by setting

fa9e4066f08beec538e775443c5be79dd423fcabahrens# start-ds.java-args=-server -Xms256m

fa9e4066f08beec538e775443c5be79dd423fcabahrens# (the example assumes that the Java virtual machine supports those options).

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock#

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# To set the java virtual machine to be used for a given command-line you must

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# set the property <command-line-name>.java-home and to specify java arguments

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# you must set the property <command-line-name>.java-args.

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock#

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# There are certain command-lines (import-ldif, export-ldif, backup, restore)

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# that can work on two modes: online and offline. When they run in online mode

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# (the server is running and the user specifies LDAP parameters to launch the

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# operation) the operation is not actually performed in the Java Virtual Machine

fa9e4066f08beec538e775443c5be79dd423fcabahrens# of the command-line but on the server side. This is why when launching these

fa9e4066f08beec538e775443c5be79dd423fcabahrens# command-lines on online-mode it is preferred to use the -client argument for

fa9e4066f08beec538e775443c5be79dd423fcabahrens# the java virtual machine (and even limit the maximum size of the heap).

fa9e4066f08beec538e775443c5be79dd423fcabahrens# However when these command-lines are launched in offline mode it is

fa9e4066f08beec538e775443c5be79dd423fcabahrens# recommended to use the -server argument to launch the command-line.

fa9e4066f08beec538e775443c5be79dd423fcabahrens# This is the reason why you can specify different java properties for both

fa9e4066f08beec538e775443c5be79dd423fcabahrens# modes (for instance import-ldif.offline.java-args and

fa9e4066f08beec538e775443c5be79dd423fcabahrens# import-ldif.online.java-args).

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

fa9e4066f08beec538e775443c5be79dd423fcabahrens# IMPORTANT NOTE: Once you have modified this file and set the java properties

fa9e4066f08beec538e775443c5be79dd423fcabahrens# that you want the command-lines to use you must run the command-line

088e9d477eee66081e407fbc5a33c4da25f66f6aeschrock# bin/dsjavaproperties for the different scripts to be updated with the

fa9e4066f08beec538e775443c5be79dd423fcabahrens# specified settings.

fa9e4066f08beec538e775443c5be79dd423fcabahrens#

# Examples:

# Specify to overwrite the content of the environment variable OPENDJ_JAVA_HOME

# (i.e. the contents of this properties file for the java home will be analyzed

# before checking whether OPENDJ_JAVA_HOME is specified in the environment):

# overwrite-env-java-home=true

#

# Specify to overwrite the content of the environment variable OPENDJ_JAVA_ARGS

# (i.e. the contents of this properties file for the java args will be analyzed

# before checking whether OPENDJ_JAVA_ARGS is specified in the environment):

# overwrite-env-java-args=true

#

# Specify to use a particular Java Virtual Machine for the offline import:

# import-ldif.offline.java-home=/usr/jdk1.7

#

# Specify to use -client argument when running dsconfig:

# dsconfig.java-args=-client

#

# Specify to use -server argument when running import-ldif on server mode:

# import-ldif.offline.java-args=-server

#

# Specify to use the java home for all the command-lines that have not

# an associated property defined:

# default.java-home=/usr/jdk1.6

#

# Specify to use the -client argument for all the command-lines that have not

# an associated property defined:

# default.java-args=-client