com.dnsimple.endpoints.http

Class RegistrarEndpoint

java.lang.Object

com.dnsimple.endpoints.http.RegistrarEndpoint

All Implemented Interfaces:

Registrar

public class RegistrarEndpoint
extends Object
implements Registrar

Constructor Summary

Constructors

Constructor and Description
RegistrarEndpoint(HttpEndpointClient client)

Method Summary

Modifier and Type	Method and Description
ChangeDomainDelegationResponse	changeDomainDelegation(String accountId, String domainId, List<String> nameServerNames) Change name servers the domain is delegating to.
ChangeDomainDelegationFromVanityResponse	changeDomainDelegationFromVanity(String accountId, String domainId) Change the domain delegation back to the standard DNSimple name servers.
ChangeDomainDelegationToVanityResponse	changeDomainDelegationToVanity(String accountId, String domainId, List<String> nameServerNames) Change the domain delegation to the specified vanity name servers.
CheckDomainResponse	checkDomain(String accountId, String domainName) Checks whether a domain is available for registration.
DisableAutoRenewalResponse	disableAutoRenewal(String accountId, String domainId) Disable auto renewal for the domain in the account.
DisableWhoisPrivacyResponse	disableWhoisPrivacy(String accountId, String domainId) Disable whois privacy for the domain.
EnableAutoRenewalResponse	enableAutoRenewal(String accountId, String domainId) Enable auto renewal for the domain in the account.
EnableWhoisPrivacyResponse	enableWhoisPrivacy(String accountId, String domainId) Enable whois privacy for the domain.
GetDomainDelegationResponse	getDomainDelegation(String accountId, String domainId) Lists name servers the domain is delegating to.
GetWhoisPrivacyResponse	getWhoisPrivacy(String accountId, String domainId) Gets the whois privacy for the domain.
RegisterDomainResponse	registerDomain(String accountId, String domainName, Map<String,Object> attributes) Registers a domain.
RenewDomainResponse	renewDomain(String accountId, String domainId, Map<String,Object> attributes) Renews a domain.
TransferDomainResponse	transferDomain(String accountId, String domainId, Map<String,Object> attributes) Starts the transfer of a domain to DNSimple.
TransferDomainOutResponse	transferDomainOut(String accountId, String domainId) Requests the transfer of a domain out of DNSimple.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrarEndpoint

public RegistrarEndpoint(HttpEndpointClient client)

Method Detail

checkDomain

public CheckDomainResponse checkDomain(String accountId,
                                       String domainName)
                                throws DnsimpleException,
                                       IOException

Description copied from interface: Registrar

Checks whether a domain is available for registration.

Specified by:

checkDomain in interface Registrar

Parameters:

accountId - The account ID

domainName - The domain to check

Returns:

The check domain response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/#check

registerDomain

public RegisterDomainResponse registerDomain(String accountId,
                                             String domainName,
                                             Map<String,Object> attributes)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Registrar

Registers a domain.

Specified by:

registerDomain in interface Registrar

Parameters:

accountId - The account ID

domainName - The domain to register

attributes - Attributes to use for the registration

Returns:

The register domain response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/#register

renewDomain

public RenewDomainResponse renewDomain(String accountId,
                                       String domainId,
                                       Map<String,Object> attributes)
                                throws DnsimpleException,
                                       IOException

Description copied from interface: Registrar

Renews a domain.

Specified by:

renewDomain in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

attributes - Attributes to use for the renewal

Returns:

The renew domain response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/#renew

transferDomain

public TransferDomainResponse transferDomain(String accountId,
                                             String domainId,
                                             Map<String,Object> attributes)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Registrar

Starts the transfer of a domain to DNSimple.

Specified by:

transferDomain in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

attributes - Attributes to use for the transfer

Returns:

The transfer domain response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/#transfer

transferDomainOut

public TransferDomainOutResponse transferDomainOut(String accountId,
                                                   String domainId)
                                            throws DnsimpleException,
                                                   IOException

Description copied from interface: Registrar

Requests the transfer of a domain out of DNSimple.

Specified by:

transferDomainOut in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The transfer domain out response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/#transfer-out

enableAutoRenewal

public EnableAutoRenewalResponse enableAutoRenewal(String accountId,
                                                   String domainId)
                                            throws DnsimpleException,
                                                   IOException

Description copied from interface: Registrar

Enable auto renewal for the domain in the account.

Specified by:

enableAutoRenewal in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The enable auto renewal response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/auto-renewal/#enable

disableAutoRenewal

public DisableAutoRenewalResponse disableAutoRenewal(String accountId,
                                                     String domainId)
                                              throws DnsimpleException,
                                                     IOException

Description copied from interface: Registrar

Disable auto renewal for the domain in the account.

Specified by:

disableAutoRenewal in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The disable auto renewal response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/auto-renewal/#disable

getWhoisPrivacy

public GetWhoisPrivacyResponse getWhoisPrivacy(String accountId,
                                               String domainId)
                                        throws DnsimpleException,
                                               IOException

Description copied from interface: Registrar

Gets the whois privacy for the domain.

Specified by:

getWhoisPrivacy in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The get whois privacy response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/whois-privacy/#get

enableWhoisPrivacy

public EnableWhoisPrivacyResponse enableWhoisPrivacy(String accountId,
                                                     String domainId)
                                              throws DnsimpleException,
                                                     IOException

Description copied from interface: Registrar

Enable whois privacy for the domain.

Specified by:

enableWhoisPrivacy in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The enable whois privacy response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/whois-privacy/#enable

disableWhoisPrivacy

public DisableWhoisPrivacyResponse disableWhoisPrivacy(String accountId,
                                                       String domainId)
                                                throws DnsimpleException,
                                                       IOException

Description copied from interface: Registrar

Disable whois privacy for the domain.

Specified by:

disableWhoisPrivacy in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The disable whois privacy response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/whois-privacy/#disable

getDomainDelegation

public GetDomainDelegationResponse getDomainDelegation(String accountId,
                                                       String domainId)
                                                throws DnsimpleException,
                                                       IOException

Description copied from interface: Registrar

Lists name servers the domain is delegating to.

Specified by:

getDomainDelegation in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The get domain delegation response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/delegation/#list

changeDomainDelegation

public ChangeDomainDelegationResponse changeDomainDelegation(String accountId,
                                                             String domainId,
                                                             List<String> nameServerNames)
                                                      throws DnsimpleException,
                                                             IOException

Description copied from interface: Registrar

Change name servers the domain is delegating to.

Specified by:

changeDomainDelegation in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain ID

nameServerNames - The name server names to change the delegation to

Returns:

The change domain delegation response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/delegation/#update

changeDomainDelegationToVanity

public ChangeDomainDelegationToVanityResponse changeDomainDelegationToVanity(String accountId,
                                                                             String domainId,
                                                                             List<String> nameServerNames)
                                                                      throws DnsimpleException,
                                                                             IOException

Description copied from interface: Registrar

Change the domain delegation to the specified vanity name servers.

Specified by:

changeDomainDelegationToVanity in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain ID

nameServerNames - The vanity name server names

Returns:

The change domain delegation to vanity response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/delegation/#delegateToVanity

changeDomainDelegationFromVanity

public ChangeDomainDelegationFromVanityResponse changeDomainDelegationFromVanity(String accountId,
                                                                                 String domainId)
                                                                          throws DnsimpleException,
                                                                                 IOException

Description copied from interface: Registrar

Change the domain delegation back to the standard DNSimple name servers.

Specified by:

changeDomainDelegationFromVanity in interface Registrar

Parameters:

accountId - The account ID

domainId - The domain ID

Returns:

The change domain delegation from vanity response

Throws:

DnsimpleException - Any API error

IOException - Any IO error

See Also:

https://developer.dnsimple.com/v2/registrar/delegation/#delegateFromVanity