| java.lang.Object
 org.xbill.DNS.Lookup
| Lookup | | final public class Lookup (Code) | | The Lookup object issues queries to caching DNS servers. The input consists
of a name, an optional type, and an optional class. Caching is enabled
by default and used when possible to reduce the number of DNS requests.
A Resolver, which defaults to an ExtendedResolver initialized with the
resolvers located by the ResolverConfig class, performs the queries. A
search path of domain suffixes is used to resolve relative names, and is
also determined by the ResolverConfig class.
A Lookup object may be reused, but should not be used by multiple threads.
See Also: Cache
See Also: Resolver
See Also: ResolverConfig
author:
Brian Wellington |
| Field Summary | |
| final public static int | HOST_NOT_FOUND
The host does not exist. | | final public static int | SUCCESSFUL
The lookup was successful. | | final public static int | TRY_AGAIN
The lookup failed due to a network error. | | final public static int | TYPE_NOT_FOUND
The host exists, but has no records associated with the queried type. | | final public static int | UNRECOVERABLE
The lookup failed due to a data or server error. |
| Constructor Summary | |
| public | Lookup(Name name, int type, int dclass)
Create a Lookup object that will find records of the given name, type,
and class. | | public | Lookup(Name name, int type)
Create a Lookup object that will find records of the given name and type
in the IN class. | | public | Lookup(Name name)
Create a Lookup object that will find records of type A at the given name
in the IN class. | | public | Lookup(String name, int type, int dclass)
Create a Lookup object that will find records of the given name, type,
and class. | | public | Lookup(String name, int type)
Create a Lookup object that will find records of the given name and type
in the IN class. | | public | Lookup(String name)
Create a Lookup object that will find records of type A at the given name
in the IN class. |
| Method Summary | |
| public Name[] | getAliases()
Returns all known aliases for this name. | | public Record[] | getAnswers()
Returns the answers from the lookup. | | public static synchronized Cache | getDefaultCache(int dclass)
Gets the Cache that will be used as the default for the specified
class by future Lookups.
Parameters:
dclass - The class whose cache is being retrieved. | | public static synchronized Resolver | getDefaultResolver()
Gets the Resolver that will be used as the default by future Lookups. | | public static synchronized Name[] | getDefaultSearchPath()
Gets the search path that will be used as the default by future Lookups. | | public String | getErrorString()
Returns an error string describing the result code of this lookup. | | public int | getResult()
Returns the result code of the lookup. | | public static synchronized void | refreshDefault()
| | public Record[] | run()
Performs the lookup, using the specified Cache, Resolver, and search path. | | public void | setCache(Cache cache)
Sets the cache to use when performing this lookup. | | public void | setCredibility(int credibility)
Sets the minimum credibility level that will be accepted when performing
the lookup. | | public static synchronized void | setDefaultCache(Cache cache, int dclass)
Sets the Cache to be used as the default for the specified class by future
Lookups. | | public static synchronized void | setDefaultResolver(Resolver resolver)
Sets the default Resolver to be used as the default by future Lookups. | | public static synchronized void | setDefaultSearchPath(Name[] domains)
Sets the search path to be used as the default by future Lookups. | | public static synchronized void | setDefaultSearchPath(String[] domains)
Sets the search path that will be used as the default by future Lookups. | | public void | setResolver(Resolver resolver)
Sets the resolver to use when performing this lookup. | | public void | setSearchPath(Name[] domains)
Sets the search path to use when performing this lookup. | | public void | setSearchPath(String[] domains)
Sets the search path to use when performing this lookup. |
| HOST_NOT_FOUND | | final public static int HOST_NOT_FOUND(Code) | | The host does not exist.
|
| SUCCESSFUL | | final public static int SUCCESSFUL(Code) | | The lookup was successful.
|
| TRY_AGAIN | | final public static int TRY_AGAIN(Code) | | The lookup failed due to a network error. Repeating the lookup may be
helpful.
|
| TYPE_NOT_FOUND | | final public static int TYPE_NOT_FOUND(Code) | | The host exists, but has no records associated with the queried type.
|
| UNRECOVERABLE | | final public static int UNRECOVERABLE(Code) | | The lookup failed due to a data or server error. Repeating the lookup
would not be helpful.
|
| Lookup | | public Lookup(Name name, int type, int dclass)(Code) | | Create a Lookup object that will find records of the given name, type,
and class. The lookup will use the default cache, resolver, and search
path, and look for records that are reasonably credible.
Parameters:
name - The name of the desired records
Parameters:
type - The type of the desired records
Parameters:
dclass - The class of the desired records
throws:
IllegalArgumentException - The type is a meta type other than ANY.
See Also: Cache
See Also: Resolver
See Also: Credibility
See Also: Name
See Also: Type
See Also: DClass |
| Lookup | | public Lookup(Name name, int type)(Code) | | Create a Lookup object that will find records of the given name and type
in the IN class.
Parameters:
name - The name of the desired records
Parameters:
type - The type of the desired records
throws:
IllegalArgumentException - The type is a meta type other than ANY.
See Also: Lookup.Lookup(Name,int,int) |
| Lookup | | public Lookup(Name name)(Code) | | Create a Lookup object that will find records of type A at the given name
in the IN class.
Parameters:
name - The name of the desired records
See Also: Lookup.Lookup(Name,int,int) |
| getAliases | | public Name[] getAliases()(Code) | | Returns all known aliases for this name. Whenever a CNAME/DNAME is
followed, an alias is added to this array. The last element in this
array will be the owner name for records in the answer, if there are any.
The aliases.
throws:
IllegalStateException - The lookup has not completed. |
| getAnswers | | public Record[] getAnswers()(Code) | | Returns the answers from the lookup.
The answers, or null if none are found.
throws:
IllegalStateException - The lookup has not completed. |
| getDefaultCache | | public static synchronized Cache getDefaultCache(int dclass)(Code) | | Gets the Cache that will be used as the default for the specified
class by future Lookups.
Parameters:
dclass - The class whose cache is being retrieved. The default cache for the specified class. |
| getDefaultResolver | | public static synchronized Resolver getDefaultResolver()(Code) | | Gets the Resolver that will be used as the default by future Lookups.
The default resolver. |
| getDefaultSearchPath | | public static synchronized Name[] getDefaultSearchPath()(Code) | | Gets the search path that will be used as the default by future Lookups.
The default search path. |
| getErrorString | | public String getErrorString()(Code) | | Returns an error string describing the result code of this lookup.
A string, which may either directly correspond the result codeor be more specific.
throws:
IllegalStateException - The lookup has not completed. |
| getResult | | public int getResult()(Code) | | Returns the result code of the lookup.
The result code, which can be SUCCESSFUL, UNRECOVERABLE, TRY_AGAIN,HOST_NOT_FOUND, or TYPE_NOT_FOUND.
throws:
IllegalStateException - The lookup has not completed. |
| refreshDefault | | public static synchronized void refreshDefault()(Code) | | |
| run | | public Record[] run()(Code) | | Performs the lookup, using the specified Cache, Resolver, and search path.
The answers, or null if none are found. |
| setCache | | public void setCache(Cache cache)(Code) | | Sets the cache to use when performing this lookup. This overrides the
default value. If the results of this lookup should not be permanently
cached, null can be provided here.
Parameters:
cache - The cache to use. |
| setCredibility | | public void setCredibility(int credibility)(Code) | | Sets the minimum credibility level that will be accepted when performing
the lookup. This defaults to Credibility.NORMAL.
Parameters:
credibility - The minimum credibility level. |
| setDefaultCache | | public static synchronized void setDefaultCache(Cache cache, int dclass)(Code) | | Sets the Cache to be used as the default for the specified class by future
Lookups.
Parameters:
cache - The default cache for the specified class.
Parameters:
dclass - The class whose cache is being set. |
| setDefaultResolver | | public static synchronized void setDefaultResolver(Resolver resolver)(Code) | | Sets the default Resolver to be used as the default by future Lookups.
Parameters:
resolver - The default resolver. |
| setDefaultSearchPath | | public static synchronized void setDefaultSearchPath(Name[] domains)(Code) | | Sets the search path to be used as the default by future Lookups.
Parameters:
domains - The default search path. |
| setDefaultSearchPath | | public static synchronized void setDefaultSearchPath(String[] domains) throws TextParseException(Code) | | Sets the search path that will be used as the default by future Lookups.
Parameters:
domains - The default search path.
throws:
TextParseException - A name in the array is not a valid DNS name. |
| setResolver | | public void setResolver(Resolver resolver)(Code) | | Sets the resolver to use when performing this lookup. This overrides the
default value.
Parameters:
resolver - The resolver to use. |
| setSearchPath | | public void setSearchPath(Name[] domains)(Code) | | Sets the search path to use when performing this lookup. This overrides the
default value.
Parameters:
domains - An array of names containing the search path. |
| setSearchPath | | public void setSearchPath(String[] domains) throws TextParseException(Code) | | Sets the search path to use when performing this lookup. This overrides the
default value.
Parameters:
domains - An array of names containing the search path.
throws:
TextParseException - A name in the array is not a valid DNS name. |
|
|