<?xml version="1.0" encoding="utf-8"?>
<!--
  ! CDDL HEADER START
  !
  ! The contents of this file are subject to the terms of the
  ! Common Development and Distribution License, Version 1.0 only
  ! (the "License").  You may not use this file except in compliance
  ! with the License.
  !
  ! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
  ! or http://forgerock.org/license/CDDLv1.0.html.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! When distributing Covered Code, include this CDDL HEADER in each
  ! file and include the License file at legal-notices/CDDLv1_0.txt.
  ! If applicable, add the following below this CDDL HEADER, with the
  ! fields enclosed by brackets "[]" replaced with your own identifying
  ! information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CDDL HEADER END
  !
  !
  !      Copyright 2007-2008 Sun Microsystems, Inc.
  !      Portions Copyright 2012 ForgeRock AS
  ! -->
<adm:managed-object name="change-number-control-plugin"
  plural-name="change-number-control-plugins" package="org.forgerock.opendj.admin"
  extends="plugin" xmlns:adm="http://www.opends.org/admin"
  xmlns:ldap="http://www.opends.org/admin-ldap">
  <adm:synopsis>
    The
    <adm:user-friendly-name />
    returns the change number generated by the replication subsystem.
  </adm:synopsis>
  <adm:description>
    The <adm:user-friendly-name /> returns the change number generated
    by the Multi-Master Replication subsystem when :
     - the Multi-Master Replication is configured and enabled
     - the request is a write operation (add, delete, modify, moddn)
     - the control is part of a request.
    If all of the above are true, the response contains a control response
    with a string representing the change number.
    The implementation for the chnage number control plug-in is contained 
    in the org.opends.server.plugins.ChangeNumberControlPlugin class. It must be 
    configured with the postOperationAdd, postOperationDelete,
    postOperationModify and postOperationModifyDN plug-in types,
    but it does not have any other custom configuration.
  </adm:description>
  <adm:profile name="ldap">
    <ldap:object-class>
      <ldap:name>ds-cfg-change-number-control-plugin</ldap:name>
      <ldap:superior>ds-cfg-plugin</ldap:superior>
    </ldap:object-class>
  </adm:profile>
  <adm:property-override name="java-class" advanced="true">
    <adm:default-behavior>
      <adm:defined>
        <adm:value>org.opends.server.plugins.ChangeNumberControlPlugin</adm:value>
      </adm:defined>
    </adm:default-behavior>
  </adm:property-override>
  <adm:property-override name="plugin-type" advanced="true">
    <adm:default-behavior>
      <adm:defined>
        <adm:value>postOperationAdd</adm:value>
        <adm:value>postOperationDelete</adm:value>
        <adm:value>postOperationModify</adm:value>
        <adm:value>postOperationModifyDN</adm:value>        
      </adm:defined>
    </adm:default-behavior>
  </adm:property-override>
</adm:managed-object>