From 51a96d35836ce2ed4a1d4d2be790198b8627354e Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Wed, 23 Apr 2025 16:29:05 +0200 Subject: [PATCH 1/3] Refactor record creation method to improve clarity Renamed `recordCreate` to `recordCreateSld` to better align with its function of creating records specifically for SLDs. Updated relevant tests, documentation, and method references to use the new naming for consistency and improved readability. --- README.md | 6 +- .../java/codes/thischwa/cf/CfDnsClient.java | 115 ++++++++++-------- .../java/codes/thischwa/cf/CfClientTest.java | 2 +- 3 files changed, 69 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 5299efc..b4557e8 100644 --- a/README.md +++ b/README.md @@ -139,11 +139,11 @@ Create a new DNS record in a specific zone. - **Parameters**: - `ZoneEntity zone` - DNS zone object. - - `RecordEntity rec` - Details of the new record (name, type, content). + - `String sld` - The sub-tld of the new record. + - `int ttl` - The time-to-live in seconds of the new rcord. ```java -RecordEntity newRecord = new RecordEntity("api.example.com", RecordType.A, "192.168.1.1"); -RecordEntity created = cfDnsClient.recordCreate(zone, newRecord); +RecordEntity created = client.recordCreateSld(zone, "api", 60, RecordType.A, "192.168.1.1"); System.out.println("Created Record ID: " + created.getId()); ``` diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java index def9047..a26fc91 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClient.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java @@ -19,19 +19,16 @@ import lombok.extern.slf4j.Slf4j; * records and zones within the Cloudflare system, including creating, updating, retrieving, and * deleting DNS records. * - *

Example: - * + *

Example: *


  * // Create a new CfDnsClient instance
  * CfDnsClient cfDnsClient = new CfDnsClient(
  *     "email@example.com",
  *     "yourApiKey"
  * );
- *
  * // Retrieve a zone
  * ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
  * System.out.println("Zone ID: " + zone.getId());
- *
  * // Retrieve records of a zone
  * List<{@link RecordEntity}> records = cfDnsClient.sldListAll(zone, "sld");
  * records.forEach(record ->
@@ -50,9 +47,9 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
    *
    * @param authEmail The email address associated with the Cloudflare account, used for
-   *     authentication.
-   * @param authKey The API key of the Cloudflare account, used as part of the authentication
-   *     process.
+   *                  authentication.
+   * @param authKey   The API key of the Cloudflare account, used as part of the authentication
+   *                  process.
    */
   public CfDnsClient(String authEmail, String authKey) {
     this(DEFAULT_BASEURL, authEmail, authKey);
@@ -61,11 +58,11 @@ public class CfDnsClient extends CfBasicHttpClient {
   /**
    * Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
    *
-   * @param baseUrl The base URL of the Cloudflare API to be used for requests.
+   * @param baseUrl   The base URL of the Cloudflare API to be used for requests.
    * @param authEmail The email address associated with the Cloudflare account, used for
-   *     authentication.
-   * @param authKey The API key of the Cloudflare account, used as part of the authentication
-   *     process.
+   *                  authentication.
+   * @param authKey   The API key of the Cloudflare account, used as part of the authentication
+   *                  process.
    */
   public CfDnsClient(String baseUrl, String authEmail, String authKey) {
     this(true, baseUrl, authEmail, authKey);
@@ -76,13 +73,15 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Cloudflare DNS API.
    *
    * @param emptyResultThrowsException Specifies if an exception should be thrown when the API
-   *     response is empty. Default is true.
-   * @param baseUrl The base URL for the Cloudflare API endpoint.
-   * @param authEmail The email associated with the Cloudflare account for authentication.
-   * @param authKey The API key for authenticating the client with Cloudflare services.
+   *                                   response is empty. Default is true.
+   * @param baseUrl                    The base URL for the Cloudflare API endpoint.
+   * @param authEmail                  The email associated with the Cloudflare account for
+   *                                   authentication.
+   * @param authKey                    The API key for authenticating the client with Cloudflare
+   *                                   services.
    */
-  public CfDnsClient(
-      boolean emptyResultThrowsException, String baseUrl, String authEmail, String authKey) {
+  public CfDnsClient(boolean emptyResultThrowsException, String baseUrl, String authEmail,
+      String authKey) {
     super(baseUrl, authEmail, authKey);
     this.emptyResultThrowsException = emptyResultThrowsException;
   }
@@ -105,10 +104,10 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Retrieves a list of all DNS zones using the provided paging request parameters.
    *
    * @param pagingRequest the pagination request object containing parameters for paging and
-   *     filtering zone data
+   *                      filtering zone data
    * @return a list of {@code ZoneEntity} objects representing the DNS zones retrieved from the API
    * @throws CloudflareApiException if there is an error during the API request or response
-   *     processing
+   *                                processing
    */
   public List zoneListAll(PagingRequest pagingRequest) throws CloudflareApiException {
     String endpoint = pagingRequest.addQueryString(CfRequest.ZONE_LIST.buildPath());
@@ -123,7 +122,7 @@ public class CfDnsClient extends CfBasicHttpClient {
    * @param name The name of the zone to retrieve information for.
    * @return A {@link ZoneEntity} object that contains details of the specified zone.
    * @throws CloudflareApiException If an error occurs while making the API request or processing
-   *     the response.
+   *                                the response.
    */
   public ZoneEntity zoneInfo(String name) throws CloudflareApiException {
     String endpoint = CfRequest.ZONE_INFO.buildPath(name);
@@ -133,12 +132,12 @@ public class CfDnsClient extends CfBasicHttpClient {
   }
 
   /**
-   * Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+   * Retrieves all record entities for a specific second-level domain (SLD) within a given DNS
+   * zone.
    *
    * @param zone The DNS zone entity for which the SLD records are to be fetched.
-   * @param sld The second-level domain name for which the records are retrieved.
-   * @return A list of {@code RecordEntity} objects representing the DNS records associated with the
-   *     provided SLD.
+   * @param sld  The second-level domain name for which the records are retrieved.
+   * @return A list of {@code RecordEntity} associated with the desired SLD.
    * @throws CloudflareApiException If an error occurs while interacting with the Cloudflare API.
    */
   public List sldListAll(ZoneEntity zone, String sld) throws CloudflareApiException {
@@ -146,13 +145,13 @@ public class CfDnsClient extends CfBasicHttpClient {
   }
 
   /**
-   * Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+   * Retrieves all record entities for a specific second-level domain (SLD) within a given DNS
+   * zone.
    *
-   * @param zone The DNS zone entity for which the SLD records are to be fetched.
-   * @param sld The second-level domain name for which the records are retrieved.
+   * @param zone          The DNS zone entity for which the SLD records are to be fetched.
+   * @param sld           The second-level domain name for which the records are retrieved.
    * @param pagingRequest The paging request.
-   * @return A list of {@code RecordEntity} objects representing the DNS records associated with the
-   *     provided SLD.
+   * @return A list of {@code RecordEntity} associated with the desired SLD.
    * @throws CloudflareApiException If an error occurs while interacting with the Cloudflare API.
    */
   public List sldListAll(ZoneEntity zone, String sld, PagingRequest pagingRequest)
@@ -170,10 +169,9 @@ public class CfDnsClient extends CfBasicHttpClient {
    * zone and record type from the Cloudflare API.
    *
    * @param zone the zone entity that contains information about the DNS zone
-   * @param sld the second-level domain (SLD) for which the record information is requested
+   * @param sld  the second-level domain (SLD) for which the record information is requested
    * @param type the type of DNS record (e.g., A, AAAA, CNAME) being queried
-   * @return the record entity containing detailed information about the requested SLD and record
-   *     type
+   * @return the {@link RecordEntity} of the requested SLD and record type
    * @throws CloudflareApiException if an error occurs during interaction with the Cloudflare API
    */
   public RecordEntity sldInfo(ZoneEntity zone, String sld, RecordType type)
@@ -189,27 +187,44 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Creates a DNS record in the specified DNS zone with the provided details.
    *
    * @param zone    the DNS zone in which the record will be created
-   * @param sld     the second-level domain (SLD) used for constructing the fully qualified domain name (FQDN)
+   * @param sld     the second-level domain (SLD) used for constructing the fully qualified domain
+   *                name (FQDN)
    * @param ttl     the time-to-live (TTL) value for the DNS record
    * @param type    the type of the DNS record (e.g., A, AAAA, CNAME)
    * @param content the content or value of the DNS record
    * @return the created DNS record as a {@link RecordEntity} object
    * @throws CloudflareApiException if an error occurs while interacting with the Cloudflare API
    */
-  public RecordEntity recordCreate(
-      ZoneEntity zone, String sld, int ttl, RecordType type, String content)
-      throws CloudflareApiException {
+  public RecordEntity recordCreateSld(ZoneEntity zone, String sld, int ttl, RecordType type,
+      String content) throws CloudflareApiException {
     String fqdn = buildFqdn(zone, sld);
-    RecordEntity rec = RecordEntity.build(fqdn, type, ttl, content);
+    return recordCreate(zone, fqdn, ttl, type, content);
+  }
+
+  /**
+   * Creates a DNS record in the specified DNS zone with the provided details.
+   *
+   * @param zone    the DNS zone in which the record will be created
+   * @param name    the name of the DNS record (e.g., www.example.com)
+   * @param ttl     the time-to-live (TTL) value for the DNS record
+   * @param type    the type of the DNS record (e.g., A, AAAA, CNAME)
+   * @param content the content or value of the DNS record
+   * @return the created DNS record as a {@link RecordEntity} object
+   * @throws CloudflareApiException if an error occurs while interacting with the Cloudflare API
+   */
+  public RecordEntity recordCreate(ZoneEntity zone, String name, int ttl, RecordType type,
+      String content) throws CloudflareApiException {
+    RecordEntity rec = RecordEntity.build(name, type, ttl, content);
     return recordCreate(zone, rec);
   }
 
   /**
    * Creates a new DNS record in the specified zone using the Cloudflare API.
    *
-   * @param zone The zone entity where the record will be created. Contains details such as zone ID.
-   * @param rec The record entity representing the DNS record to be created, including its
-   *     attributes.
+   * @param zone The zone entity where the record will be created. Contains details such as zone
+   *             ID.
+   * @param rec  The record entity representing the DNS record to be created, including its
+   *             attributes.
    * @return The created record entity as returned by the Cloudflare API.
    * @throws CloudflareApiException If an error occurs while interacting with the Cloudflare API.
    */
@@ -226,10 +241,10 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    *
    * @param zone The zone entity that specifies the zone in which the record exists.
-   * @param rec The record entity that represents the DNS record to be deleted.
+   * @param rec  The record entity that represents the DNS record to be deleted.
    * @return {@code true} if the DNS record was successfully deleted; {@code false} otherwise.
-   * @throws CloudflareApiException if there is an issue during the API communication or the request
-   *     fails for any reason.
+   * @throws CloudflareApiException if there is an issue during the API communication, or the
+   *                                request fails for any reason.
    */
   public boolean recordDelete(ZoneEntity zone, RecordEntity rec) throws CloudflareApiException {
     boolean changed = recordDelete(zone, rec.getId());
@@ -245,10 +260,10 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    *
    * @param zone The zone entity that specifies the zone in which the record exists.
-   * @param id The record entity that represents the DNS record to be deleted.
+   * @param id   The record entity that represents the DNS record to be deleted.
    * @return {@code true} if the DNS record was successfully deleted; {@code false} otherwise.
    * @throws CloudflareApiException if there is an issue during the API communication or the request
-   *     fails for any reason.
+   *                                fails for any reason.
    */
   public boolean recordDelete(ZoneEntity zone, String id) throws CloudflareApiException {
     String endpoint = CfRequest.RECORD_DELETE.buildPath(zone.getId(), id);
@@ -262,8 +277,8 @@ public class CfDnsClient extends CfBasicHttpClient {
    * Updates an existing DNS record in a specified Cloudflare zone.
    *
    * @param zone the zone entity containing the ID of the target zone
-   * @param rec the record entity containing the ID of the DNS record to be updated and its updated
-   *     data
+   * @param rec  the record entity containing the ID of the DNS record to be updated and its updated
+   *             data
    * @return the updated record entity as returned by the Cloudflare API
    * @throws CloudflareApiException if an error occurs while interacting with the Cloudflare API
    */
@@ -280,8 +295,8 @@ public class CfDnsClient extends CfBasicHttpClient {
   }
 
   /**
-   * Deletes DNS records of a specific type within a given zone if they exist.
-   * If no record of the specified type exists, it logs this occurrence without throwing an exception.
+   * Deletes DNS records of a specific type within a given zone if they exist. If no record of the
+   * specified type exists, it logs this occurrence without throwing an exception.
    *
    * @param zone        The DNS zone entity in which the record exists.
    * @param sld         The second-level domain for which the record is being checked.
@@ -311,7 +326,7 @@ public class CfDnsClient extends CfBasicHttpClient {
     ResponseResultInfo resultInfo = resp.getResponseResultInfo();
     if (!resultInfo.isSuccess()) {
       String errors =
-        resultInfo.getErrors().stream().map(Object::toString).collect(Collectors.joining(", "));
+          resultInfo.getErrors().stream().map(Object::toString).collect(Collectors.joining(", "));
       throw new CloudflareApiException("Error in response: " + errors);
     }
 
diff --git a/src/test/java/codes/thischwa/cf/CfClientTest.java b/src/test/java/codes/thischwa/cf/CfClientTest.java
index 04a7072..47b31d8 100644
--- a/src/test/java/codes/thischwa/cf/CfClientTest.java
+++ b/src/test/java/codes/thischwa/cf/CfClientTest.java
@@ -84,7 +84,7 @@ public class CfClientTest {
     r = client.sldInfo(z, SLD_STR, RecordType.A);
     assertEquals("130.0.0.3", r.getContent());
     RecordEntity createdRe2 =
-      client.recordCreate(z, SLD_STR, TTL, RecordType.AAAA, "2a0a:4cc0:c0:2e4::1");
+        client.recordCreateSld(z, SLD_STR, TTL, RecordType.AAAA, "2a0a:4cc0:c0:2e4::1");
     r = client.sldInfo(z, SLD_STR, RecordType.AAAA);
     assertEquals("2a0a:4cc0:c0:2e4::1", r.getContent());
     assertEquals(RecordType.AAAA.getType(), r.getType());

From b3be440320a13be68d89ffbf6b4c46b6faffb003 Mon Sep 17 00:00:00 2001
From: Thilo Schwarz 
Date: Wed, 23 Apr 2025 16:30:40 +0200
Subject: [PATCH 2/3] Regenerate Javadoc files for consistency

The Javadoc files have been regenerated to reflect updates in metadata including timestamps and headers. This ensures the documentation remains consistent with the latest source code revisions.
---
 docs/apidocs/allclasses-index.html            |   4 +-
 docs/apidocs/allpackages-index.html           |   4 +-
 .../codes/thischwa/cf/CfDnsClient.html        | 269 +++++++++++++-----
 docs/apidocs/codes/thischwa/cf/CfRequest.html |   4 +-
 .../thischwa/cf/CloudflareApiException.html   |   4 +-
 .../cf/CloudflareNotFoundException.html       |   4 +-
 .../thischwa/cf/class-use/CfDnsClient.html    |   4 +-
 .../thischwa/cf/class-use/CfRequest.html      |   4 +-
 .../cf/class-use/CloudflareApiException.html  | 146 +++++++---
 .../CloudflareNotFoundException.html          |   4 +-
 .../thischwa/cf/model/AbstractEntity.html     |   4 +-
 .../cf/model/AbstractMultipleResponse.html    |   4 +-
 .../thischwa/cf/model/AbstractResponse.html   |   4 +-
 .../cf/model/AbstractSingleResponse.html      |   4 +-
 .../thischwa/cf/model/PagingRequest.html      |   4 +-
 .../codes/thischwa/cf/model/RecordEntity.html |   4 +-
 .../cf/model/RecordMultipleResponse.html      |   4 +-
 .../cf/model/RecordSingleResponse.html        |   4 +-
 .../codes/thischwa/cf/model/RecordType.html   |   4 +-
 .../thischwa/cf/model/ResponseEntity.html     |   4 +-
 .../thischwa/cf/model/ResponseResultInfo.html |   4 +-
 .../codes/thischwa/cf/model/ResultInfo.html   |   4 +-
 .../codes/thischwa/cf/model/ZoneEntity.html   |   4 +-
 .../cf/model/ZoneMultipleResponse.html        |   4 +-
 .../cf/model/class-use/AbstractEntity.html    |   4 +-
 .../class-use/AbstractMultipleResponse.html   |   4 +-
 .../cf/model/class-use/AbstractResponse.html  |   4 +-
 .../class-use/AbstractSingleResponse.html     |   4 +-
 .../cf/model/class-use/PagingRequest.html     |   8 +-
 .../cf/model/class-use/RecordEntity.html      |  51 +++-
 .../class-use/RecordMultipleResponse.html     |   4 +-
 .../model/class-use/RecordSingleResponse.html |   4 +-
 .../cf/model/class-use/RecordType.html        |  43 ++-
 .../cf/model/class-use/ResponseEntity.html    |   4 +-
 .../model/class-use/ResponseResultInfo.html   |   4 +-
 .../cf/model/class-use/ResultInfo.html        |   4 +-
 .../cf/model/class-use/ZoneEntity.html        | 113 ++++++--
 .../model/class-use/ZoneMultipleResponse.html |   4 +-
 .../thischwa/cf/model/package-summary.html    |   4 +-
 .../codes/thischwa/cf/model/package-tree.html |   4 +-
 .../codes/thischwa/cf/model/package-use.html  |   4 +-
 .../codes/thischwa/cf/package-summary.html    |   4 +-
 .../codes/thischwa/cf/package-tree.html       |   4 +-
 .../codes/thischwa/cf/package-use.html        |   4 +-
 docs/apidocs/help-doc.html                    |   4 +-
 docs/apidocs/index-all.html                   |  20 +-
 docs/apidocs/index.html                       |   4 +-
 docs/apidocs/member-search-index.js           |   5 +
 docs/apidocs/overview-summary.html            |   4 +-
 docs/apidocs/overview-tree.html               |   4 +-
 docs/apidocs/search.html                      |   4 +-
 docs/apidocs/serialized-form.html             |   4 +-
 52 files changed, 591 insertions(+), 240 deletions(-)

diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html
index 3c2f586..1f6cdb1 100644
--- a/docs/apidocs/allclasses-index.html
+++ b/docs/apidocs/allclasses-index.html
@@ -1,11 +1,11 @@
 
 
 
-    
+    
     Alle Klassen und Schnittstellen (CloudflareDNS-java 0.2.0-SNAPSHOT API)
 
 
-    
+    
 
 
 
diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html
index e67c32d..a6402f6 100644
--- a/docs/apidocs/allpackages-index.html
+++ b/docs/apidocs/allpackages-index.html
@@ -1,11 +1,11 @@
 
 
 
-    
+    
     Alle Packages (CloudflareDNS-java 0.2.0-SNAPSHOT API)
 
 
-    
+    
 
 
 
diff --git a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html
index 49da8b4..dd3f6a1 100644
--- a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html
+++ b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html
@@ -1,11 +1,11 @@
 
 
 
-    
+    
     CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API)
 
 
-    
+    
 
 
 
@@ -97,19 +97,16 @@ loadScripts(document, 'script');
  records and zones within the Cloudflare system, including creating, updating, retrieving, and
  deleting DNS records.
 
- 

Example: - +

Example:


  // Create a new CfDnsClient instance
  CfDnsClient cfDnsClient = new CfDnsClient(
      "email@example.com",
      "yourApiKey"
  );
-
  // Retrieve a zone
  ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
  System.out.println("Zone ID: " + zone.getId());
-
  // Retrieve records of a zone
  List<RecordEntity> records = cfDnsClient.sldListAll(zone, "sld");
  records.forEach(record ->
@@ -168,72 +165,148 @@ loadScripts(document, 'script');
 
 
 
recordCreate(ZoneEntity zone, + String name, + int ttl, + RecordType type, + String content)
+
+
Creates a DNS record in the specified DNS zone with the provided details.
+
+ +
+ recordCreateSld + + (ZoneEntity zone, String sld, int ttl, RecordType type, String content)
-
+
Creates a DNS record in the specified DNS zone with the provided details.
-
boolean
-
recordDelete(ZoneEntity zone, +
boolean +
+
+ recordDelete + + (ZoneEntity zone, RecordEntity rec)
-
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
-
boolean
-
recordDelete(ZoneEntity zone, +
+ boolean
+
+ recordDelete + + (ZoneEntity zone, String id)
-
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
-
void
-
recordDeleteTypeIfExists(ZoneEntity zone, +
void +
+
+ recordDeleteTypeIfExists + + (ZoneEntity zone, String sld, RecordType... recordTypes)
-
+
Deletes DNS records of a specific type within a given zone if they exist.
- -
recordUpdate(ZoneEntity zone, + +
+ recordUpdate + + (ZoneEntity zone, RecordEntity rec)
-
+
Updates an existing DNS record in a specified Cloudflare zone.
- -
sldInfo(ZoneEntity zone, + +
+ sldInfo + + (ZoneEntity zone, String sld, RecordType type)
-
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
- -
sldListAll(ZoneEntity zone, + +
+ sldListAll + + (ZoneEntity zone, String sld)
-
-
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
- -
sldListAll(ZoneEntity zone, + +
+ sldListAll + + (ZoneEntity zone, String sld, PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
+
+ +
+ zoneInfo + + (String name)
-
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
Retrieves detailed information about a specific zone by its name.
- - + +
-
Retrieves detailed information about a specific zone by its name.
+
Retrieves a list of all zones from the Cloudflare API.
- +
+ zoneListAll + + (PagingRequest pagingRequest) +
-
Retrieves a list of all zones from the Cloudflare API.
-
- -
zoneListAll(PagingRequest pagingRequest)
-
Retrieves a list of all DNS zones using the provided paging request parameters.
@@ -262,9 +335,11 @@ loadScripts(document, 'script');
Parameter:
authEmail - The email address associated with the Cloudflare account, used for - authentication.
+ authentication. +
authKey - The API key of the Cloudflare account, used as part of the authentication - process.
+ process. +
@@ -279,9 +354,11 @@ loadScripts(document, 'script');
Parameter:
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.
+ authentication. +
authKey - The API key of the Cloudflare account, used as part of the authentication - process.
+ process. + @@ -297,10 +374,15 @@ loadScripts(document, 'script');
Parameter:
emptyResultThrowsException - Specifies if an exception should be thrown when the API - response is empty. Default is true.
+ 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.
+
authEmail - The email associated with the Cloudflare account for + authentication. +
+
authKey - The API key for authenticating the client with Cloudflare + services. +
@@ -335,12 +417,14 @@ loadScripts(document, 'script');
Parameter:
pagingRequest - the pagination request object containing parameters for paging and - filtering zone data
+ filtering zone data +
Gibt zurück:
a list of ZoneEntity objects representing the DNS zones retrieved from the API
Löst aus:
CloudflareApiException - if there is an error during the API request or response - processing
+ processing +
@@ -357,7 +441,8 @@ loadScripts(document, 'script');
A ZoneEntity object that contains details of the specified zone.
Löst aus:
CloudflareApiException - If an error occurs while making the API request or processing - the response.
+ the response. + @@ -367,14 +452,15 @@ loadScripts(document, 'script');
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.
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
Parameter:
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.
Gibt zurück:
-
A list of RecordEntity objects representing the DNS records associated with the - provided SLD.
+
A list of RecordEntity associated with the desired SLD.
Löst aus:
CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
@@ -387,15 +473,16 @@ loadScripts(document, 'script'); String sld, PagingRequest pagingRequest) throws CloudflareApiException
-
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
Parameter:
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.
Gibt zurück:
-
A list of RecordEntity objects representing the DNS records associated with the - provided SLD.
+
A list of RecordEntity associated with the desired SLD.
Löst aus:
CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
@@ -416,18 +503,59 @@ loadScripts(document, 'script');
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
Gibt zurück:
-
the record entity containing detailed information about the requested SLD and record - type
+
the RecordEntity of + the requested SLD and record type +
Löst aus:
CloudflareApiException - if an error occurs during interaction with the Cloudflare API
  • +
    +

    recordCreateSld

    +
    public RecordEntity recordCreateSld + + (ZoneEntity zone, + String sld, + int ttl, + RecordType type, + String content) + throws CloudflareApiException +
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    +
    +
    Parameter:
    +
    zone - the DNS zone in which the record will be created
    +
    sld - the second-level domain (SLD) used for constructing the fully qualified domain + name (FQDN) +
    +
    ttl - the time-to-live (TTL) value for the DNS record
    +
    type - the type of the DNS record (e.g., A, AAAA, CNAME)
    +
    content - the content or value of the DNS record
    +
    Gibt zurück:
    +
    the created DNS record as a RecordEntity + object +
    +
    Löst aus:
    +
    CloudflareApiException - if an error occurs + while interacting with the Cloudflare API +
    +
    +
    +
  • +
  • recordCreate

    public RecordEntity recordCreate(ZoneEntity zone, - String sld, + String name, int ttl, RecordType type, String content) @@ -436,7 +564,7 @@ loadScripts(document, 'script');
    Parameter:
    zone - the DNS zone in which the record will be created
    -
    sld - the second-level domain (SLD) used for constructing the fully qualified domain name (FQDN)
    +
    name - the name of the DNS record (e.g., www.example.com)
    ttl - the time-to-live (TTL) value for the DNS record
    type - the type of the DNS record (e.g., A, AAAA, CNAME)
    content - the content or value of the DNS record
    @@ -456,9 +584,12 @@ loadScripts(document, 'script');
    Creates a new DNS record in the specified zone using the Cloudflare API.
    Parameter:
    -
    zone - The zone entity where the record will be created. Contains details such as zone ID.
    +
    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.
    + attributes. +
    Gibt zurück:
    The created record entity as returned by the Cloudflare API.
    Löst aus:
    @@ -480,8 +611,11 @@ loadScripts(document, 'script');
    Gibt zurück:
    true if the DNS record was successfully deleted; false otherwise.
    Löst aus:
    -
    CloudflareApiException - if there is an issue during the API communication or the request - fails for any reason.
    +
    CloudflareApiException - if there is an issue during the + API communication, or the + request fails for any reason. +
  • @@ -500,7 +634,8 @@ loadScripts(document, 'script');
    true if the DNS record was successfully deleted; false otherwise.
    Löst aus:
    CloudflareApiException - if there is an issue during the API communication or the request - fails for any reason.
    + fails for any reason. + @@ -515,7 +650,8 @@ loadScripts(document, 'script');
    Parameter:
    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
    + data +
    Gibt zurück:
    the updated record entity as returned by the Cloudflare API
    Löst aus:
    @@ -530,8 +666,9 @@ loadScripts(document, 'script'); String sld, RecordType... recordTypes) throws CloudflareApiException
    -
    Deletes DNS records of a specific type within a given zone if they exist. - If no record of the specified type exists, it logs this occurrence without throwing an exception.
    +
    Deletes DNS records of a specific type within a given zone if they exist. If no record of the + specified type exists, it logs this occurrence without throwing an exception. +
    Parameter:
    zone - The DNS zone entity in which the record exists.
    diff --git a/docs/apidocs/codes/thischwa/cf/CfRequest.html b/docs/apidocs/codes/thischwa/cf/CfRequest.html index a1dc6d2..c07ddd8 100644 --- a/docs/apidocs/codes/thischwa/cf/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/CfRequest.html @@ -1,11 +1,11 @@ - + CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html index 7135c21..86e51c8 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html @@ -1,11 +1,11 @@ - + CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html index 2ba0e6c..7187062 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html @@ -1,11 +1,11 @@ - + CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html index 81f1799..9685290 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html index adc3a6c..567e783 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html index 015e6b9..353bf91 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -91,72 +91,150 @@ loadScripts(document, 'script');
    CfDnsClient.recordCreate(ZoneEntity zone, - String sld, + String name, int ttl, RecordType type, String content)
    Creates a DNS record in the specified DNS zone with the provided details.
    -
    boolean
    -
    CfDnsClient.recordDelete(ZoneEntity zone, - RecordEntity rec)
    + +
    CfDnsClient.recordCreateSld + + (ZoneEntity zone, + String sld, + int ttl, + RecordType type, + String content)
    -
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    boolean
    -
    CfDnsClient.recordDelete(ZoneEntity zone, - String id)
    +
    CfDnsClient.recordDelete + + (ZoneEntity zone, + RecordEntity rec) +
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    -
    void
    -
    CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, +
    boolean
    +
    CfDnsClient.recordDelete + + (ZoneEntity zone, + String id)
    +
    +
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    +
    +
    void
    +
    CfDnsClient.recordDeleteTypeIfExists + + (ZoneEntity zone, String sld, RecordType... recordTypes)
    -
    +
    Deletes DNS records of a specific type within a given zone if they exist.
    - -
    CfDnsClient.recordUpdate(ZoneEntity zone, + +
    CfDnsClient.recordUpdate + + (ZoneEntity zone, RecordEntity rec)
    -
    +
    Updates an existing DNS record in a specified Cloudflare zone.
    - -
    CfDnsClient.sldInfo(ZoneEntity zone, + +
    CfDnsClient.sldInfo + + (ZoneEntity zone, String sld, RecordType type)
    -
    +
    Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
    - -
    CfDnsClient.sldListAll(ZoneEntity zone, + +
    CfDnsClient.sldListAll + + (ZoneEntity zone, String sld)
    -
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    - -
    CfDnsClient.sldListAll(ZoneEntity zone, + +
    CfDnsClient.sldListAll + + (ZoneEntity zone, String sld, PagingRequest pagingRequest)
    -
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    -
    - -
    CfDnsClient.zoneInfo(String name)
    -
    Retrieves detailed information about a specific zone by its name.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    - -
    CfDnsClient.zoneListAll()
    + +
    CfDnsClient.zoneInfo + + (String name)
    -
    Retrieves a list of all zones from the Cloudflare API.
    +
    Retrieves detailed information about a specific zone by its name.
    -
    CfDnsClient.zoneListAll(PagingRequest pagingRequest)
    +
    CfDnsClient.zoneListAll()
    +
    Retrieves a list of all zones from the Cloudflare API.
    +
    + +
    CfDnsClient.zoneListAll + + (PagingRequest pagingRequest) +
    +
    Retrieves a list of all DNS zones using the provided paging request parameters.
    diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html index 1a787cd..3baf45a 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html index 3c1093b..1dba14a 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html @@ -1,11 +1,11 @@ - + AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html index 3c6a58d..c7637fa 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html @@ -1,11 +1,11 @@ - + AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html index 6b82c68..8f95c5b 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html @@ -1,11 +1,11 @@ - + AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html index 8e46491..0f2bc7d 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html @@ -1,11 +1,11 @@ - + AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html index 6b3bb8f..d0a4390 100644 --- a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html @@ -1,11 +1,11 @@ - + PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html index ee3e332..d67dfa4 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html @@ -1,11 +1,11 @@ - + RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html index df2aaf9..533bb07 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html @@ -1,11 +1,11 @@ - + RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html index 30a3a95..46cd1e0 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html @@ -1,11 +1,11 @@ - + RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/RecordType.html index b77c00e..83e1955 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordType.html @@ -1,11 +1,11 @@ - + RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html index 585f361..24eb572 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html @@ -1,11 +1,11 @@ - + ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html index aeb4b80..7718cd5 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html @@ -1,11 +1,11 @@ - + ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html index 4b21640..58b41df 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html @@ -1,11 +1,11 @@ - + ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html index a79ddd3..d9db975 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html @@ -1,11 +1,11 @@ - + ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html index 7ee3698..c2bb2fc 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html @@ -1,11 +1,11 @@ - + ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html index 67645fd..80b65b0 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html index 4592f8a..2a2dea0 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html index cea90f6..22a234f 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html index a550cff..43c9c04 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html index 1f28a19..8480efc 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -80,7 +80,9 @@ loadScripts(document, 'script'); String sld, PagingRequest pagingRequest)
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    CfDnsClient.zoneListAll(PagingRequest pagingRequest)
    diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html index 3564b44..af0e1ba 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -83,7 +83,8 @@ loadScripts(document, 'script');
    CfDnsClient.recordCreate(ZoneEntity zone, - String sld, + String name, int ttl, RecordType type, String content)
    @@ -91,16 +92,42 @@ loadScripts(document, 'script');
    Creates a DNS record in the specified DNS zone with the provided details.
    -
    CfDnsClient.recordUpdate(ZoneEntity zone, +
    CfDnsClient.recordCreateSld + + (ZoneEntity zone, + String sld, + int ttl, + RecordType type, + String content)
    +
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    +
    + +
    CfDnsClient.recordUpdate + + (ZoneEntity zone, RecordEntity rec)
    -
    +
    Updates an existing DNS record in a specified Cloudflare zone.
    - -
    CfDnsClient.sldInfo(ZoneEntity zone, + +
    CfDnsClient.sldInfo + + (ZoneEntity zone, String sld, RecordType type)
    -
    +
    Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
    @@ -114,14 +141,18 @@ loadScripts(document, 'script');
    CfDnsClient.sldListAll(ZoneEntity zone, String sld)
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    CfDnsClient.sldListAll(ZoneEntity zone, String sld, PagingRequest pagingRequest)
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    Methoden in codes.thischwa.cf mit Parametern vom Typ RecordEntity
    diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html index d84e98a..e318761 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html index 45ed67c..1a21358 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html index 0b8d6c1..cdb1757 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.model.RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -77,25 +77,50 @@ loadScripts(document, 'script');
    Beschreibung
    CfDnsClient.recordCreate(ZoneEntity zone, + String name, + int ttl, + RecordType type, + String content)
    +
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    +
    + +
    CfDnsClient.recordCreateSld + + (ZoneEntity zone, String sld, int ttl, RecordType type, String content)
    -
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    -
    void
    -
    CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, +
    void
    +
    CfDnsClient.recordDeleteTypeIfExists + + (ZoneEntity zone, String sld, RecordType... recordTypes)
    -
    +
    Deletes DNS records of a specific type within a given zone if they exist.
    - -
    CfDnsClient.sldInfo(ZoneEntity zone, + +
    CfDnsClient.sldInfo + + (ZoneEntity zone, String sld, RecordType type)
    -
    +
    Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
    diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html index 0820e0c..95a4b35 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Schnittstelle codes.thischwa.cf.model.ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html index e21a2a1..a484911 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html index 7e433ae..0beeaba 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html index 2031bf0..2cd7ac6 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -106,58 +106,119 @@ loadScripts(document, 'script');
    CfDnsClient.recordCreate(ZoneEntity zone, - String sld, + String name, int ttl, RecordType type, String content)
    Creates a DNS record in the specified DNS zone with the provided details.
    -
    boolean
    -
    CfDnsClient.recordDelete(ZoneEntity zone, - RecordEntity rec)
    + +
    CfDnsClient.recordCreateSld + + (ZoneEntity zone, + String sld, + int ttl, + RecordType type, + String content)
    -
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    boolean
    -
    CfDnsClient.recordDelete(ZoneEntity zone, +
    CfDnsClient.recordDelete + + (ZoneEntity zone, + RecordEntity rec)
    +
    +
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    +
    +
    boolean
    +
    CfDnsClient.recordDelete + + (ZoneEntity zone, String id)
    -
    +
    Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
    -
    void
    -
    CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, +
    void
    +
    CfDnsClient.recordDeleteTypeIfExists + + (ZoneEntity zone, String sld, RecordType... recordTypes)
    -
    +
    Deletes DNS records of a specific type within a given zone if they exist.
    - -
    CfDnsClient.recordUpdate(ZoneEntity zone, + +
    CfDnsClient.recordUpdate + + (ZoneEntity zone, RecordEntity rec)
    -
    +
    Updates an existing DNS record in a specified Cloudflare zone.
    - -
    CfDnsClient.sldInfo(ZoneEntity zone, + +
    CfDnsClient.sldInfo + + (ZoneEntity zone, String sld, RecordType type)
    -
    +
    Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
    - -
    CfDnsClient.sldListAll(ZoneEntity zone, + +
    CfDnsClient.sldListAll + + (ZoneEntity zone, String sld)
    -
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    - -
    CfDnsClient.sldListAll(ZoneEntity zone, + +
    CfDnsClient.sldListAll + + (ZoneEntity zone, String sld, PagingRequest pagingRequest)
    -
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html index 33de06e..e8b999d 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html @@ -1,12 +1,12 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-summary.html b/docs/apidocs/codes/thischwa/cf/model/package-summary.html index 927762b..83f054f 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-summary.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-tree.html b/docs/apidocs/codes/thischwa/cf/model/package-tree.html index 5191e21..1ea37a8 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-tree.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf.model Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-use.html b/docs/apidocs/codes/thischwa/cf/model/package-use.html index f3e5f4b..1b70834 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-use.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Package codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-summary.html b/docs/apidocs/codes/thischwa/cf/package-summary.html index fb0f33a..02b32f7 100644 --- a/docs/apidocs/codes/thischwa/cf/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/package-summary.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-tree.html b/docs/apidocs/codes/thischwa/cf/package-tree.html index 78e954f..84c3380 100644 --- a/docs/apidocs/codes/thischwa/cf/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/package-tree.html @@ -1,11 +1,11 @@ - + codes.thischwa.cf Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/codes/thischwa/cf/package-use.html b/docs/apidocs/codes/thischwa/cf/package-use.html index 74a06c7..d767f6e 100644 --- a/docs/apidocs/codes/thischwa/cf/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/package-use.html @@ -1,11 +1,11 @@ - + Verwendungsweise von Package codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html index 6f01876..532dc58 100644 --- a/docs/apidocs/help-doc.html +++ b/docs/apidocs/help-doc.html @@ -1,11 +1,11 @@ - + API-Hilfe (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html index ba97efc..7042e8e 100644 --- a/docs/apidocs/index-all.html +++ b/docs/apidocs/index-all.html @@ -1,11 +1,11 @@ - + Index (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + @@ -287,6 +287,14 @@ loadScripts(document, 'script');
    Creates a new DNS record in the specified zone using the Cloudflare API.
    recordCreate(ZoneEntity, String, int, RecordType, String) - Methode in Klasse codes.thischwa.cf.CfDnsClient
    +
    +
    Creates a DNS record in the specified DNS zone with the provided details.
    +
    +
    + recordCreateSld(ZoneEntity, String, int, RecordType, String) - Methode in Klasse + codes.thischwa.cf.CfDnsClient
    Creates a DNS record in the specified DNS zone with the provided details.
    @@ -369,11 +377,15 @@ loadScripts(document, 'script');
    sldListAll(ZoneEntity, String) - Methode in Klasse codes.thischwa.cf.CfDnsClient
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    sldListAll(ZoneEntity, String, PagingRequest) - Methode in Klasse codes.thischwa.cf.CfDnsClient
    -
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
    +
    Retrieves all record entities for a specific second-level domain (SLD) within a given DNS + zone. +
    SMIMEA - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
    diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html index 10dd631..485a505 100644 --- a/docs/apidocs/index.html +++ b/docs/apidocs/index.html @@ -1,11 +1,11 @@ - + Überblick (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/member-search-index.js b/docs/apidocs/member-search-index.js index fc36f28..ec299c7 100644 --- a/docs/apidocs/member-search-index.js +++ b/docs/apidocs/member-search-index.js @@ -123,6 +123,11 @@ memberSearchIndex = [{"p": "codes.thischwa.cf.model", "c": "RecordType", "l": "A "c": "CfDnsClient", "l": "recordCreate(ZoneEntity, String, int, RecordType, String)", "u": "recordCreate(codes.thischwa.cf.model.ZoneEntity,java.lang.String,int,codes.thischwa.cf.model.RecordType,java.lang.String)" +}, { + "p": "codes.thischwa.cf", + "c": "CfDnsClient", + "l": "recordCreateSld(ZoneEntity, String, int, RecordType, String)", + "u": "recordCreateSld(codes.thischwa.cf.model.ZoneEntity,java.lang.String,int,codes.thischwa.cf.model.RecordType,java.lang.String)" }, { "p": "codes.thischwa.cf", "c": "CfDnsClient", diff --git a/docs/apidocs/overview-summary.html b/docs/apidocs/overview-summary.html index 0437715..f9977f2 100644 --- a/docs/apidocs/overview-summary.html +++ b/docs/apidocs/overview-summary.html @@ -1,11 +1,11 @@ - + CloudflareDNS-java 0.2.0-SNAPSHOT API - + diff --git a/docs/apidocs/overview-tree.html b/docs/apidocs/overview-tree.html index 4aaa0a7..dc0ff8a 100644 --- a/docs/apidocs/overview-tree.html +++ b/docs/apidocs/overview-tree.html @@ -1,11 +1,11 @@ - + Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/search.html b/docs/apidocs/search.html index bb64c42..81bb8cf 100644 --- a/docs/apidocs/search.html +++ b/docs/apidocs/search.html @@ -1,11 +1,11 @@ - + Suchen (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + diff --git a/docs/apidocs/serialized-form.html b/docs/apidocs/serialized-form.html index 060ef49..97d4355 100644 --- a/docs/apidocs/serialized-form.html +++ b/docs/apidocs/serialized-form.html @@ -1,11 +1,11 @@ - + Serialisierte Form (CloudflareDNS-java 0.2.0-SNAPSHOT API) - + From 28ed41e28eb21464fa2a1b156ab81db6cf3491a5 Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Wed, 23 Apr 2025 16:31:24 +0200 Subject: [PATCH 3/3] Regenerate Javadoc files for consistency The Javadoc files have been regenerated to reflect updates in metadata including timestamps and headers. This ensures the documentation remains consistent with the latest source code revisions. --- src/main/java/codes/thischwa/cf/CfDnsClient.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java index a26fc91..35543ba 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClient.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java @@ -19,7 +19,7 @@ import lombok.extern.slf4j.Slf4j; * records and zones within the Cloudflare system, including creating, updating, retrieving, and * deleting DNS records. * - *

    Example: + *

    Example: *

    
      * // Create a new CfDnsClient instance
      * CfDnsClient cfDnsClient = new CfDnsClient(