001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2014-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.ds.types;
028
029import com.unboundid.ldap.sdk.unboundidds.UnboundIDChangeLogEntry;
030import com.unboundid.util.NotExtensible;
031import com.unboundid.util.ThreadSafety;
032import com.unboundid.util.ThreadSafetyLevel;
033
034import java.util.Map;
035
036
037
038/**
039 * This interface defines a set of methods that may be used to obtain
040 * information about a single change in a notification to be delivered by a
041 * notification manager. A notification can include more than one change when
042 * the changes are part of an external transaction (e.g. a multi-update
043 * extended operation), unless the notification manager is configured to treat
044 * the changes individually.
045 */
046@NotExtensible()
047@ThreadSafety(level= ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
048public interface NotificationChange
049{
050  /**
051   * Retrieve the change log entry for the change that was made.
052   *
053   * @return  The change log entry for the change that was made.
054   */
055  UnboundIDChangeLogEntry getChangeLogEntry();
056
057
058
059  /**
060   * Retrieve the properties provided by the notification manager for this
061   * change by one of the {@code get*NotificationProperties} methods. The
062   * returned properties may not be modified.
063   *
064   * @return  The properties provided by the notification manager for this
065   *          change. The returned properties may not be modified.
066   */
067  Map<String,String> getProperties();
068}