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.unboundid.scim2.common.filters.Filter; 030import com.unboundid.scim2.common.messages.PatchRequest; 031 032/** 033 * Request context for the method called before an entry is updated in the 034 * native data store. 035 */ 036public interface StorePreUpdateRequestContext extends StoreRequestContext 037{ 038 /** 039 * Retrieve the filter which identifies the entry to be updated. 040 * The UnboundID scim2 SDK Filter class can be used to parse a SCIM filter. 041 * 042 * @return The filter which identifies the entry to be updated. 043 */ 044 Filter getSCIMFilter(); 045 046 /** 047 * Sets the SCIM filter which identifies the entry to be updated. 048 * 049 * @param scimFilter The SCIM filter which identifies the entry to be 050 * updated. 051 */ 052 void setSCIMFilter(Filter scimFilter); 053 054 /** 055 * Retrieve the SCIM patch request specifying the modifications to be 056 * processed. 057 * 058 * @return The SCIM patch request specifying the modifications to be 059 * processed. 060 */ 061 PatchRequest getPatchRequest(); 062 063 /** 064 * Sets the SCIM patch request specifying the modifications to be processed. 065 * 066 * @param patchRequest The SCIM patch request specifying the modifications to 067 * be processed. 068 */ 069 void setPatchRequest(PatchRequest patchRequest); 070}