| | |
| | | * |
| | | * Copyright 2008 Sun Microsystems, Inc. |
| | | */ |
| | | |
| | | package org.opends.server.admin.server; |
| | | |
| | | |
| | | |
| | | import static com.forgerock.opendj.ldap.AdminMessages.*; |
| | | import static com.forgerock.opendj.util.Validator.*; |
| | | |
| | | import java.util.ArrayList; |
| | | import java.util.Collection; |
| | |
| | | import org.forgerock.i18n.LocalizableMessage; |
| | | import org.forgerock.i18n.LocalizableMessageBuilder; |
| | | import org.opends.server.admin.DecodingException; |
| | | import static com.forgerock.opendj.util.Validator.*; |
| | | |
| | | |
| | | |
| | | /** |
| | | * This exception is thrown when the server refuses to use or delete a |
| | | * managed object due to one or more constraints that cannot be |
| | | * satisfied. |
| | | * This exception is thrown when the server refuses to use or delete a managed |
| | | * object due to one or more constraints that cannot be satisfied. |
| | | */ |
| | | public class ConstraintViolationException extends DecodingException { |
| | | |
| | | /** |
| | | * Serialization ID. |
| | | */ |
| | | private static final long serialVersionUID = -4902443848460011875L; |
| | | /** |
| | | * Serialization ID. |
| | | */ |
| | | private static final long serialVersionUID = -4902443848460011875L; |
| | | |
| | | // The server managed object. |
| | | private final ServerManagedObject<?> managedObject; |
| | | // The server managed object. |
| | | private final ServerManagedObject<?> managedObject; |
| | | |
| | | // Gets the default message. |
| | | private static LocalizableMessage getDefaultMessage(Collection<LocalizableMessage> messages) { |
| | | ensureNotNull(messages); |
| | | ensureTrue(!messages.isEmpty(), "messages should not be empty"); |
| | | |
| | | |
| | | // Gets the default message. |
| | | private static LocalizableMessage getDefaultMessage(Collection<Message> messages) { |
| | | Validator.ensureNotNull(messages); |
| | | Validator.ensureTrue(!messages.isEmpty()); |
| | | |
| | | if (messages.size() == 1) { |
| | | return ERR_CONSTRAINT_VIOLATION_EXCEPTION_SINGLE.get(messages.iterator() |
| | | .next()); |
| | | } else { |
| | | return ERR_CONSTRAINT_VIOLATION_EXCEPTION_PLURAL |
| | | .get(getSingleMessage(messages)); |
| | | } |
| | | } |
| | | |
| | | |
| | | |
| | | // Merge the messages into a single message. |
| | | private static LocalizableMessage getSingleMessage(Collection<Message> messages) { |
| | | if (messages.size() == 1) { |
| | | return messages.iterator().next(); |
| | | } else { |
| | | LocalizableMessageBuilder builder = new MessageBuilder(); |
| | | |
| | | boolean isFirst = true; |
| | | for (LocalizableMessage m : messages) { |
| | | if (!isFirst) { |
| | | builder.append("; "); |
| | | if (messages.size() == 1) { |
| | | return ERR_CONSTRAINT_VIOLATION_EXCEPTION_SINGLE.get(messages.iterator().next()); |
| | | } else { |
| | | return ERR_CONSTRAINT_VIOLATION_EXCEPTION_PLURAL.get(getSingleMessage(messages)); |
| | | } |
| | | builder.append(m); |
| | | isFirst = false; |
| | | } |
| | | |
| | | return builder.toMessage(); |
| | | } |
| | | } |
| | | |
| | | // The messages describing the constraint violations that occurred. |
| | | private final Collection<LocalizableMessage> messages; |
| | | // Merge the messages into a single message. |
| | | private static LocalizableMessage getSingleMessage(Collection<LocalizableMessage> messages) { |
| | | if (messages.size() == 1) { |
| | | return messages.iterator().next(); |
| | | } else { |
| | | LocalizableMessageBuilder builder = new LocalizableMessageBuilder(); |
| | | |
| | | boolean isFirst = true; |
| | | for (LocalizableMessage m : messages) { |
| | | if (!isFirst) { |
| | | builder.append("; "); |
| | | } |
| | | builder.append(m); |
| | | isFirst = false; |
| | | } |
| | | |
| | | return builder.toMessage(); |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Creates a new constraint violation exception with the provided |
| | | * messages. |
| | | * |
| | | * @param managedObject |
| | | * The server managed object which caused the constraint |
| | | * violations. |
| | | * @param messages |
| | | * The messages describing the constraint violations that |
| | | * occurred (must be non-<code>null</code> and |
| | | * non-empty). |
| | | */ |
| | | public ConstraintViolationException(ServerManagedObject<?> managedObject, |
| | | Collection<LocalizableMessage> messages) { |
| | | super(getDefaultMessage(messages)); |
| | | // The messages describing the constraint violations that occurred. |
| | | private final Collection<LocalizableMessage> messages; |
| | | |
| | | this.managedObject = managedObject; |
| | | this.messages = new ArrayList<LocalizableMessage>(messages); |
| | | } |
| | | /** |
| | | * Creates a new constraint violation exception with the provided messages. |
| | | * |
| | | * @param managedObject |
| | | * The server managed object which caused the constraint |
| | | * violations. |
| | | * @param messages |
| | | * The messages describing the constraint violations that |
| | | * occurred (must be non-<code>null</code> and non-empty). |
| | | */ |
| | | public ConstraintViolationException(ServerManagedObject<?> managedObject, Collection<LocalizableMessage> messages) { |
| | | super(getDefaultMessage(messages)); |
| | | |
| | | this.managedObject = managedObject; |
| | | this.messages = new ArrayList<LocalizableMessage>(messages); |
| | | } |
| | | |
| | | /** |
| | | * Creates a new constraint violation exception with the provided message. |
| | | * |
| | | * @param managedObject |
| | | * The server managed object which caused the constraint |
| | | * violations. |
| | | * @param message |
| | | * The message describing the constraint violation that occurred. |
| | | */ |
| | | public ConstraintViolationException(ServerManagedObject<?> managedObject, LocalizableMessage message) { |
| | | this(managedObject, Collections.singleton(message)); |
| | | } |
| | | |
| | | /** |
| | | * Creates a new constraint violation exception with the provided |
| | | * message. |
| | | * |
| | | * @param managedObject |
| | | * The server managed object which caused the constraint |
| | | * violations. |
| | | * @param message |
| | | * The message describing the constraint violation that |
| | | * occurred. |
| | | */ |
| | | public ConstraintViolationException(ServerManagedObject<?> managedObject, |
| | | LocalizableMessage message) { |
| | | this(managedObject, Collections.singleton(message)); |
| | | } |
| | | /** |
| | | * Gets an unmodifiable collection view of the messages describing the |
| | | * constraint violations that occurred. |
| | | * |
| | | * @return Returns an unmodifiable collection view of the messages |
| | | * describing the constraint violations that occurred. |
| | | */ |
| | | public Collection<LocalizableMessage> getMessages() { |
| | | return Collections.unmodifiableCollection(messages); |
| | | } |
| | | |
| | | /** |
| | | * Creates a single message listing all the messages combined into a single |
| | | * list separated by semi-colons. |
| | | * |
| | | * @return Returns a single message listing all the messages combined into a |
| | | * single list separated by semi-colons. |
| | | */ |
| | | public LocalizableMessage getMessagesAsSingleMessage() { |
| | | return getSingleMessage(messages); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Gets an unmodifiable collection view of the messages describing |
| | | * the constraint violations that occurred. |
| | | * |
| | | * @return Returns an unmodifiable collection view of the messages |
| | | * describing the constraint violations that occurred. |
| | | */ |
| | | public Collection<LocalizableMessage> getMessages() { |
| | | return Collections.unmodifiableCollection(messages); |
| | | } |
| | | |
| | | |
| | | |
| | | /** |
| | | * Creates a single message listing all the messages combined into a |
| | | * single list separated by semi-colons. |
| | | * |
| | | * @return Returns a single message listing all the messages |
| | | * combined into a single list separated by semi-colons. |
| | | */ |
| | | public LocalizableMessage getMessagesAsSingleMessage() { |
| | | return getSingleMessage(messages); |
| | | } |
| | | |
| | | |
| | | |
| | | /** |
| | | * Gets the server managed object which caused the constraint |
| | | * violations. |
| | | * |
| | | * @return Returns the server managed object which caused the |
| | | * constraint violations. |
| | | */ |
| | | public ServerManagedObject<?> getManagedObject() { |
| | | return managedObject; |
| | | } |
| | | /** |
| | | * Gets the server managed object which caused the constraint violations. |
| | | * |
| | | * @return Returns the server managed object which caused the constraint |
| | | * violations. |
| | | */ |
| | | public ServerManagedObject<?> getManagedObject() { |
| | | return managedObject; |
| | | } |
| | | } |