com.novell.ldap.extensions.ListReplicasRequest 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/ListReplicasRequest.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;
import com.novell.ldap.client.Debug;
/**
 *
 *  Lists all the replicas that reside on the the specified directory server.
 *
 *  To list replicas, you must create an instance
 *  of this class and then call the extendedOperation method with this
 *  object as the required LDAPExtendedOperation parameter.
 *
 *  The listReplicaRequest extension uses the following OID:

 *     2.16.840.1.113719.1.27.100.19
 *
 *  The requestValue has the following format:

 *
 *  requestValue ::=

 *        serverName     LDAPDN
 */
public class ListReplicasRequest extends LDAPExtendedOperation {



    static
    {
		/*
         * Register the extendedresponse class which is returned by the
		 * server in response to a ListReplicasRequest
		 */
        try {
            LDAPExtendedResponse.register(
                ReplicationConstants.LIST_REPLICAS_RES,
                Class.forName(
                "com.novell.ldap.extensions.ListReplicasResponse"));
        }catch (ClassNotFoundException e) {
            System.err.println("Could not register Extended Response -" +
                               " Class not found");
        }catch(Exception e){
           e.printStackTrace();
        }
        
    }
/**
 *  Constructs an extended operation object for listing replicas.
 *
 * @param serverName The server which contains replicas.
 *
 * @exception LDAPException A general exception which includes an error
 *                          message and an LDAP error code.
 */
 public ListReplicasRequest(String serverName)
                throws LDAPException {

        super(ReplicationConstants.LIST_REPLICAS_REQ, null);

        try {

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

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

          ASN1OctetString asn1_serverName = new ASN1OctetString(serverName);

            asn1_serverName.encode(encoder, encodedData);

            setValue(encodedData.toByteArray());

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

}