Class LdapDnsProviderResult

java.lang.Object

javax.naming.ldap.spi.LdapDnsProviderResult

public final class LdapDnsProviderResult
extends Object

The result of a DNS lookup for an LDAP URL.

This class is used by an LdapDnsProvider to return the result of a DNS lookup for a given LDAP URL. The result consists of a domain name and its associated LDAP server endpoints.

A null domainName is equivalent to and represented by an empty string.

Since:

12

Constructor Summary

Constructors

Constructor	Description
LdapDnsProviderResult(String domainName, List<String> endpoints)	Construct an LdapDnsProviderResult consisting of a resolved domain name and the LDAP server endpoints that serve the domain.

Method Summary

Modifier and Type	Method	Description
String	getDomainName()	Returns the domain name resolved from the LDAP URL.
List<String>	getEndpoints()	Returns the possibly empty list of individual server endpoints resolved from the LDAP URL.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

LdapDnsProviderResult

public LdapDnsProviderResult(String domainName,
 List<String> endpoints)

Construct an LdapDnsProviderResult consisting of a resolved domain name and the LDAP server endpoints that serve the domain.

Parameters:

domainName - the resolved domain name; can be null.

endpoints - the possibly empty list of resolved LDAP server endpoints

Throws:

NullPointerException - if endpoints contains null elements.

ClassCastException - if endpoints contains non- String elements.

Method Details

getDomainName

public String getDomainName()

Returns the domain name resolved from the LDAP URL. This method returns the empty string if the LdapDnsProviderResult is created with a null domain name.

Returns:

the resolved domain name

getEndpoints

public List<String> getEndpoints()

Returns the possibly empty list of individual server endpoints resolved from the LDAP URL.

Returns:

a possibly empty unmodifiable List containing the resolved LDAP server endpoints