<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE entities [
<!ENTITY %  entities SYSTEM  "../../commonEntities.xml">
%entities;
]>
<!--

 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.

-->

<section id="Java-Broker-Management-Managing-Keystores">
    <title>Keystores</title>
    <para>A <link linkend="Java-Broker-Concepts-Keystores">Keystore</link> is required by a Port
        in order to use SSL.</para>
    <section id="Java-Broker-Management-Managing-Keystores-Attributes">
        <title>Attributes</title>
        <para><itemizedlist>
                <listitem>
                    <para><emphasis>Name the keystore</emphasis>. Used to identify the
                        keystore.</para>
                </listitem>
                <listitem>
                    <para><emphasis>Path</emphasis>. Path to keystore file</para>
                </listitem>
                <listitem>
                    <para><emphasis>Keystore password</emphasis>. Password used to secure the keystore<important>
                            <para> The password of the certificate used by the Broker <emphasis
                                    role="bold">must</emphasis> match the password of the keystore
                                itself. This is a restriction of the Qpid Broker implementation. If
                                using the <ulink url="&oracleKeytool;">keytool</ulink> utility, note
                                that this means the argument to the <option>-keypass</option> option
                                must match the <option>-storepass</option> option. </para>
                        </important></para>
                </listitem>
                <listitem>
                    <para><emphasis>Certificate Alias</emphasis>. An optional way of specifying
                        which certificate the broker should use if the keystore contains multiple
                        entries.</para>
                </listitem>
                <listitem>
                    <para><emphasis>Manager Factory Algorithm</emphasis>. In keystores the have more
                        than one certificate, the alias identifies the certificate to be
                        used.</para>
                </listitem>
                <listitem>
                    <para><emphasis>Key Store Type</emphasis>. Type of Keystore.</para>
                </listitem>
            </itemizedlist></para>
    </section>
    <section id="Java-Broker-Management-Managing-Keystores-Children">
        <title>Children</title>
        <para>None</para>
    </section>
    <section id="Java-Broker-Management-Managing-Keystores-Lifecycle">
        <title>Lifecycle</title>
        <para>Not supported</para>
    </section>
</section>
