[ISSUE-114] Add comprehensive JavaDoc and documentation to CFTunnels #115

Merged
hitanshu merged 14 commits from Dave/CFTunnels:ISSUE-114 into main 2026-04-18 13:28:28 +00:00
Showing only changes of commit a7e7ea4a39 - Show all commits

View File

@ -1,8 +1,43 @@
package com.hithomelabs.CFTunnels.Entity; package com.hithomelabs.CFTunnels.Entity;
/**
* Enum representing supported protocols for Cloudflare Tunnel ingress mappings.
*
* <p>Cloudflare Tunnel supports multiple protocols for routing traffic
* to your internal services. This enum defines the available options.</p>
*
* <p><b>Supported Protocols:</b></p>
* <ul>
* <li>{@link #HTTP} - Standard HTTP protocol (port 80)</li>
* <li>{@link #HTTPS} - Secure HTTP protocol (port 443)</li>
* <li>{@link #TCP} - Raw TCP connections</li>
* <li>{@link #SSH} - SSH protocol for remote access</li>
* </ul>
*
* @see Mapping
*/
public enum Protocol { public enum Protocol {
/**
* HTTP protocol for web services.
* Typically used with internal services running on port 80.
*/
HTTP, HTTP,
/**
* HTTPS protocol for secure web services.
* Use this for services with TLS/SSL certificates.
*/
HTTPS, HTTPS,
/**
* Raw TCP protocol for non-HTTP services.
* Useful for databases, message queues, or custom protocols.
*/
TCP, TCP,
/**
* SSH protocol for secure shell access.
* Enables secure remote access to servers.
*/
SSH SSH
} }