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 *      Portions Copyright 2010-2023 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.proxy.types;
028
029
030
031import java.util.List;
032
033import com.unboundid.util.NotExtensible;
034import com.unboundid.util.ThreadSafety;
035import com.unboundid.util.ThreadSafetyLevel;
036
037
038
039/**
040 * This interface defines a set of methods that may be used interact with a
041 * location defined in the server.
042 */
043@NotExtensible()
044@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
045public interface Location
046{
047  /**
048   * Retrieves the name assigned to this location.
049   *
050   * @return  The name assigned to this location.
051   */
052  String getName();
053
054
055
056  /**
057   * Retrieves the DN of the configuration entry for this location.
058   *
059   * @return  The DN of the configuration entry for this location.
060   */
061  String getConfigEntryDN();
062
063
064
065  /**
066   * Retrieves an ordered list of the preferred failover locations for this
067   * location.
068   *
069   * @return  An ordered list of the preferred failover locations for this
070   *          location.
071   */
072  List<Location> getPreferredFailoverLocations();
073}