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 2016-2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029import com.fasterxml.jackson.databind.node.ObjectNode;
030import com.unboundid.scim2.common.filters.Filter;
031import com.unboundid.scim2.common.messages.PatchRequest;
032
033/**
034 * Request context for the method after an entry is updated in the
035 * native data store.
036 */
037public interface StorePostUpdateRequestContext extends StoreRequestContext
038{
039  /**
040   * Retrieve the filter which identifies the entry that was updated.
041   *
042   * @return  The filter which identifies the entry that was updated.
043   */
044  Filter getSCIMFilter();
045
046  /**
047   * Retrieve the SCIM patch request specifying the modifications that were
048   * processed.
049   *
050   * @return  The SCIM patch request specifying the modifications that were
051   * processed.
052   */
053  PatchRequest getPatchRequest();
054
055  /**
056   * Retrieves the updated object returned by the store adapter.
057   * The plugin may make changes directly to this object.
058   *
059   * @return The updated object returned by the store adapter.
060   */
061  ObjectNode getUpdatedObject();
062}