Fix issue 1443: Admin framework: improve error logging in server

matthew_swift

03.36.2007 de19fe2956d5a4b3817834191c51989664f8c47c

 opends/src/server/org/opends/server/admin/client/ManagedObjectDecodingException.java

@@ -26,22 +26,28 @@
 */

package org.opends.server.admin.client;



import static org.opends.messages.AdminMessages.*;

import org.opends.messages.Message;


import org.opends.messages.MessageBuilder;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;

import org.opends.server.admin.DecodingException;
import org.opends.server.admin.ManagedObjectDefinition;
import org.opends.server.admin.PropertyException;
import org.opends.server.util.Validator;



/**
 * The requested managed object was found but one or more of its properties
 * could not be decoded successfully.
 * The requested managed object was found but one or more of its
 * properties could not be decoded successfully.
 */
public class ManagedObjectDecodingException extends DecodingException {

@@ -50,26 +56,59 @@
   */
  private static final long serialVersionUID = -4268510652395945357L;

  // The partially created managed object.
  private final ManagedObject<?> partialManagedObject;


  // Create the message.
  private static Message createMessage(ManagedObject<?> partialManagedObject,
      Collection<PropertyException> causes) {
    Validator.ensureNotNull(causes);
    Validator.ensureTrue(!causes.isEmpty());

    ManagedObjectDefinition<?, ?> d = partialManagedObject
        .getManagedObjectDefinition();
    if (causes.size() == 1) {
      return ERR_MANAGED_OBJECT_DECODING_EXCEPTION_SINGLE.get(d
          .getUserFriendlyName(), causes.iterator().next().getMessageObject());
    } else {
      MessageBuilder builder = new MessageBuilder();

      boolean isFirst = true;
      for (PropertyException cause : causes) {
        if (!isFirst) {
          builder.append("; ");
        }
        builder.append(cause.getMessageObject());
        isFirst = false;
      }

      return ERR_MANAGED_OBJECT_DECODING_EXCEPTION_PLURAL.get(d
          .getUserFriendlyName(), builder.toMessage());
    }
  }

  // The exception(s) that caused this decoding exception.
  private final Collection<PropertyException> causes;

  // The partially created managed object.
  private final ManagedObject<?> partialManagedObject;



  /**
   * Create a new property decoding exception.
   *
   * @param partialManagedObject
   *          The partially created managed object containing properties which
   *          were successfully decoded and empty properties for those which
   *          were not (this may include empty mandatory properties).
   *          The partially created managed object containing
   *          properties which were successfully decoded and empty
   *          properties for those which were not (this may include
   *          empty mandatory properties).
   * @param causes
   *          The exception(s) that caused this decoding exception.
   */
  public ManagedObjectDecodingException(ManagedObject<?> partialManagedObject,
      Collection<PropertyException> causes) {
    super(createMessage(partialManagedObject, causes));

    this.partialManagedObject = partialManagedObject;
    this.causes = Collections
        .unmodifiableList(new LinkedList<PropertyException>(causes));
@@ -78,10 +117,11 @@


  /**
   * Get an unmodifiable collection view of the causes of this exception.
   * Get an unmodifiable collection view of the causes of this
   * exception.
   *
   * @return Returns an unmodifiable collection view of the causes of this
   *         exception.
   * @return Returns an unmodifiable collection view of the causes of
   *         this exception.
   */
  public Collection<PropertyException> getCauses() {
    return causes;
@@ -90,28 +130,14 @@


  /**
   * {@inheritDoc}
   */
  @Override
  public Message getMessageObject() {
    StringBuilder builder = new StringBuilder();
    builder.append("The managed object could not be decoded due"
        + " to the following property exceptions: ");
    // FIXME: better formatting.
    builder.append(causes.toString());
    return Message.raw(builder.toString()); // TODO: i18n?
  }



  /**
   * Get the partially created managed object containing properties which were
   * successfully decoded and empty properties for those which were not (this
   * may include empty mandatory properties).
   * Get the partially created managed object containing properties
   * which were successfully decoded and empty properties for those
   * which were not (this may include empty mandatory properties).
   *
   * @return Returns the partially created managed object containing properties
   *         which were successfully decoded and empty properties for those
   *         which were not (this may include empty mandatory properties).
   * @return Returns the partially created managed object containing
   *         properties which were successfully decoded and empty
   *         properties for those which were not (this may include
   *         empty mandatory properties).
   */
  public ManagedObject<?> getPartialManagedObject() {
    return partialManagedObject;