[ISSUE-114] Add comprehensive JavaDoc and documentation to CFTunnels #115
@ -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
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user