<?xml version="1.0" encoding="UTF-8"?>

<chapter xml:id='chap-services'

xmlns='http://docbook.org/ns/docbook'

version='5.0' xml:lang='en'

xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'

xmlns:xlink='http://www.w3.org/1999/xlink'

xmlns:xinclude='http://www.w3.org/2001/XInclude'>

<title>Managing OpenIDM Services</title>

<section xml:id="startup-shutdown">

<title>Starting &amp; Stopping OpenIDM</title>

<para>By default you start and stop OpenIDM in interactive mode.</para>

<itemizedlist>

<para>To start OpenIDM interactively, open a terminal or command window,

change to the <filename>openidm</filename> directory, and run the startup

script:</para>

<listitem>

<para><command>startup.sh</command> on UNIX, Linux, &amp; Mac OS X</para>

</listitem>

<listitem>

<para><command>startup.bat</command> on Windows</para>

</listitem>

</itemizedlist>

<para>The startup script starts OpenIDM, and opens an OSGi console with a

<literal>-&gt;</literal> prompt where you can issue console commands.</para>

<para>To stop OpenIDM interactively in the OSGi console, enter the

<command>shutdown</command> command.</para>

<screen>-&gt; shutdown</screen>

<orderedlist>

<para>You can also start OpenIDM as a background process on UNIX, Linux, and

Mac OS X. Follow these steps <emphasis>before starting OpenIDM for the first

time</emphasis>.</para>

<listitem>

<para>Disable <literal>ConsoleHandler</literal> logging before starting

OpenIDM by editing <filename>openidm/conf/logging.properties</filename>

to set <literal>java.util.logging.ConsoleHandler.level = OFF</literal>,

and to comment out other references to <literal>ConsoleHandler</literal>,

as shown in the following excerpt.</para>

<programlisting language="ini">

# ConsoleHandler: A simple handler for writing formatted records to System.err

#handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler

handlers=java.util.logging.FileHandler

...

# --- ConsoleHandler ---

# Default: java.util.logging.ConsoleHandler.level = INFO

java.util.logging.ConsoleHandler.level = OFF

#java.util.logging.ConsoleHandler.formatter = ...

#java.util.logging.ConsoleHandler.filter=...</programlisting>

</listitem>

<listitem>

<para>Remove the text-based OSGi console bundle,

<filename>bundle/org.apache.felix.shell.tui-1.4.1.jar</filename>.</para>

</listitem>

<listitem>

<para>Start OpenIDM in the background.</para>

<screen>$ /startup.sh &amp;

[3] 454

$ /startup.sh

Using OPENIDM_HOME: /path/to/openidm

Using OPENIDM_OPTS: -Xmx1024m

Using LOGGING_CONFIG:

-Djava.util.logging.config.file=/path/to/openidm/conf/logging.properties

Using boot properties at /path/to/openidm/conf/boot/boot.properties

$</screen>

</listitem>

</orderedlist>

<para>To stop OpenIDM running as a background process, use the

<command>shutdown.sh</command> script.</para>

<screen>$ /shutdown.sh

/shutdown.sh

Stopping OpenIDM (454)</screen>

</section>

<section xml:id="command-line-tools">

<title>Command-Line Tools</title>

<variablelist>

<para>OpenIDM includes these command line tools in the

<filename>openidm</filename> directory.</para>

<varlistentry>

<term><command>cli.sh</command></term>

<listitem>

<para>This script supports the following subcommands.</para>

<variablelist>

<varlistentry>

<term><command>export</command></term>

<listitem>

<para>Export all objects</para>

</listitem>

</varlistentry>

<varlistentry>

<term><command>keytool</command></term>

<listitem>

<para>Export or import SecretKeyEntry values</para>

</listitem>

</varlistentry>

<varlistentry>

<term><command>validate</command></term>

<listitem>

<para>Validate all .json configuration files in the

<filename>conf/</filename> directory</para>

</listitem>

</varlistentry>

</variablelist>

</listitem>

</varlistentry>

<varlistentry>

<term><command>java -jar /bundle/json-crypto-cli-1.1.0.jar</command></term>

<listitem>

<para>Utility to encrypt and decrypt values in JSON objects</para>

</listitem>

</varlistentry>

<varlistentry>

<term><command>startup.bat</command></term>

<term><command>startup.sh</command></term>

<listitem>

<para>Script to start OpenIDM and the OSGi console</para>

</listitem>

</varlistentry>

<varlistentry>

<term><command>shutdown.sh</command></term>

<listitem>

<para>Script to stop OpenIDM, especially when you run OpenIDM as a

background process</para>

</listitem>

</varlistentry>

</variablelist>

</section>

</chapter>