Index
All Classes and Interfaces|All Packages|Serialized Form
A
- A - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS A record type.
- AAAA - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS AAAA record type.
- AbstractEntity - Class in codes.thischwa.cf.model
-
Represents a base abstract entity class for modeling domain objects with a unique identifier.
- AbstractEntity() - Constructor for class codes.thischwa.cf.model.AbstractEntity
- AbstractMultipleResponse<T extends ResponseEntity> - Class in codes.thischwa.cf.model
-
Abstract base class for response models that contain multiple result entries.
- AbstractResponse - Class in codes.thischwa.cf.model
-
Abstract base class for API response models.
- AbstractResponse() - Constructor for class codes.thischwa.cf.model.AbstractResponse
- AbstractSingleResponse<T extends ResponseEntity> - Class in codes.thischwa.cf.model
-
Represents a base abstract response model for handling single response entities within an API response.
- AbstractSingleResponse() - Constructor for class codes.thischwa.cf.model.AbstractSingleResponse
- addQueryString(String) - Method in class codes.thischwa.cf.model.PagingRequest
-
Appends a query string with pagination parameters (page and perPage) to the provided endpoint.
B
- build(String, RecordType, Integer, String) - Static method in class codes.thischwa.cf.model.RecordEntity
-
Builds and returns a
RecordEntity
instance with the specified attributes.
C
- CAA - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS CAA (Certificate Authority Authorization) record type.
- CERT - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS CERT record type.
- CfDnsClient - Class in codes.thischwa.cf
-
CfDnsClient is a client interface to interact with Cloudflare DNS service.
- CfDnsClient(boolean, String, String) - Constructor for class codes.thischwa.cf.CfDnsClient
-
Constructs a new instance of
CfDnsClient
. - CfDnsClient(boolean, String, String, String) - Constructor for class codes.thischwa.cf.CfDnsClient
-
Constructs a new instance of
CfDnsClient
. - CfDnsClient(String, String) - Constructor for class codes.thischwa.cf.CfDnsClient
-
Constructs a new instance of
CfDnsClient
. - CfDnsClient(String, String, String) - Constructor for class codes.thischwa.cf.CfDnsClient
-
Constructs a new instance of
CfDnsClient
. - CfRequest - Enum Class in codes.thischwa.cf
-
Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a cohesive and reusable manner.
- CloudflareApiException - Exception in codes.thischwa.cf
-
Represents a custom exception for errors encountered while interacting with the Cloudflare API.
- CloudflareApiException(String) - Constructor for exception codes.thischwa.cf.CloudflareApiException
-
Constructs a new CloudflareApiException with the specified detail message.
- CloudflareApiException(String, Throwable) - Constructor for exception codes.thischwa.cf.CloudflareApiException
-
Constructs a new CloudflareApiException with the specified detail message and cause.
- CloudflareNotFoundException - Exception in codes.thischwa.cf
-
This exception is thrown to indicate that a requested resource was not found during interaction with the Cloudflare API.
- CloudflareNotFoundException(String) - Constructor for exception codes.thischwa.cf.CloudflareNotFoundException
-
Constructs a new CloudflareNotFoundException with the specified detail message.
- CloudflareNotFoundException(String, Throwable) - Constructor for exception codes.thischwa.cf.CloudflareNotFoundException
-
Constructs a new CloudflareNotFoundException with the specified detail message and cause.
- CNAME - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS CNAME (Canonical Name) record type.
- codes.thischwa.cf - package codes.thischwa.cf
-
The base package of CloudflareDNS-java.
- codes.thischwa.cf.model - package codes.thischwa.cf.model
-
The model of CloudflareDNS-java.
- count() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns the value of the
count
record component.
D
- defaultPaging() - Static method in class codes.thischwa.cf.model.PagingRequest
-
Creates a default
PagingRequest
instance with a page number set to 1 and a high number of items per page (5,000,000) to accommodate large dataset requests. - DNSKEY - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNSKEY record type.
- DS - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS DS (Delegation Signer) record type.
E
- equals(Object) - Method in record class codes.thischwa.cf.model.ResultInfo
-
Indicates whether some other object is "equal to" this one.
G
- getId() - Method in interface codes.thischwa.cf.model.ResponseEntity
-
Retrieves the unique identifier of the entity.
- getPagingParams() - Method in class codes.thischwa.cf.model.PagingRequest
-
Retrieves the pagination parameters in a key-value map format.
H
- hashCode() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns a hash code value for this object.
- HTTPS - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS HTTPS (HTTP Service) record type.
L
- LOC - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS LOC (Location) record type.
M
- MX - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS MX (Mail Exchange) record type.
N
- NAPTR - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the NAPTR record type for DNS configurations.
- NS - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the namespace or identifier `"NS"` within the domain model.
O
- of(int, int) - Static method in class codes.thischwa.cf.model.PagingRequest
-
Creates a new
PagingRequest
instance with the specified page number and items per page. - OPENPGPKEY - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the "OPENPGPKEY" DNS record type.
P
- page() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns the value of the
page
record component. - PagingRequest - Class in codes.thischwa.cf.model
-
Represents a request model for paginated data.
- perPage() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns the value of the
perPage
record component. - PTR - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents a DNS record type.
R
- RECORD_CREATE - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for creating a new DNS record within a specific DNS zone.
- RECORD_DELETE - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for deleting an existing DNS record within a specific DNS zone.
- RECORD_INFO_NAME - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name.
- RECORD_INFO_NAME_TYPE - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name and type.
- RECORD_UPDATE - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for updating an existing DNS record within a specific DNS zone.
- recordCreate(ZoneEntity, RecordEntity) - Method in class codes.thischwa.cf.CfDnsClient
-
Creates a new DNS record in the specified zone using the Cloudflare API.
- recordCreate(ZoneEntity, String, int, RecordType, String) - Method in class codes.thischwa.cf.CfDnsClient
-
Creates a DNS record in the specified DNS zone with the provided details.
- recordCreateSld(ZoneEntity, String, int, RecordType, String) - Method in class codes.thischwa.cf.CfDnsClient
-
Creates a new DNS record for a given second-level domain (SLD) within the specified zone.
- recordDelete(ZoneEntity, RecordEntity) - Method in class codes.thischwa.cf.CfDnsClient
-
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
- recordDelete(ZoneEntity, String) - Method in class codes.thischwa.cf.CfDnsClient
-
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
- recordDeleteTypeIfExists(ZoneEntity, String, RecordType...) - Method in class codes.thischwa.cf.CfDnsClient
-
Deletes DNS records of a specific type within a given zone if they exist.
- RecordEntity - Class in codes.thischwa.cf.model
-
Represents a DNS record entity within a specific zone.
- RecordEntity() - Constructor for class codes.thischwa.cf.model.RecordEntity
-
Initializes a new instance of the RecordEntity class and invokes the parent constructor from the AbstractEntity class.
- RecordMultipleResponse - Class in codes.thischwa.cf.model
-
Represents the API response of the Cloudflare API containing multiple
RecordEntity
instances. - RecordMultipleResponse() - Constructor for class codes.thischwa.cf.model.RecordMultipleResponse
-
Constructs an instance of RecordMultipleResponse.
- RecordSingleResponse - Class in codes.thischwa.cf.model
-
Represents the API response of the Cloudflare API containing a single DNS record entity.
- RecordSingleResponse() - Constructor for class codes.thischwa.cf.model.RecordSingleResponse
-
Constructs a new instance of the RecordSingleResponse class.
- RecordType - Enum Class in codes.thischwa.cf.model
-
Enum representing various DNS record types.
- recordUpdate(ZoneEntity, RecordEntity) - Method in class codes.thischwa.cf.CfDnsClient
-
Updates an existing DNS record in a specified Cloudflare zone.
- ResponseEntity - Interface in codes.thischwa.cf.model
-
Represents a contract for entities that have a unique identifier.
- ResponseResultInfo - Class in codes.thischwa.cf.model
-
Represents the result of a response with metadata about its success and associated messages or errors.
- ResponseResultInfo() - Constructor for class codes.thischwa.cf.model.ResponseResultInfo
- ResultInfo - Record Class in codes.thischwa.cf.model
-
Represents metadata for paginated results.
- ResultInfo(int) - Constructor for record class codes.thischwa.cf.model.ResultInfo
-
Constructs a ResultInfo instance with the specified total count and default values for other fields.
- ResultInfo(int, int, int, int, int) - Constructor for record class codes.thischwa.cf.model.ResultInfo
-
Creates an instance of a
ResultInfo
record class.
S
- sldInfo(ZoneEntity, String, RecordType) - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves detailed information about a specific second-level domain (SLD) record for a given zone and record type from the Cloudflare API.
- sldListAll(ZoneEntity, String) - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
- sldListAll(ZoneEntity, String, PagingRequest) - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
- SMIMEA - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the SMIMEA DNS record type.
- SRV - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents a service record (SRV) type in the DNS configuration model.
- SSHFP - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the DNS record type "SSHFP" (SSH Fingerprint), used in DNS to store cryptographic fingerprints associated with SSH host keys.
- SVCB - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the Service Binding (SVCB) DNS record type.
T
- TLSA - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents a constant for the DNS-based Authentication of Named Entities (DANE) TLSA record type.
- toString() - Method in enum class codes.thischwa.cf.model.RecordType
- toString() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns a string representation of this record class.
- totalCount() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns the value of the
totalCount
record component. - totalPages() - Method in record class codes.thischwa.cf.model.ResultInfo
-
Returns the value of the
totalPages
record component. - TXT - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents the TXT DNS record type.
U
- URI - Enum constant in enum class codes.thischwa.cf.model.RecordType
-
Represents a Uniform Resource Identifier (URI).
V
- valueOf(String) - Static method in enum class codes.thischwa.cf.CfRequest
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class codes.thischwa.cf.model.RecordType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class codes.thischwa.cf.CfRequest
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class codes.thischwa.cf.model.RecordType
-
Returns an array containing the constants of this enum class, in the order they are declared.
Z
- ZONE_INFO - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for retrieving information about a specific DNS zone by its name.
- ZONE_LIST - Enum constant in enum class codes.thischwa.cf.CfRequest
-
Represents the API endpoint path for retrieving the list of DNS zones.
- ZoneEntity - Class in codes.thischwa.cf.model
-
Represents a DNS zone entity in the Cloudflare DNS system.
- ZoneEntity() - Constructor for class codes.thischwa.cf.model.ZoneEntity
-
Default no-argument constructor for the ZoneEntity class.
- zoneInfo(String) - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves detailed information about a specific zone by its name.
- zoneListAll() - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves a list of all zones from the Cloudflare API.
- zoneListAll(PagingRequest) - Method in class codes.thischwa.cf.CfDnsClient
-
Retrieves a list of all DNS zones using the provided paging request parameters.
- ZoneMultipleResponse - Class in codes.thischwa.cf.model
-
Represents a response model that contains multiple
ZoneEntity
instances. - ZoneMultipleResponse() - Constructor for class codes.thischwa.cf.model.ZoneMultipleResponse
-
Constructs a new ZoneMultipleResponse object.
All Classes and Interfaces|All Packages|Serialized Form