<schema package="org.apache.qpid.ha">

  <!--
      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.
  -->

  <!-- Monitor and control HA status of a broker. -->
  <class name="HaBroker">
    <property name="name"   type="sstr" access="RC" index="y" desc="Primary Key"/>

    <property name="status" type="sstr" desc="HA status: primary or backup"/>

    <property name="brokersUrl" type="sstr"
	      desc="URL with address of each broker in the cluster."/>

    <property name="publicUrl" type="sstr"
	      desc="URL advertized to clients to connect to the cluster."/>

    <property name="expectedBackups" type="uint16"
	      desc="Number of HA backup brokers expected."/>

    <property name="replicateDefault" type="sstr"
	      desc="Replication for queues/exchanges with no qpid.replicate argument"/>

    <property name="members" type="list" desc="List of brokers in the cluster"/>

    <property name="systemId" type="uuid" desc="Identifies the system."/>

    <method name="promote" desc="Promote a backup broker to primary."/>

    <method name="setBrokersUrl" desc="URL listing each broker in the cluster.">
      <arg name="url" type="sstr" dir="I"/>
    </method>

    <method name="setPublicUrl" desc="URL advertized to clients.">
      <arg name="url" type="sstr" dir="I"/>
    </method>

    <method name="setExpectedBackups" desc="Set number of backups expected">
      <arg name="expectedBackups" type="uint16" dir="I"/>
    </method>

    <method name="replicate" desc="Replicate individual queue from remote broker.">
      <arg name="broker" type="sstr" dir="I"/>
      <arg name="queue" type="sstr" dir="I"/>
    </method>
  </class>

  <eventArguments>
    <arg name="members" type="list" desc="List of broker information maps"/>
  </eventArguments>

  <event name="membersUpdate" sev="inform" args="members"/>

</schema>
