001    /*
002     * Copyright 2014-2016 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2014-2016 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     */
021    package com.unboundid.ldap.listener.interceptor;
022    
023    
024    
025    import com.unboundid.ldap.sdk.SimpleBindRequest;
026    import com.unboundid.util.NotExtensible;
027    import com.unboundid.util.ThreadSafety;
028    import com.unboundid.util.ThreadSafetyLevel;
029    
030    
031    
032    /**
033     * This class provides an API that can be used in the course of processing a
034     * simple bind request via the {@link InMemoryOperationInterceptor} API.
035     */
036    @NotExtensible()
037    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
038    public interface InMemoryInterceptedSimpleBindRequest
039           extends InMemoryInterceptedRequest
040    {
041      /**
042       * Retrieves the bind request to be processed.
043       *
044       * @return  The bind request to be processed.
045       */
046      SimpleBindRequest getRequest();
047    
048    
049    
050      /**
051       * Replaces the bind request to be processed.
052       *
053       * @param  bindRequest  The bind request that should be processed instead of
054       *                      the one that was originally received from the client.
055       *                      It must not be {@code null}.
056       */
057      void setRequest(final SimpleBindRequest bindRequest);
058    }