• Home
• com.unboundid
• unboundid-ldapsdk-commercial-edition
• 3.1.1
• source code
• GetBackupCompatibilityDescriptorExtendedRequest.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.unboundid.ldap.sdk.unboundidds.extensions.GetBackupCompatibilityDescriptorExtendedRequest Maven / Gradle / Ivy

/*
 * Copyright 2013-2016 UnboundID Corp.
 * All Rights Reserved.
 */
/*
 * Copyright (C) 2015-2016 UnboundID Corp.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see .
 */
package com.unboundid.ldap.sdk.unboundidds.extensions;



import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.ExtendedRequest;
import com.unboundid.ldap.sdk.ExtendedResult;
import com.unboundid.ldap.sdk.LDAPConnection;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.Debug;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;

import static com.unboundid.ldap.sdk.unboundidds.extensions.ExtOpMessages.*;



/**
 * 

 *   NOTE:  This class is part of the Commercial Edition of the UnboundID
 *   LDAP SDK for Java.  It is not available for use in applications that
 *   include only the Standard Edition of the LDAP SDK, and is not supported for
 *   use in conjunction with non-UnboundID products.
 * 
 * This class provides an implementation of an extended request that can be used
 * to retrieve backup compatibility data for a Directory Server backend.  This
 * includes both a token that can be used to compare compatibility data with
 * other servers (or potentially the same server at a later date, for example
 * to check compatibility after upgrading to a new version), and a set of
 * capability strings that may provide additional context about how the backup
 * descriptor may be used.
 * 


 * The OID for this extended request is 1.3.6.1.4.1.30221.2.6.30.  It must have
 * a value with the following encoding:
 * 
 *   GetBackupCompatibilityDescriptorRequest ::= SEQUENCE {
 *        baseDN     [0] OCTET STRING,
 *        ... }
 * 
 *
 * @see  GetBackupCompatibilityDescriptorExtendedResult
 * @see  IdentifyBackupCompatibilityProblemsExtendedRequest
 */
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetBackupCompatibilityDescriptorExtendedRequest
       extends ExtendedRequest
{
  /**
   * The OID (1.3.6.1.4.1.30221.2.6.30) for the get backup compatibility
   * descriptor extended request.
   */
  public static final String GET_BACKUP_COMPATIBILITY_DESCRIPTOR_REQUEST_OID =
       "1.3.6.1.4.1.30221.2.6.30";



  /**
   * The BER type for the base DN element in the value sequence.
   */
  private static final byte TYPE_BASE_DN = (byte) 0x80;



  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = 8170562432854535935L;



  // The base DN for the backend for which to obtain the backup compatibility
  // descriptor.
  private final String baseDN;



  /**
   * Creates a new get backup compatibility descriptor extended request with the
   * provided base DN.
   *
   * @param  baseDN    The base DN for the backend for which to obtain the
   *                   backup compatibility descriptor.  It must not be
   *                   {@code null}, and should be the base DN of a backend
   *                   defined in the server.
   * @param  controls  The set of controls to include in the request.  It may be
   *                   {@code null} or empty if no controls should be included.
   */
  public GetBackupCompatibilityDescriptorExtendedRequest(final String baseDN,
              final Control... controls)
  {
    super(GET_BACKUP_COMPATIBILITY_DESCRIPTOR_REQUEST_OID, encodeValue(baseDN),
         controls);

    this.baseDN = baseDN;
  }



  /**
   * Creates a new get backup compatibility descriptor extended request from the
   * provided generic extended request.
   *
   * @param  r  The generic extended request to decode as a get backup
   *            compatibility descriptor extended request.
   *
   * @throws LDAPException  If the provided request cannot be decoded as a get
   *                        backup compatibility descriptor extended request.
   */
  public GetBackupCompatibilityDescriptorExtendedRequest(
       final ExtendedRequest r)
       throws LDAPException
  {
    super(r);

    final ASN1OctetString value = r.getValue();
    if (value == null)
    {
      throw new LDAPException(ResultCode.DECODING_ERROR,
           ERR_GET_BACKUP_COMPAT_REQUEST_NO_VALUE.get());
    }

    try
    {
      final ASN1Element[] elements =
           ASN1Sequence.decodeAsSequence(value.getValue()).elements();
      baseDN = ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
    }
    catch (final Exception e)
    {
      Debug.debugException(e);
      throw new LDAPException(ResultCode.DECODING_ERROR,
           ERR_GET_BACKUP_COMPAT_REQUEST_ERROR_PARSING_VALUE.get(
                StaticUtils.getExceptionMessage(e)),
           e);
    }
  }



  /**
   * Encodes the provided information into a format suitable for use as the
   * value of this extended request.
   *
   * @param  baseDN  The base DN for the backend for which to obtain the
   *                 backup compatibility descriptor.  It must not be
   *                 {@code null}, and should be the base DN of a backend
   *                 defined in the server.
   *
   * @return  The ASN.1 octet string containing the encoded representation of
   *          the provided information.
   */
  private static ASN1OctetString encodeValue(final String baseDN)
  {
    Validator.ensureNotNull(baseDN);

    final ASN1Sequence valueSequence = new ASN1Sequence(
         new ASN1OctetString(TYPE_BASE_DN, baseDN));
    return new ASN1OctetString(valueSequence.encode());
  }



  /**
   * Retrieves the base DN for the backend for which to obtain the backup
   * compatibility descriptor.
   *
   * @return  The base DN for the backend for which to obtain the backup
   *          compatibility descriptor.
   */
  public String getBaseDN()
  {
    return baseDN;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public GetBackupCompatibilityDescriptorExtendedResult process(
              final LDAPConnection connection, final int depth)
         throws LDAPException
  {
    final ExtendedResult extendedResponse = super.process(connection, depth);
    return new GetBackupCompatibilityDescriptorExtendedResult(extendedResponse);
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public GetBackupCompatibilityDescriptorExtendedRequest duplicate()
  {
    return duplicate(getControls());
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public GetBackupCompatibilityDescriptorExtendedRequest duplicate(
              final Control[] controls)
  {
    final GetBackupCompatibilityDescriptorExtendedRequest r =
         new GetBackupCompatibilityDescriptorExtendedRequest(baseDN, controls);
    r.setResponseTimeoutMillis(getResponseTimeoutMillis(null));
    return r;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public String getExtendedRequestName()
  {
    return INFO_EXTENDED_REQUEST_NAME_GET_BACKUP_COMPAT.get();
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public void toString(final StringBuilder buffer)
  {
    buffer.append("GetBackupCompatibilityDescriptorExtendedRequest(baseDN='");
    buffer.append(baseDN);
    buffer.append('\'');

    final Control[] controls = getControls();
    if (controls.length > 0)
    {
      buffer.append(", controls={");
      for (int i=0; i < controls.length; i++)
      {
        if (i > 0)
        {
          buffer.append(", ");
        }

        buffer.append(controls[i]);
      }
      buffer.append('}');
    }

    buffer.append(')');
  }
}