de.malkusch.whoisApi

Class WhoisApi

java.lang.Object

de.malkusch.whoisApi.WhoisApi

@ThreadSafe
public class WhoisApi
extends Object

A Whois API. This is a client library for the Whois API service. Register there to get an API key. With this API you can check if a domain name is available, get its whois data or query an arbitrary whois server. The service is using this Whois server list. Also it avoids hitting any rate limits on the whois servers.

Example:

 
 WhoisApi whoisApi = new WhoisApi("apiKey);
 System.out.println(whoisApi.isAvailable("example.net") ? "available" : "registered");
 
 

Author:

markus@malkusch.de

See Also:

Whois API

Constructor Summary

Constructors

Constructor and Description
WhoisApi(String apiKey) Builds the Whois API client.
WhoisApi(String apiKey, URI baseUri) Builds the Whois API client.

Method Summary

Modifier and Type	Method and Description
CheckResult	check(String domain) Checks if a domain is available and returns the whois response.
Collection<String>	domains() Returns a list of all top and second level domains, which are known to the Whois API.
boolean	isAvailable(String domain) Checks if a domain is available.
InputStream	query(String host, String query) Queries a whois server.
String	whois(String domain) Returns the whois data for a domain.

Methods inherited from class java.lang.Object

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

Constructor Detail

WhoisApi

public WhoisApi(String apiKey)

Builds the Whois API client. Register at http://whois-api.domaininformation.de/ to get an API key.

Parameters:

apiKey - api key

WhoisApi

public WhoisApi(String apiKey,
                URI baseUri)

Builds the Whois API client. Register at http://whois-api.domaininformation.de/ to get an API key.

Parameters:

apiKey - api key

baseUri - API endpoint

Method Detail

check

public CheckResult check(String domain)
                  throws RecoverableWhoisApiException

Checks if a domain is available and returns the whois response.

Parameters:

domain - domain name, e.g. "example.net"

Returns:

the combined domain check and the whois response

Throws:

WhoisApiException - if the api request caused an error

RecoverableWhoisApiException - if the API failed, but you can try again.

isAvailable

public boolean isAvailable(String domain)
                    throws RecoverableWhoisApiException

Checks if a domain is available. If a domain is available (i.e. not registered) this method will return true

Parameters:

domain - domain name, e.g. "example.net"

Returns:

true if the domain is available, false otherwise.

Throws:

WhoisApiException - if the api request caused an error

RecoverableWhoisApiException - if the API failed, but you can try again.

whois

public String whois(String domain)
             throws RecoverableWhoisApiException

Returns the whois data for a domain.

Parameters:

domain - domain name, e.g. "example.net"

Returns:

whois lookup response

Throws:

WhoisApiException - if the api request caused an error

RecoverableWhoisApiException - if the API failed, but you can try again.

query

public InputStream query(String host,
                         String query)
                  throws RecoverableWhoisApiException

Queries a whois server.

Parameters:

host - hostname of the whois server, e.g. "whois.verisign-grs.com"

query - query, e.g. "example.net"

Returns:

response from the whois server

Throws:

WhoisApiException - if the api request caused an error

RecoverableWhoisApiException - if the API failed, but you can try again.

domains

public Collection<String> domains()
                           throws RecoverableWhoisApiException

Returns a list of all top and second level domains, which are known to the Whois API.

Returns:

all available top and second level domains

Throws:

RecoverableWhoisApiException - if the API failed, but you can try again.