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

/* **************************************************************************
 * $OpenLDAP$
 *
 * 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.rfc2251.*;
import java.io.IOException;

/**
 * Retrieves the list of replicas from the specified server.
 *
 *  An object in this class is generated from an ExtendedResponse object
 *  using the ExtendedResponseFactory class.
 *
 * The listReplicaResponse extension uses the following OID:

 *     2.16.840.1.113719.1.27.20
 *
 */
public class ListReplicasResponse extends LDAPExtendedResponse {

   // Identity returned by the server
   private String[] replicaList;

   /**
    * Constructs an object from the responseValue which contains the list
    * of replicas.
    *
    * The constructor parses the responseValue which has the following
    * format:

    *  responseValue ::=

    *        replicaList   
    *                                    SEQUENCE OF OCTET STRINGS
    *
    * @exception IOException  The responseValue could not be decoded.
    */
   public ListReplicasResponse (RfcLDAPMessage rfcMessage)
         throws IOException {

        super(rfcMessage);

        if (getResultCode() != LDAPException.SUCCESS)
        {
            replicaList = new String[0];
        }
        else
        {
            // parse the contents of the reply
            byte [] returnedValue = this.getValue();
            if (returnedValue == null)
                throw new IOException("No returned value");

            // Create a decoder object
            LBERDecoder decoder = new LBERDecoder();
            if (decoder == null)
                throw new IOException("Decoding error");

            // We should get back a sequence
            ASN1Sequence returnedSequence = (ASN1Sequence)decoder.decode(returnedValue);
            if (returnedSequence == null)
                throw new IOException("Decoding error");

            // How many replicas were returned
            int len = returnedSequence.size();
            replicaList = new String[len];

            // Copy each one into our String array
          for(int i=0; i < len; i++) {
              // Get the next ASN1Octet String in the sequence
              ASN1OctetString asn1_nextReplica = (ASN1OctetString)returnedSequence.get(i);
              if (asn1_nextReplica == null)
                    throw new IOException("Decoding error");

                // Convert to a string
             replicaList[i] = asn1_nextReplica.stringValue();
             if (replicaList[i] == null)
                    throw new IOException("Decoding error");
          }
      }
   }

   /**
    * Returns a list of distinguished names for the replicas on the server.
    *
    * @return String value specifying the identity returned by the server
    */
   public String[] getReplicaList() {
        return replicaList;
   }

}