Java Agent
📄️ Quickstart
Get started with NetFUNNEL 4 Java Agent in 5-10 minutes with this quick start guide.
📄️ Installation & Initialization
NetFUNNEL Java agent installation and initialization guide.
📄️ Integration Methods
Overview of integration methods supported by NetFUNNEL Java Agent.
📄️ Initialization Option Reference
This document describes all initialization settings available in NetFunnelInitialize.
📄️ API Reference
Complete reference for NetFUNNEL Java Agent functions and usage.
📄️ Troubleshooting
Common issues, solutions, and frequently asked questions for NetFUNNEL Java Agent integration.
Overview
Java Agent is a server-side SDK that provides NetFUNNEL 4 traffic control functionality for Java-based Spring Boot servers.
Key Features
- Server-side SDK: Direct integration into Spring Boot applications
- URL-Triggered Integration: Automatic control based on trigger rules
- Interceptor/Filter Support: Applied using Spring Boot Interceptor or Filter approach
- Automatic Waiting Room Redirect: Automatically redirects to waiting room page when waiting response is received
- Trigger Rule Matching: Controls queue application points using URL-based trigger rules
- Robust Error Handling: Comprehensive error handling and logging
System Requirements
- Java: 1.7 or higher
- Spring Boot: 3.x or higher
- External Dependencies:
- gson: Library for JSON serialization/deserialization
- jackson-module-kotlin: Library required for Kotlin usage (when using Java)
Compatible Environments
- Java Applications: Applications based on Java 1.7 or higher
- Spring Boot Applications: Applications based on Spring Boot 3.x or higher
How It Works
- Agent Initialization: Initialize NetFUNNEL and configure settings
- Interceptor/Filter Application: Apply NetFUNNEL logic to Interceptor or Filter that receives requests first
- Trigger Rule Matching: Compare the URL of the page accessed by the user with trigger rules and apply queue if they match
- Automatic Waiting Room Processing: Automatically redirect to waiting room page when waiting response is received
Agent Operation Flow
Before Waiting: Page Load → Agent Initialization → Trigger Rule Match
During Waiting: NetFUNNEL Server Request → NetFUNNEL Key Issuance → Move to Waiting Room Page
After Waiting: Service Page Entry → NetFUNNEL Key Return
Integration Methods
URL-Triggered Integration
URL-Triggered Integration sets queue control points through segment trigger rules in the NetFUNNEL console. When the URL of the page accessed by the user matches the trigger rules, the queue is applied.
For detailed information, refer to the Integration Methods Overview document.
Limitations
Java Agent does not support code-based integration. Only URL-Triggered integration can be used.
Quick Start
To quickly get started with Java Agent, refer to the Quick Start guide.
Documentation
Core Documentation
- Quick Start: Get started in 5-10 minutes with basic examples
- Installation and Initialization: Detailed guide on dependencies and configuration
- Integration Methods: URL-Triggered Integration overview
- API Reference: Complete function specifications and usage
- Initialization Settings: All initialization parameters and usage
- Troubleshooting: Common issues, solutions, and FAQ
Related Content
- Node.js Agent: Node.js SDK integration guide
- Sample Projects: Ready-to-use project templates