Package io.rdapapi.client

Class RdapClient

java.lang.Object

io.rdapapi.client.RdapClient

All Implemented Interfaces:

AutoCloseable

public final class RdapClient
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
RdapClient(String apiKey)
RdapClient(String apiKey, RdapClientOptions options)

Method Summary

Modifier and Type	Method	Description
AsnResponse	asn(int number)
AsnResponse	asn(String number)
BulkDomainResponse	bulkDomains(List<String> domains)
BulkDomainResponse	bulkDomains(List<String> domains, DomainOptions options)
void	close()
DomainResponse	domain(String name)
DomainResponse	domain(String name, DomainOptions options)
EntityResponse	entity(String handle)
IpResponse	ip(String address)
NameserverResponse	nameserver(String host)
PingResponse	ping()	Liveness probe for uptime monitoring.
TldResponse	tld(String tld)
TldResponse	tld(String tld, TldOptions options)	Return catalog metadata for a single TLD.
TldListResponse	tlds()
TldListResponse	tlds(TldsOptions options)	List every TLD the API can resolve, over RDAP or the WHOIS fallback.

Methods inherited from class java.lang.Object

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

Constructor Details

RdapClient

public RdapClient(String apiKey)

RdapClient

public RdapClient(String apiKey,
 RdapClientOptions options)

Method Details

domain

public DomainResponse domain(String name)
                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

domain

public DomainResponse domain(String name,
 DomainOptions options)
                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

ping

public PingResponse ping()
                  throws IOException,
InterruptedException

Liveness probe for uptime monitoring.

Sent with your API key like every other call, but makes no upstream RDAP call and never counts against your quota.

Throws:

IOException

InterruptedException

ip

public IpResponse ip(String address)
              throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

asn

public AsnResponse asn(int number)
                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

asn

public AsnResponse asn(String number)
                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

nameserver

public NameserverResponse nameserver(String host)
                              throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

entity

public EntityResponse entity(String handle)
                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

tlds

public TldListResponse tlds()
                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

tlds

public TldListResponse tlds(TldsOptions options)
                     throws IOException,
InterruptedException

List every TLD the API can resolve, over RDAP or the WHOIS fallback.

Does not count against the monthly quota. Returns null when TldsOptions.ifNoneMatch(String) is provided and matches the server's current ETag (HTTP 304). Otherwise returns a TldListResponse whose TldListResponse.getEtag() can be passed back on a later call to skip unchanged transfers.

Throws:

IOException

InterruptedException

tld

public TldResponse tld(String tld)
                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

tld

public TldResponse tld(String tld,
 TldOptions options)
                throws IOException,
InterruptedException

Return catalog metadata for a single TLD.

Does not count against the monthly quota. Returns null on HTTP 304. Throws NotFoundException when no RDAP server is registered for the TLD.

Throws:

IOException

InterruptedException

bulkDomains

public BulkDomainResponse bulkDomains(List<String> domains)
                               throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

bulkDomains

public BulkDomainResponse bulkDomains(List<String> domains,
 DomainOptions options)
                               throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

close

public void close()

Specified by:

close in interface AutoCloseable