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