Dave/CFTunnels
1
0
Fork 0
forked from Hithomelabs/CFTunnels
Code Pull Requests 2 Activity

Hithomelabs/CFTunnels#114: Add JavaDoc to CloudflareConfig

Browse Source
This commit is contained in:
Dave the Dev 2026-04-14 11:53:28 +00:00
parent 258c09285e
commit ac2ae0a59f
1 changed files with 37 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/main/java/com/hithomelabs/CFTunnels/Config/CloudflareConfig.java
View File

@ -3,11 +3,47 @@ package com.hithomelabs.CFTunnels.Config;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
/**
* Configuration class for Cloudflare API credentials.
*
* <p>Loads Cloudflare configuration from application properties
* using the {@code cloudflare.*} prefix.</p>
*
* <p><b>Example configuration in application.properties:</b></p>
* <pre>
* cloudflare.account-id=your-account-id
* cloudflare.api-key=your-api-key
* cloudflare.email=your@email.com
* </pre>
*
* @see <a href="https://api.cloudflare.com/">Cloudflare API Documentation</a>
*/
@Configuration @Configuration
@ConfigurationProperties(prefix = "cloudflare") @ConfigurationProperties(prefix = "cloudflare")
public class CloudflareConfig { public class CloudflareConfig {
/**
* Cloudflare account ID.
*
* <p>Found in the Cloudflare Dashboard under
* Overview > Account ID</p>
*/
private String accountId; private String accountId;
/**
* Cloudflare API Key.
*
* <p>Generated in Cloudflare Dashboard under
* Profile > API Tokens > Global API Key</p>
*/
private String apiKey; private String apiKey;
/**
* Cloudflare account email.
*
* <p>The email address associated with your
* Cloudflare account.</p>
*/
private String email; private String email;
// Getters and Setters // Getters and Setters
@ -19,4 +55,4 @@ public class CloudflareConfig {
public String getEmail() { return email; } public String getEmail() { return email; }
public void setEmail(String email) { this.email = email; } public void setEmail(String email) { this.email = email; }
} }