Package codes.thischwa.cf

Class CfDnsClient

java.lang.Object
codes.thischwa.cf.CfDnsClient
public class CfDnsClient extends Object
CfDnsClient is a client interface to interact with Cloudflare DNS service. It allows managing DNS records and zones within the Cloudflare system, including creating, updating, retrieving, and deleting DNS records.

Example: 


 // Create a new CfDnsClient instance
 CfDnsClient client = new CfDnsClient(
     "email@example.com",
     "yourApiKey",
     "yourApiToken"
 );

 // Retrieve a zone
 ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
 System.out.println("Zone ID: " + zone.getId());

 // Retrieve records of a zone
 List records = cfDnsClient.sldListAll(zone, "sld");
 records.forEach(record ->
     System.out.println("Record Type: " + record.getType() + ", Value: " + record.getContent())
 );

  • Constructor Details

    • CfDnsClient

      public CfDnsClient(String authEmail, String authKey, String authToken)
      Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
      Parameters:
      authEmail - The email address associated with the Cloudflare account, used for authentication.
      authKey - The API key of the Cloudflare account, used as part of the authentication process.
      authToken - The API token for accessing specific resources within the Cloudflare account.

    • CfDnsClient

      public CfDnsClient(String baseUrl, String authEmail, String authKey, String authToken)
      Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
      Parameters:
      baseUrl - The base URL of the Cloudflare API to be used for requests.
      authEmail - The email address associated with the Cloudflare account, used for authentication.
      authKey - The API key of the Cloudflare account, used as part of the authentication process.
      authToken - The API token for accessing specific resources within the Cloudflare account.

    • CfDnsClient

      public CfDnsClient(boolean emptyResultThrowsException, String baseUrl, String authEmail, String authKey, String authToken)
      Constructs a new instance of CfDnsClient, which facilitates interactions with the Cloudflare DNS API.
      Parameters:
      emptyResultThrowsException - Specifies if an exception should be thrown when the API response is empty. Default is true.
      baseUrl - The base URL for the Cloudflare API endpoint.
      authEmail - The email associated with the Cloudflare account for authentication.
      authKey - The API key for authenticating the client with Cloudflare services.
      authToken - The authentication token used for authorized access to Cloudflare API.

  • Method Details

    • zoneListAll

      public List<ZoneEntity> zoneListAll() throws CloudflareApiException
      Retrieves a list of all zones from the Cloudflare API.
      Returns:
      A list of ZoneEntity objects representing the zones retrieved from the Cloudflare API.
      Throws:
      CloudflareApiException - If an error occurs during the API request or response handling.

    • zoneListAll

      public List<ZoneEntity> zoneListAll(PagingRequest pagingRequest) throws CloudflareApiException
      Retrieves a list of all DNS zones using the provided paging request parameters.
      Parameters:
      pagingRequest - the pagination request object containing parameters for paging and filtering zone data
      Returns:
      a list of ZoneEntity objects representing the DNS zones retrieved from the API
      Throws:
      CloudflareApiException - if there is an error during the API request or response processing

    • zoneInfo

      public ZoneEntity zoneInfo(String name) throws CloudflareApiException
      Retrieves detailed information about a specific zone by its name.
      Parameters:
      name - The name of the zone to retrieve information for.
      Returns:
      A ZoneEntity object that contains details of the specified zone.
      Throws:
      CloudflareApiException - If an error occurs while making the API request or processing the response.

    • sldListAll

      public List<RecordEntity> sldListAll(ZoneEntity zone, String sld) throws CloudflareApiException
      Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
      Parameters:
      zone - The DNS zone entity for which the SLD records are to be fetched.
      sld - The second-level domain name for which the records are retrieved.
      Returns:
      A list of RecordEntity objects representing the DNS records associated with the provided SLD.
      Throws:
      CloudflareApiException - If an error occurs while interacting with the Cloudflare API.

    • sldListAll

      public List<RecordEntity> sldListAll(ZoneEntity zone, String sld, PagingRequest pagingRequest) throws CloudflareApiException
      Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
      Parameters:
      zone - The DNS zone entity for which the SLD records are to be fetched.
      sld - The second-level domain name for which the records are retrieved.
      pagingRequest - The paging request.
      Returns:
      A list of RecordEntity objects representing the DNS records associated with the provided SLD.
      Throws:
      CloudflareApiException - If an error occurs while interacting with the Cloudflare API.

    • sldInfo

      public RecordEntity sldInfo(ZoneEntity zone, String sld, RecordType type) throws CloudflareApiException
      Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
      Parameters:
      zone - the zone entity that contains information about the DNS zone
      sld - the second-level domain (SLD) for which the record information is requested
      type - the type of DNS record (e.g., A, AAAA, CNAME) being queried
      Returns:
      the record entity containing detailed information about the requested SLD and record type
      Throws:
      CloudflareApiException - if an error occurs during interaction with the Cloudflare API

    • recordCreate

      public RecordEntity recordCreate(ZoneEntity zone, RecordEntity rec) throws CloudflareApiException
      Creates a new DNS record in the specified zone using the Cloudflare API.
      Parameters:
      zone - The zone entity where the record will be created. Contains details such as zone ID.
      rec - The record entity representing the DNS record to be created, including its attributes.
      Returns:
      The created record entity as returned by the Cloudflare API.
      Throws:
      CloudflareApiException - If an error occurs while interacting with the Cloudflare API.

    • recordDelete

      public boolean recordDelete(ZoneEntity zone, RecordEntity rec) throws CloudflareApiException
      Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
      Parameters:
      zone - The zone entity that specifies the zone in which the record exists.
      rec - The record entity that represents the DNS record to be deleted.
      Returns:
      true if the DNS record was successfully deleted; false otherwise.
      Throws:
      CloudflareApiException - if there is an issue during the API communication or the request fails for any reason.

    • recordDelete

      public boolean recordDelete(ZoneEntity zone, String id) throws CloudflareApiException
      Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
      Parameters:
      zone - The zone entity that specifies the zone in which the record exists.
      id - The record entity that represents the DNS record to be deleted.
      Returns:
      true if the DNS record was successfully deleted; false otherwise.
      Throws:
      CloudflareApiException - if there is an issue during the API communication or the request fails for any reason.

    • recordUpdate

      public RecordEntity recordUpdate(ZoneEntity zone, RecordEntity rec) throws CloudflareApiException
      Updates an existing DNS record in a specified Cloudflare zone.
      Parameters:
      zone - the zone entity containing the ID of the target zone
      rec - the record entity containing the ID of the DNS record to be updated and its updated data
      Returns:
      the updated record entity as returned by the Cloudflare API
      Throws:
      CloudflareApiException - if an error occurs while interacting with the Cloudflare API

    • recordDeleteTypeIfExists

      public void recordDeleteTypeIfExists(ZoneEntity zone, String sld, RecordType type) throws CloudflareApiException
      Attempts to delete a DNS record of a specific type for a given zone and second-level domain (SLD), if it exists.
      Parameters:
      zone - The zone in which the DNS record resides. It provides information about the domain.
      sld - The second-level domain (SLD) of the fully qualified domain name (FQDN) for which the record is being deleted.
      type - The type of the DNS record to be deleted (e.g., A, CNAME, TXT).
      Throws:
      CloudflareApiException - If an error occurs while interacting with the Cloudflare API.