001/*
002 * Copyright 2011-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2011-2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds;
037
038
039
040import com.unboundid.util.LDAPSDKException;
041import com.unboundid.util.NotMutable;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class provides an exception that may be thrown when attempting to obtain
050 * the value of an updated attribute as it appeared before or after a change
051 * was processed, but the number of values for that attribute exceeded the
052 * maximum number to include in a changelog entry.
053 * <BR>
054 * <BLOCKQUOTE>
055 *   <B>NOTE:</B>  This class, and other classes within the
056 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
057 *   supported for use against Ping Identity, UnboundID, and
058 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
059 *   for proprietary functionality or for external specifications that are not
060 *   considered stable or mature enough to be guaranteed to work in an
061 *   interoperable way with other types of LDAP servers.
062 * </BLOCKQUOTE>
063 */
064@NotMutable()
065@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
066public final class ChangeLogEntryAttributeExceededMaxValuesException
067       extends LDAPSDKException
068{
069  /**
070   * The serial version UID for this serializable class.
071   */
072  private static final long serialVersionUID = -9108989779921909512L;
073
074
075
076  // The object providing information about the attribute that had more values
077  // than could be included in a changelog entry.
078  @NotNull private final ChangeLogEntryAttributeExceededMaxValuesCount attrInfo;
079
080
081
082  /**
083   * Creates a new instance of this exception with the provided object.
084   *
085   * @param  message   The message to use for the exception.
086   * @param  attrInfo  An object providing information about the attribute that
087   *                   had more values than could be included in a changelog
088   *                   entry before and/or after the change was processed.
089   */
090  public ChangeLogEntryAttributeExceededMaxValuesException(
091       @NotNull final String message,
092       @NotNull final ChangeLogEntryAttributeExceededMaxValuesCount attrInfo)
093  {
094    super(message);
095
096    this.attrInfo = attrInfo;
097  }
098
099
100
101  /**
102   * Retrieves an object providing information about the attribute that had more
103   * values than could be included in a changelog entry before and/or after the
104   * change was processed.
105   *
106   * @return  An object providing information about the attribute that had more
107   *          values than could be included in a changelog entry before and/or
108   *          after the change was processed.
109   */
110  @NotNull()
111  public ChangeLogEntryAttributeExceededMaxValuesCount getAttributeInfo()
112  {
113    return attrInfo;
114  }
115}