org.xbill.DNS.lookup

Class LookupSession.LookupSessionBuilder

java.lang.Object

org.xbill.DNS.lookup.LookupSession.LookupSessionBuilder

Enclosing class:

LookupSession

public static class LookupSession.LookupSessionBuilder
extends Object

A builder for LookupSession instances. An instance of this class is obtained by calling LookupSession.builder() and configured using the methods with names corresponding to the different properties. Once fully configured, a LookupSession instance is obtained by calling build() on the builder instance.

Method Summary

Modifier and Type	Method and Description
LookupSession	build() Create an instance of LookupSession configured by this builder.
LookupSession.LookupSessionBuilder	cache(@NonNull Cache cache) Enable caching using the supplied cache.
LookupSession.LookupSessionBuilder	cache(@NonNull Integer dclass, @NonNull Cache cache) Deprecated. use cache(Cache), the Cache already provides the class.
LookupSession.LookupSessionBuilder	caches(@NonNull Collection<Cache> caches) Enable caching using the supplied caches.
LookupSession.LookupSessionBuilder	caches(@NonNull Map<Integer,Cache> caches) Deprecated. use cache(Cache) or caches(Collection), the Cache already provides the class.
LookupSession.LookupSessionBuilder	clearCaches() Disables using a cache for lookups.
LookupSession.LookupSessionBuilder	clearSearchPath() Removes all search paths.
LookupSession.LookupSessionBuilder	cycleResults(boolean cycleResults) If set to true, cached results with multiple records will be returned with the starting point shifted one step per request.
LookupSession.LookupSessionBuilder	defaultHostsFileParser() Enable querying the local hosts database using the system defaults.
LookupSession.LookupSessionBuilder	executor(Executor executor) The executor to use when running lookups.
LookupSession.LookupSessionBuilder	hostsFileParser(HostsFileParser hostsFileParser) Configures the local hosts database file parser to use within this session.
LookupSession.LookupSessionBuilder	maxRedirects(int maxRedirects) The maximum number of CNAME or DNAME redirects allowed before lookups will fail with RedirectOverflowException.
LookupSession.LookupSessionBuilder	ndots(int ndots) The threshold for the number of dots which must appear in a name before it is considered absolute.
LookupSession.LookupSessionBuilder	resolver(@NonNull Resolver resolver) The Resolver to use to look up records.
LookupSession.LookupSessionBuilder	searchPath(Collection<? extends Name> searchPath) Configures the search path used to look up relative names with less than ndots dots.
LookupSession.LookupSessionBuilder	searchPath(Name searchPath) Configures the search path used to look up relative names with less than ndots dots.

Methods inherited from class java.lang.Object

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

Method Detail

resolver

public LookupSession.LookupSessionBuilder resolver(@NonNull
                                                   @NonNull Resolver resolver)

The Resolver to use to look up records.

Returns:

this.

maxRedirects

public LookupSession.LookupSessionBuilder maxRedirects(int maxRedirects)

The maximum number of CNAME or DNAME redirects allowed before lookups will fail with RedirectOverflowException. Defaults to 16.

Returns:

this.

ndots

public LookupSession.LookupSessionBuilder ndots(int ndots)

The threshold for the number of dots which must appear in a name before it is considered absolute. The default is 1, meaning that if there are any dots in a name, the name will be tried first as an absolute name.

Returns:

this.

searchPath

public LookupSession.LookupSessionBuilder searchPath(Name searchPath)

Configures the search path used to look up relative names with less than ndots dots.

Returns:

this.

searchPath

public LookupSession.LookupSessionBuilder searchPath(Collection<? extends Name> searchPath)

Configures the search path used to look up relative names with less than ndots dots.

Returns:

this.

clearSearchPath

public LookupSession.LookupSessionBuilder clearSearchPath()

Removes all search paths.

Returns:

this.

cycleResults

public LookupSession.LookupSessionBuilder cycleResults(boolean cycleResults)

If set to true, cached results with multiple records will be returned with the starting point shifted one step per request.

Returns:

this.

hostsFileParser

public LookupSession.LookupSessionBuilder hostsFileParser(HostsFileParser hostsFileParser)

Configures the local hosts database file parser to use within this session.

Returns:

this.

executor

public LookupSession.LookupSessionBuilder executor(Executor executor)

The executor to use when running lookups.

Returns:

this.

defaultHostsFileParser

public LookupSession.LookupSessionBuilder defaultHostsFileParser()

Enable querying the local hosts database using the system defaults.

Returns:

this.

See Also:

HostsFileParser

cache

public LookupSession.LookupSessionBuilder cache(@NonNull
                                                @NonNull Cache cache)

Enable caching using the supplied cache. An existing Cache for the same class will be replaced.

Returns:

this.

See Also:

Cache

caches

public LookupSession.LookupSessionBuilder caches(@NonNull
                                                 @NonNull Collection<Cache> caches)

Enable caching using the supplied caches. Existing Caches for the same class will be replaced.

Returns:

this.

See Also:

Cache

clearCaches

public LookupSession.LookupSessionBuilder clearCaches()

Disables using a cache for lookups.

Returns:

this.

cache

@Deprecated
public LookupSession.LookupSessionBuilder cache(@NonNull
                                                            @NonNull Integer dclass,
                                                            @NonNull
                                                            @NonNull Cache cache)

Deprecated. use cache(Cache), the Cache already provides the class.

Enable caching using the supplied cache for the given class.

Parameters:

dclass - unused

Returns:

this.

See Also:

Cache

caches

@Deprecated
public LookupSession.LookupSessionBuilder caches(@NonNull
                                                             @NonNull Map<Integer,Cache> caches)

Deprecated. use cache(Cache) or caches(Collection), the Cache already provides the class.

Enable caching using the supplied caches.

Parameters:

caches - unused

Returns:

this.

See Also:

Cache

build

public LookupSession build()

Create an instance of LookupSession configured by this builder.