6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
6330N/A ! This work is licensed under the Creative Commons
6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6330N/A ! To view a copy of this license, visit
6330N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6330N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6330N/A ! Portions Copyright [yyyy] [name of copyright owner]
6330N/A !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A ! Portions Copyright 2013 Jens Elkner
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="dsjavaproperties-1" xmlns="http://docbook.org/ns/docbook"
6330N/A version="5.0" xml:lang="en"
6330N/A xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>dsjavaproperties</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>dsjavaproperties</application></refname>
6330N/A <refpurpose>apply OpenDJ Java home and JVM settings</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>dsjavaproperties</command>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-quiet"])'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A <arg os="solaris"><replaceable class="parameter">properties_file</replaceable></arg>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to change the Java arguments and Java home that are
6330N/Aused by OpenDJ server commands and tools.
6330N/A </para>
6330N/A <para os="solaris">
6330N/AIf <filename><replaceable>properties_file</replaceable></filename> is given and denotes a regular file
6330N/Areadable by the user ldapd, it gets copied to
6330N/A<varname>$INSTANCE_ROOT</varname><filename>/config/java.properties</filename>.
6330N/AIt allows users, which have the "OpenDJ Admin" profile assigned, to change the
6330N/Acontent of the file, even if they are not allowed to explicitly <citerefentry>
6330N/A<refentrytitle>su</refentrytitle><xi:include href="common.xml"
6330N/Axpointer='xpointer(//manvolnum[@name="v1m"])'/></citerefentry> to the owner of
6330N/Athe <varname>$INSTANCE_ROOT</varname> or change the ACLs of this file.
6330N/A </para>
6330N/A <para>
6330N/A<command>dsjavaproperties</command> reads
6330N/A<varname>$INSTANCE_ROOT</varname><filename>/config/java.properties</filename>
6330N/Aand persists all changes, so that other OpenDJ utilities are able to use them.
6330N/A </para>
6330N/A <note>
6330N/A <para>
6330N/AChanges are <emphasis>not</emphasis> propagated to tools already running.
6330N/A </para>
6330N/A </note>
6330N/A <para>
6330N/AThe file is a simple <link
6330N/Axlink:href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.Reader%29">Java property file</link>.
6330N/AAll honored keys or key patterns are explained in the <varname
6331N/A>$INSTALL_ROOT</varname><filename>/template/config/java.properties</filename>
6330N/Aexample.
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>The following options are supported.</para>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-quiet"])'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>dsjavaproperties</command></literallayout>
6330N/A <screen>
6330N/AThe operation was successful. The server commands will use the java
6330N/Aarguments and java home specified in the properties file located in
6330N/A$INSTANCE_ROOT/config/java.properties
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6330N/A <refsection>
6330N/A <title>Files</title>
6330N/A <variablelist>
6330N/A <varlistentry>
6330N/A <term><varname>$INSTANCE_ROOT</varname><filename>/config/java.properties</filename></term>
6330N/A <listitem>
6330N/A <para>
6330N/AContains the properties to persist.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A </variablelist>
6330N/A <variablelist>
6330N/A <varlistentry>
6331N/A <term><varname>$INSTALL_ROOT</varname><filename>/template/config/java.properties</filename></term>
6330N/A <listitem>
6330N/A <para>
6330N/AAn example of a java.properties file incl. documentation and examples.
6330N/A </para>
6330N/A </listitem>
6330N/A </varlistentry>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>