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 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.proxy.types;
028    
029    
030    
031    import java.util.List;
032    
033    import com.unboundid.ldap.sdk.DN;
034    import com.unboundid.util.NotExtensible;
035    import com.unboundid.util.ThreadSafety;
036    import com.unboundid.util.ThreadSafetyLevel;
037    
038    
039    
040    /**
041     * This interface defines a set of methods that may be used to obtain
042     * information about and interact with a proxying request processor and its
043     * associated backend servers.
044     */
045    @NotExtensible()
046    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
047    public interface ProxyingRequestProcessor
048    {
049      /**
050       * Retrieves the base DN for the entry-balancing request processor.
051       *
052       * @return  The base DN for the entry-balancing request processor.
053       */
054      DN getRequestProcessorBaseDN();
055    
056    
057    
058      /**
059       * Retrieves a list of the backend servers for this proxying request
060       * processor.
061       *
062       * @return  A list of the backend servers for this proxying request processor.
063       */
064      List<BackendServer> getBackendServers();
065    }