com.unboundid.directory.sdk.proxy.types

Interface Location

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface Location

This interface defines a set of methods that may be used interact with a location defined in the server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigEntryDN() Retrieves the DN of the configuration entry for this location.
java.lang.String	getName() Retrieves the name assigned to this location.
java.util.List<Location>	getPreferredFailoverLocations() Retrieves an ordered list of the preferred failover locations for this location.

Method Detail

getName

java.lang.String getName()

Retrieves the name assigned to this location.

Returns:

The name assigned to this location.

getConfigEntryDN

java.lang.String getConfigEntryDN()

Retrieves the DN of the configuration entry for this location.

Returns:

The DN of the configuration entry for this location.

getPreferredFailoverLocations

java.util.List<Location> getPreferredFailoverLocations()

Retrieves an ordered list of the preferred failover locations for this location.

Returns:

An ordered list of the preferred failover locations for this location.