com.novell.ldap.extensions.PartitionSyncRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jldap Show documentation
There is a newer version: 2009-10-07
/* **************************************************************************
 * $OpenLDAP: pkg/jldap/com/novell/ldap/extensions/PartitionSyncRequest.java,v 1.3 2003/08/21 10:41:54 kkanil Exp $
 *
 * Copyright (C) 2001 Novell, Inc. All Rights Reserved.
 *
 * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND
 * TREATIES. USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT
 * TO VERSION 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS
 * AVAILABLE AT HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE"
 * IN THE TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION
 * OF THIS WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP
 * PUBLIC LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT
 * THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
 ******************************************************************************/
package com.novell.ldap.extensions;

import com.novell.ldap.*;
import com.novell.ldap.asn1.*;
import com.novell.ldap.resources.*;
import java.io.IOException;
import java.io.ByteArrayOutputStream;

/**
 *
 *  Synchronizes all replicas of a naming context.
 *
 *  The PartitionSyncRequest extension uses the following OID:

 *     2.16.840.1.113719.1.27.100.25
 *
 *  The requestValue has the following format:

 *
 *  requestValue ::=

 *       serverName         LDAPDN

 *       partitionRoot      LDAPDN

 *       delay              INTEGER
 */
public class PartitionSyncRequest extends LDAPExtendedOperation {

/**
 *
 *   Constructs an extended operation object for synchronizing the replicas
 *   of a partition.
 *
 * @param serverName     The distinquished name of server containing the
 *                       naming context.
 * 


 * @param partitionRoot  The distinguished name of the naming context
 *                       to synchronize.
 *


 * @param delay          The time, in seconds, to delay before the synchronization
 *                       should start.
 *
 * @exception LDAPException A general exception which includes an error message
 *                          and an LDAP error code.
 */
 public PartitionSyncRequest(String serverName, String partitionRoot, int delay)
                throws LDAPException {

        super(ReplicationConstants.NAMING_CONTEXT_SYNC_REQ, null);

        try {

            if ( (serverName == null) || (partitionRoot == null) )
                throw new IllegalArgumentException(
                                         ExceptionMessages.PARAM_ERROR);

            ByteArrayOutputStream encodedData = new ByteArrayOutputStream();
            LBEREncoder encoder  = new LBEREncoder();

            ASN1OctetString asn1_serverName = new ASN1OctetString(serverName);
            ASN1OctetString asn1_partitionRoot = new ASN1OctetString(partitionRoot);
            ASN1Integer asn1_delay = new ASN1Integer(delay);

            asn1_serverName.encode(encoder, encodedData);
            asn1_partitionRoot.encode(encoder, encodedData);
            asn1_delay.encode(encoder, encodedData);

            setValue(encodedData.toByteArray());
        }
        catch(IOException ioe) {
            throw new LDAPException(ExceptionMessages.ENCODING_ERROR,
                                       LDAPException.ENCODING_ERROR,
                                       (String)null);
        }
    }
}