DomainsEndpoint (dnsimple-java 0.2.0 API)

java.lang.Object
- com.dnsimple.endpoints.http.DomainsEndpoint

All Implemented Interfaces:

Domains
```
public class DomainsEndpoint
extends Object
implements Domains
```
Provides access to the DNSimple Domains API.

See Also:

https://developer.dnsimple.com/v2/domains

Constructor Summary

Constructors
Constructor and Description

DomainsEndpoint(HttpEndpointClient client)

Constructors
Constructor and Description
`DomainsEndpoint(HttpEndpointClient client)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceptPushResponse`	`acceptPush(String accountId, String pushId, Map<String,Object> attributes)` Accept a push.
`CreateDelegationSignerRecordResponse`	`createDelegationSignerRecord(String accountId, String domainId, Map<String,Object> attributes)` Create a delegation signer record for a domain.
`CreateDomainResponse`	`createDomain(String accountId, Map<String,Object> attributes)` Create a domain in an account.
`CreateEmailForwardResponse`	`createEmailForward(String accountId, String domainId, Map<String,Object> attributes)` Create an email forward for a domain.
`DeleteDelegationSignerRecordResponse`	`deleteDelegationSignerRecord(String accountId, String domainId, String dsRecordId)` Delete a delegation signer record from a domain.
`DeleteDomainResponse`	`deleteDomain(String accountId, String domainId)` Delete a domain from an account.
`DeleteEmailForwardResponse`	`deleteEmailForward(String accountId, String domainId, String emailForwardId)` Delete an email forward from a domain.
`DisableDnssecResponse`	`disableDnssec(String accountId, String domainId)` Disable DNSSEC on the domain.
`EnableDnssecResponse`	`enableDnssec(String accountId, String domainId)` Enables DNSSEC on the domain.
`GetDelegationSignerRecordResponse`	`getDelegationSignerRecord(String accountId, String domainId, String dsRecordId)` Get a delegation signer record for a domain using the delegation signer records's ID.
`GetDnssecResponse`	`getDnssec(String accountId, String domainId)` Get DNSSEC status of the domain.
`GetDomainResponse`	`getDomain(String accountId, String domainId)` Get a specific domain associated to an account using the domain's name or ID.
`GetEmailForwardResponse`	`getEmailForward(String accountId, String domainId, String emailForwardId)` Get a specific email forward associated to a domain using the email forward's ID.
`InitiatePushResponse`	`initiatePush(String accountId, String domainId, Map<String,Object> attributes)` Initiate a push.
`ListDelegationSignerRecordsResponse`	`listDelegationSignerRecords(String accountId, String domainId)` Lists the delegation signer records in the domain.
`ListDelegationSignerRecordsResponse`	`listDelegationSignerRecords(String accountId, String domainId, Map<String,Object> options)` Lists the delegation signer records in the domain.
`ListDomainsResponse`	`listDomains(String accountId)` Lists the domains in the account.
`ListDomainsResponse`	`listDomains(String accountId, Map<String,Object> options)` Lists the domains in the account.
`ListEmailForwardsResponse`	`listEmailForwards(String accountId, String domainId)` List email forwards under a given domain.
`ListEmailForwardsResponse`	`listEmailForwards(String accountId, String domainId, Map<String,Object> options)` List email forwards under a given domain.
`ListPushesResponse`	`listPushes(String accountId, String domainId)` List pushes under a given domain.
`ListPushesResponse`	`listPushes(String accountId, String domainId, Map<String,Object> options)` List pushes under a given domain.
`RejectPushResponse`	`rejectPush(String accountId, String pushId)` Reject a push.
`ResetDomainTokenResponse`	`resetDomainToken(String accountId, String domainId)` Resets the domain token.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomainsEndpoint

public DomainsEndpoint(HttpEndpointClient client)

Method Detail

listDomains
```
public ListDomainsResponse listDomains(String accountId)
                                throws DnsimpleException,
                                       IOException
```
Lists the domains in the account.

Specified by:

listDomains in interface Domains

Parameters:

accountId - The account ID

Returns:

The list domains response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/#list

listDomains
```
public ListDomainsResponse listDomains(String accountId,
                                       Map<String,Object> options)
                                throws DnsimpleException,
                                       IOException
```
Lists the domains in the account.

Specified by:

listDomains in interface Domains

Parameters:

accountId - The account ID

options - A Map of options to pass to the domains API

Returns:

The list domains response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/#list

getDomain
```
public GetDomainResponse getDomain(String accountId,
                                   String domainId)
                            throws DnsimpleException,
                                   IOException
```
Get a specific domain associated to an account using the domain's name or ID.

Specified by:

getDomain in interface Domains

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The get domain response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/#get

createDomain
```
public CreateDomainResponse createDomain(String accountId,
                                         Map<String,Object> attributes)
                                  throws DnsimpleException,
                                         IOException
```
Create a domain in an account.

Specified by:

createDomain in interface Domains

Parameters:

accountId - The account ID

attributes - A Map of attributes for constructing the domain

Returns:

The create domain response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/#create

deleteDomain
```
public DeleteDomainResponse deleteDomain(String accountId,
                                         String domainId)
                                  throws DnsimpleException,
                                         IOException
```
Delete a domain from an account. WARNING: this cannot be undone.

Specified by:

deleteDomain in interface Domains

Parameters:

accountId - The account ID

domainId - The domain ID or name

Returns:

The delete domain response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/#delete

resetDomainToken

public ResetDomainTokenResponse resetDomainToken(String accountId,
                                                 String domainId)
                                          throws DnsimpleException,
                                                 IOException

Resets the domain token.

Specified by:: resetDomainToken in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name
Returns:: The reset token domain response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/#reset-token

enableDnssec

public EnableDnssecResponse enableDnssec(String accountId,
                                         String domainId)
                                  throws DnsimpleException,
                                         IOException

Enables DNSSEC on the domain.

Specified by:: enableDnssec in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name
Returns:: The DNSSEC enable response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#enable

disableDnssec

public DisableDnssecResponse disableDnssec(String accountId,
                                           String domainId)
                                    throws DnsimpleException,
                                           IOException

Disable DNSSEC on the domain.

Specified by:: disableDnssec in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name
Returns:: The DNSSEC disable response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#disable

getDnssec
```
public GetDnssecResponse getDnssec(String accountId,
                                   String domainId)
                            throws DnsimpleException,
                                   IOException
```
Get DNSSEC status of the domain.

Specified by:

getDnssec in interface Domains

Parameters:

accountId - The account ID

domainId - The domain ID or name

Returns:

The get DNSSEC response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/dnssec/#get

listDelegationSignerRecords

public ListDelegationSignerRecordsResponse listDelegationSignerRecords(String accountId,
                                                                       String domainId)
                                                                throws DnsimpleException,
                                                                       IOException

Lists the delegation signer records in the domain.

Specified by:: listDelegationSignerRecords in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name
Returns:: The list delegation signer records response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list

listDelegationSignerRecords

public ListDelegationSignerRecordsResponse listDelegationSignerRecords(String accountId,
                                                                       String domainId,
                                                                       Map<String,Object> options)
                                                                throws DnsimpleException,
                                                                       IOException

Lists the delegation signer records in the domain.

Specified by:: listDelegationSignerRecords in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name; options - A Map of options to send to the API
Returns:: The list delegation signer records response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-list

getDelegationSignerRecord

public GetDelegationSignerRecordResponse getDelegationSignerRecord(String accountId,
                                                                   String domainId,
                                                                   String dsRecordId)
                                                            throws DnsimpleException,
                                                                   IOException

Get a delegation signer record for a domain using the delegation signer records's ID.

Specified by:: getDelegationSignerRecord in interface Domains
Parameters:: accountId - The account ID; domainId - The domain name or ID; dsRecordId - The delegation signer record ID
Returns:: The get delegation signer record response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-get

createDelegationSignerRecord

public CreateDelegationSignerRecordResponse createDelegationSignerRecord(String accountId,
                                                                         String domainId,
                                                                         Map<String,Object> attributes)
                                                                  throws DnsimpleException,
                                                                         IOException

Create a delegation signer record for a domain.

Specified by:: createDelegationSignerRecord in interface Domains
Parameters:: accountId - The account ID; domainId - The domain name or ID; attributes - A Map of attributes for constructing the delegation signer record
Returns:: The create delegation signer record response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-create

deleteDelegationSignerRecord

public DeleteDelegationSignerRecordResponse deleteDelegationSignerRecord(String accountId,
                                                                         String domainId,
                                                                         String dsRecordId)
                                                                  throws DnsimpleException,
                                                                         IOException

Delete a delegation signer record from a domain. WARNING: this cannot be undone.

Specified by:: deleteDelegationSignerRecord in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name; dsRecordId - The delegation signer record ID
Returns:: The delete delegation signer record response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/dnssec/#ds-record-delete

listEmailForwards

public ListEmailForwardsResponse listEmailForwards(String accountId,
                                                   String domainId)
                                            throws DnsimpleException,
                                                   IOException

List email forwards under a given domain.

Specified by:: listEmailForwards in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name
Returns:: The list email forwards response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/email-forwards/#list

listEmailForwards

public ListEmailForwardsResponse listEmailForwards(String accountId,
                                                   String domainId,
                                                   Map<String,Object> options)
                                            throws DnsimpleException,
                                                   IOException

List email forwards under a given domain.

Specified by:: listEmailForwards in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name; options - A Map of options to send to the API
Returns:: The list email forwards response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/email-forwards/#list

getEmailForward

public GetEmailForwardResponse getEmailForward(String accountId,
                                               String domainId,
                                               String emailForwardId)
                                        throws DnsimpleException,
                                               IOException

Get a specific email forward associated to a domain using the email forward's ID.

Specified by:: getEmailForward in interface Domains
Parameters:: accountId - The account ID; domainId - The domain name or ID; emailForwardId - The email forward ID
Returns:: The get email forward response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/email-forwards/#get

createEmailForward

public CreateEmailForwardResponse createEmailForward(String accountId,
                                                     String domainId,
                                                     Map<String,Object> attributes)
                                              throws DnsimpleException,
                                                     IOException

Create an email forward for a domain.

Specified by:: createEmailForward in interface Domains
Parameters:: accountId - The account ID; domainId - The domain name or ID; attributes - A Map of attributes for constructing the email forward
Returns:: The create email forward response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/email-forwards/#create

deleteEmailForward

public DeleteEmailForwardResponse deleteEmailForward(String accountId,
                                                     String domainId,
                                                     String emailForwardId)
                                              throws DnsimpleException,
                                                     IOException

Delete an email forward from a domain. WARNING: this cannot be undone.

Specified by:: deleteEmailForward in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name; emailForwardId - The email forward ID
Returns:: The delete email forward response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/email-forwards/#delete

initiatePush

public InitiatePushResponse initiatePush(String accountId,
                                         String domainId,
                                         Map<String,Object> attributes)
                                  throws DnsimpleException,
                                         IOException

Initiate a push.

Specified by:: initiatePush in interface Domains
Parameters:: accountId - The account ID; domainId - The domain name or ID; attributes - A Map of attributes for constructing the push
Returns:: The initiate push response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/pushes/#initiate

listPushes
```
public ListPushesResponse listPushes(String accountId,
                                     String domainId)
                              throws DnsimpleException,
                                     IOException
```
List pushes under a given domain.

Specified by:

listPushes in interface Domains

Parameters:

accountId - The account ID

domainId - The domain ID or name

Returns:

The list pushes response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/domains/pushes/#list

listPushes

public ListPushesResponse listPushes(String accountId,
                                     String domainId,
                                     Map<String,Object> options)
                              throws DnsimpleException,
                                     IOException

List pushes under a given domain.

Specified by:: listPushes in interface Domains
Parameters:: accountId - The account ID; domainId - The domain ID or name; options - A Map of options to send to the API
Returns:: The list pushes response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/pushes/#list

acceptPush

public AcceptPushResponse acceptPush(String accountId,
                                     String pushId,
                                     Map<String,Object> attributes)
                              throws DnsimpleException,
                                     IOException

Accept a push.

Specified by:: acceptPush in interface Domains
Parameters:: accountId - The account ID; pushId - The push ID; attributes - A Map of attributes required when accepting the push
Returns:: The accept push response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/pushes/#accept

rejectPush

public RejectPushResponse rejectPush(String accountId,
                                     String pushId)
                              throws DnsimpleException,
                                     IOException

Reject a push.

Specified by:: rejectPush in interface Domains
Parameters:: accountId - The account ID; pushId - The push ID
Returns:: The accept push response
Throws:: DnsimpleException - Any API errors; IOException - Any IO errors
See Also:: https://developer.dnsimple.com/v2/domains/pushes/#reject

Class DomainsEndpoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainsEndpoint

Method Detail

listDomains

listDomains

getDomain

createDomain

deleteDomain

resetDomainToken

enableDnssec

disableDnssec

getDnssec

listDelegationSignerRecords

listDelegationSignerRecords

getDelegationSignerRecord

createDelegationSignerRecord

deleteDelegationSignerRecord

listEmailForwards

listEmailForwards

getEmailForward

createEmailForward

deleteEmailForward

initiatePush

listPushes

listPushes

acceptPush

rejectPush