com.novell.ldap.extensions.GetReplicaInfoRequest 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/GetReplicaInfoRequest.java,v 1.17 2004/01/16 04:42:56 sunilk Exp $
 *
 * Copyright (C) 1999, 2000, 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;

/**
 *
 *  Reads information about a replica.
 *
 * The information available includes such items as  replicas state, last
 * modification time, and replica type. 
 *
 *  To read other information about a replica, you must
 *  create an instance of this class and then call the
 *  extendedOperation method with this object as the required
 *  LDAPExtendedOperation parameter.
 *
 *  The getReplicaInfoRequest extension uses the following OID:

 *      2.16.840.1.113719.1.27.100.17
 *
 *  The requestValue has the following format:

 *
 *  requestValue ::=

 *       serverDN        LDAPDN

 *       partitionDN     LDAPDN
 */
public class GetReplicaInfoRequest extends LDAPExtendedOperation {


    static
    {
		/*
         * Register the extendedresponse class which is returned by the
		 * server in response to a GetReplicaInfoRequest
		 */
        try {
            LDAPExtendedResponse.register(
                  ReplicationConstants.GET_REPLICA_INFO_RES,
                  Class.forName(
                  "com.novell.ldap.extensions.GetReplicaInfoResponse"));
        }catch (ClassNotFoundException e) {
            System.err.println("Could not register Extended Response -" +
                               " Class not found");
        }catch(Exception e){
           e.printStackTrace();
        }
        
    }

/**
 *
 * Constructs an extended operations object for reading replica information.
 *
 * @param serverDN The server on which the replica resides.
 * 


 * @param partitionDN The distinguished name of the replica to be read.
 *
 * @exception LDAPException A general exception which includes an error
 *                          message and an LDAP error code.
 */
 public GetReplicaInfoRequest(String serverDN, String partitionDN)
                throws LDAPException {

        super(ReplicationConstants.GET_REPLICA_INFO_REQ, null);

        try {

            if ( (serverDN == null) || (partitionDN == null) )
                throw new IllegalArgumentException(
                                         ExceptionMessages.PARAM_ERROR);

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

          ASN1OctetString asn1_serverDN = new ASN1OctetString(serverDN);
          ASN1OctetString asn1_partitionDN = new ASN1OctetString(partitionDN);

            asn1_serverDN.encode(encoder, encodedData);
            asn1_partitionDN.encode(encoder, encodedData);

            setValue(encodedData.toByteArray());

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

}