thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity

Simplify README examples by removing unnecessary line breaks, standardizing method chaining, and improving code readability for batch DNS operations and fluent API usage.

Browse Source
This commit is contained in:
Thilo Schwarz
2026-01-06 15:20:12 +01:00
parent edf1752e81
commit 5a6a17798b
1 changed files with 45 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+45 -175
View File
@@ -133,15 +133,9 @@ Retrieve all records for a specific second-level domain (SLD) under a given zone
```java ```java
List<RecordEntity> records = cfDnsClient.recordList(zone, "sld"); List<RecordEntity> records = cfDnsClient.recordList(zone, "sld");
records. records.forEach(record ->
System.out.println("Record Type: "+record.getType()
forEach(record -> +", Value: "+record.getContent())
System.out.
println("Record Type: "+record.getType()
+", Value: "+record.
getContent())
); );
``` ```
@@ -154,35 +148,22 @@ Retrieve DNS record details for a specific SLD and zone, optionally filtered by
- **Parameters**: - **Parameters**:
- `ZoneEntity zone` - The zone object. - `ZoneEntity zone` - The zone object.
- `String sld` - The second-level domain. - `String sld` - The second-level domain.
- `RecordType... types` - Optional record types to filter by (e.g., A, CNAME). If not specified, returns all record - `RecordType... types` - Optional record types to filter by (e.g., A, CNAME). If not specified, returns all record types.
types.
- **Returns**: A list of `RecordEntity` objects matching the criteria. - **Returns**: A list of `RecordEntity` objects matching the criteria.
```java ```java
// Get all records for a specific SLD // Get all records for a specific SLD
List<RecordEntity> allRecords = cfDnsClient.recordGet(zone, "www"); List<RecordEntity> allRecords = cfDnsClient.recordGet(zone, "www");
allRecords. allRecords.forEach(record ->
System.out.println("Type: "+record.getType()+", Content: "+record.getContent()));
forEach(record ->
System.out.
println("Type: "+record.getType()+", Content: "+record.
getContent()));
// Get only A records // Get only A records
List<RecordEntity> aRecords = cfDnsClient.recordGet(zone, "www", RecordType.A); List<RecordEntity> aRecords = cfDnsClient.recordGet(zone, "www", RecordType.A);
System.out. System.out.println("Found "+aRecords.size() +" A records");
println("Found "+aRecords.size() +" A records");
// Get A and AAAA records // Get A and AAAA records
List<RecordEntity> ipRecords = cfDnsClient.recordGet(zone, "www", RecordType.A, RecordType.AAAA); List<RecordEntity> ipRecords = cfDnsClient.recordGet(zone, "www", RecordType.A, RecordType.AAAA);
ipRecords. ipRecords.forEach(record -> System.out.println("IP Record: "+record.getContent()));
forEach(record ->System.out.
println("IP Record: "+record.getContent()));
``` ```
--- ---
@@ -259,8 +240,7 @@ Process multiple DNS record operations (POST, PUT, PATCH, DELETE) in a single ba
- `List<RecordEntity> deleteRecords` - Records to delete (nullable). **Requires record IDs**. - `List<RecordEntity> deleteRecords` - Records to delete (nullable). **Requires record IDs**.
- **Returns**: A `BatchEntry` object containing the processed records. - **Returns**: A `BatchEntry` object containing the processed records.
**Important**: For UPDATE (PATCH), REPLACE (PUT), and DELETE operations, you must first retrieve the existing records to **Important**: For UPDATE (PATCH), REPLACE (PUT), and DELETE operations, you must first retrieve the existing records to obtain their IDs.
obtain their IDs.
#### Batch Create (POST) #### Batch Create (POST)
@@ -273,11 +253,7 @@ List<RecordEntity> newRecords = Arrays.asList(
); );
BatchEntry result = cfDnsClient.recordBatch(zone, newRecords, null, null, null); BatchEntry result = cfDnsClient.recordBatch(zone, newRecords, null, null, null);
System.out. System.out.println("Created "+result.getPosts().size() +" records.");
println("Created "+result.getPosts().
size() +" records.");
``` ```
#### Batch Update (PATCH) #### Batch Update (PATCH)
@@ -287,31 +263,15 @@ Partially update existing records. **Record IDs are required** - fetch them firs
```java ```java
// Step 1: Fetch existing records to get their IDs // Step 1: Fetch existing records to get their IDs
List<RecordEntity> recordsToUpdate = new ArrayList<>(); List<RecordEntity> recordsToUpdate = new ArrayList<>();
recordsToUpdate. recordsToUpdate.add(cfDnsClient.recordGet(zone, "api",RecordType.A).get(0));
recordsToUpdate.add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).get(0));
add(cfDnsClient.recordGet(zone, "api",RecordType.A).
get(0));
recordsToUpdate.
add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).
get(0));
// Step 2: Modify only the fields you want to update // Step 2: Modify only the fields you want to update
recordsToUpdate. recordsToUpdate.forEach(record ->record.setContent("192.168.2.10"));
forEach(record ->record.
setContent("192.168.2.10"));
// Step 3: Send batch update request // Step 3: Send batch update request
BatchEntry result = cfDnsClient.recordBatch(zone, null, null, recordsToUpdate, null); BatchEntry result = cfDnsClient.recordBatch(zone, null, null, recordsToUpdate, null);
System.out. System.out.println("Updated "+result.getPatches().size() +" records.");
println("Updated "+result.getPatches().
size() +" records.");
``` ```
#### Batch Replace (PUT) #### Batch Replace (PUT)
@@ -321,46 +281,18 @@ Fully replace existing records. **Record IDs are required** - fetch them first:
```java ```java
// Step 1: Fetch existing records to get their IDs // Step 1: Fetch existing records to get their IDs
List<RecordEntity> recordsToReplace = new ArrayList<>(); List<RecordEntity> recordsToReplace = new ArrayList<>();
recordsToReplace. recordsToReplace.add(cfDnsClient.recordGet(zone, "mail",RecordType.A).get(0));
recordsToReplace.add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).get(0));
add(cfDnsClient.recordGet(zone, "mail",RecordType.A).
get(0));
recordsToReplace.
add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).
get(0));
// Step 2: Modify all fields as needed (full replacement) // Step 2: Modify all fields as needed (full replacement)
recordsToReplace. recordsToReplace.get(0).setContent("192.168.3.10");
recordsToReplace.get(0).setTtl(120);
get(0). recordsToReplace.get(1).setContent("192.168.3.11");
recordsToReplace.get(1).setTtl(120);
setContent("192.168.3.10");
recordsToReplace.
get(0).
setTtl(120);
recordsToReplace.
get(1).
setContent("192.168.3.11");
recordsToReplace.
get(1).
setTtl(120);
// Step 3: Send batch replace request // Step 3: Send batch replace request
BatchEntry result = cfDnsClient.recordBatch(zone, null, recordsToReplace, null, null); BatchEntry result = cfDnsClient.recordBatch(zone, null, recordsToReplace, null, null);
System.out. System.out.println("Replaced "+result.getPuts().size() +" records.");
println("Replaced "+result.getPuts().
size() +" records.");
``` ```
#### Batch Delete #### Batch Delete
@@ -370,22 +302,12 @@ Delete existing records. **Record IDs are required** - fetch them first:
```java ```java
// Step 1: Fetch existing records to get their IDs // Step 1: Fetch existing records to get their IDs
List<RecordEntity> recordsToDelete = new ArrayList<>(); List<RecordEntity> recordsToDelete = new ArrayList<>();
recordsToDelete. recordsToDelete.add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).get(0));
recordsToDelete.add(cfDnsClient.recordGet(zone, "mail",RecordType.A).get(0));
add(cfDnsClient.recordGet(zone, "cdn",RecordType.A).
get(0));
recordsToDelete.
add(cfDnsClient.recordGet(zone, "mail",RecordType.A).
get(0));
// Step 2: Send batch delete request // Step 2: Send batch delete request
BatchEntry result = cfDnsClient.recordBatch(zone, null, null, null, recordsToDelete); BatchEntry result = cfDnsClient.recordBatch(zone, null, null, null, recordsToDelete);
System.out. System.out.println("Deleted "+recordsToDelete.size() +" records.");
println("Deleted "+recordsToDelete.size() +" records.");
``` ```
#### Combined Batch Operations #### Combined Batch Operations
@@ -402,11 +324,7 @@ List<RecordEntity> newRecords = Arrays.asList(
List<RecordEntity> recordsToUpdate = Arrays.asList( List<RecordEntity> recordsToUpdate = Arrays.asList(
cfDnsClient.recordGet(zone, "existing-api", RecordType.A).get(0) cfDnsClient.recordGet(zone, "existing-api", RecordType.A).get(0)
); );
recordsToUpdate. recordsToUpdate.get(0).setContent("192.168.1.200");
get(0).
setContent("192.168.1.200");
List<RecordEntity> recordsToDelete = Arrays.asList( List<RecordEntity> recordsToDelete = Arrays.asList(
cfDnsClient.recordGet(zone, "old-api", RecordType.A).get(0) cfDnsClient.recordGet(zone, "old-api", RecordType.A).get(0)
@@ -421,24 +339,10 @@ BatchEntry result = cfDnsClient.recordBatch(
recordsToDelete // DELETE - remove records recordsToDelete // DELETE - remove records
); );
System.out. System.out.println("Batch completed:");
System.out.println(" Created: "+result.getPosts().size());
println("Batch completed:"); System.out.println(" Updated: "+result.getPatches().size());
System.out. System.out.println(" Deleted: "+result.getDeletes().size());
println(" Created: "+result.getPosts().
size());
System.out.
println(" Updated: "+result.getPatches().
size());
System.out.
println(" Deleted: "+result.getDeletes().
size());
``` ```
--- ---
@@ -453,12 +357,8 @@ that reduces verbosity and improves code readability.
```java ```java
// Create a DNS record // Create a DNS record
client.zone("example.com") client.zone("example.com")
. .record("api")
.create(RecordType.A, "192.168.1.1",60);
record("api")
.
create(RecordType.A, "192.168.1.1",60);
// Get DNS records // Get DNS records
List<RecordEntity> records = client.zone("example.com") List<RecordEntity> records = client.zone("example.com")
@@ -471,15 +371,9 @@ RecordEntity updated = client.zone("example.com")
.update("192.168.1.2"); .update("192.168.1.2");
// Delete DNS records // Delete DNS records
client. client.zone("example.com")
.record("old-service")
zone("example.com") .delete(RecordType.A, RecordType.AAAA);
.
record("old-service")
.
delete(RecordType.A, RecordType.AAAA);
``` ```
### Advantages of Fluent API ### Advantages of Fluent API
@@ -495,47 +389,25 @@ delete(RecordType.A, RecordType.AAAA);
CfDnsClient client = new CfDnsClient("email@example.com", "yourApiKey"); CfDnsClient client = new CfDnsClient("email@example.com", "yourApiKey");
// Create a new record // Create a new record
client. client.zone("example.com")
.record("api")
zone("example.com") .create(RecordType.A, "192.168.100.1",60);
.
record("api")
.
create(RecordType.A, "192.168.100.1",60);
// Retrieve and verify // Retrieve and verify
List<RecordEntity> records = client.zone("example.com") List<RecordEntity> records = client.zone("example.com")
.record("api", RecordType.A) .record("api", RecordType.A)
.get(); .get();
System.out. System.out.println("IP: "+records.get(0).getContent());
println("IP: "+records.get(0).
getContent());
// Update the record // Update the record
client. client.zone("example.com")
.record("api",RecordType.A)
zone("example.com") .update("192.168.100.2");
.
record("api",RecordType.A)
.
update("192.168.100.2");
// Clean up // Clean up
client. client.zone("example.com")
.record("api")
zone("example.com") .delete(RecordType.A);
.
record("api")
.
delete(RecordType.A);
``` ```
--- ---
@@ -544,9 +416,7 @@ delete(RecordType.A);
The `CfDnsClient` provides internal error-handling mechanisms through exceptions. For example: The `CfDnsClient` provides internal error-handling mechanisms through exceptions. For example:
- `CloudflareApiException` is thrown for errors during API communication or invalid responses. - `CloudflareApiException` is thrown for errors during API communication or invalid responses.
- `CloudflareNotFoundException` is thrown when the requested resource (single or multiple) is not found, if enabled via - `CloudflareNotFoundException` is thrown when the requested resource (single or multiple) is not found, if enabled via the `emptyResultThrowsException` flag during initialization. **Default is `false`**, meaning empty results will be returned without throwing an exception.
the `emptyResultThrowsException` flag during initialization. **Default is `false`**, meaning empty results will be
returned without throwing an exception.
To enable exception throwing for empty results: To enable exception throwing for empty results: