001/*
002 * Copyright 2014-2017 UnboundID Corp.
003 * All Rights Reserved.
004 */
005/*
006 * Copyright (C) 2014-2017 UnboundID Corp.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU General Public License (GPLv2 only)
010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
011 * as published by the Free Software Foundation.
012 *
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Public License for more details.
017 *
018 * You should have received a copy of the GNU General Public License
019 * along with this program; if not, see <http://www.gnu.org/licenses>.
020 */
021package com.unboundid.ldap.listener.interceptor;
022
023
024
025import com.unboundid.ldap.sdk.AddRequest;
026import com.unboundid.ldap.sdk.ReadOnlyAddRequest;
027import com.unboundid.util.NotExtensible;
028import com.unboundid.util.ThreadSafety;
029import com.unboundid.util.ThreadSafetyLevel;
030
031
032
033/**
034 * This class provides an API that can be used in the course of processing an
035 * add request via the {@link InMemoryOperationInterceptor} API.
036 */
037@NotExtensible()
038@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
039public interface InMemoryInterceptedAddRequest
040       extends InMemoryInterceptedRequest
041{
042  /**
043   * Retrieves the add request to be processed.
044   *
045   * @return  The add request to be processed.
046   */
047  ReadOnlyAddRequest getRequest();
048
049
050
051  /**
052   * Replaces the add request to be processed.
053   *
054   * @param  addRequest  The add request that should be processed instead of the
055   *                     one that was originally received from the client.  It
056   *                     must not be {@code null}.
057   */
058  void setRequest(final AddRequest addRequest);
059}