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 2010-2013 UnboundID Corp.
026     */
027    package com.unboundid.directory.sdk.common.types;
028    
029    
030    
031    import com.unboundid.util.NotExtensible;
032    import com.unboundid.util.ThreadSafety;
033    import com.unboundid.util.ThreadSafetyLevel;
034    
035    
036    
037    /**
038     * This interface defines a set of methods which may be used to obtain
039     * information about a server to which an operation may be forwarded for
040     * processing.
041     */
042    @NotExtensible()
043    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
044    public interface ForwardTarget
045    {
046      /**
047       * Retrieves the address of the target server.
048       *
049       * @return  The address of the target server.
050       */
051      String getForwardTargetAddress();
052    
053    
054    
055      /**
056       * Retrieves the port of the target server.
057       *
058       * @return  The port of the target server.
059       */
060      int getForwardTargetPort();
061    
062    
063    
064      /**
065       * Retrieves the name of the protocol used to communicate with the target
066       * server.
067       *
068       * @return  The name of the protocol used to communicate with the target
069       *          server.
070       */
071      String getForwardTargetProtocol();
072    }