Skip to main content
Version: 4.6.1-saas

Initialization Settings

This document describes all initialization settings available in NetFunnelInitialize.

Required Parameters​

The initialization settings require clientId and secretKey parameters.

Getting Client ID and Secret Key

For how to get Client ID and Secret Key and initialization examples, refer to the Quick Start document.

Basic Initialization​

Using Only Required Parameters​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .build();

Initialization Setting Parameters​

FieldTypeDefaultDescriptionAgent Version
clientIdStringN/AEnter the client ID issued from the console.4.0.1 or higher
secretKeyStringN/AEnter the encryption key issued from the console.4.0.1 or higher
serverUrlStringN/AURL of the NetFUNNEL server. Used when accessing the server with a separate URL without using CNAME and not using clientId-based URL composition. (Supported for compatibility with existing methods.)4.0.1 or higher
settingUrlStringN/AURL of the NetFUNNEL configuration file. Used when loading the configuration file with a separate URL without using CNAME and not using clientId-based URL composition. (Supported for compatibility with existing methods.)4.0.1 or higher
vwrPageUrlStringN/AURL of the NetFUNNEL VWR Page. Specified when entering the waiting room page with a separate URL without using CNAME and not using clientId-based URL composition.4.0.1 or higher
returnKeybooleantrueWhen a user passes through the queue and enters the page, the next user can enter immediately. If the option is disabled, the next user will wait for a certain period even after the user enters the page. (Timeout settings can be configured in Console > Segment Settings > Advanced Settings.)4.0.1 or higher
logLevelLevelLevel.OFFSets the log level based on ch.qos.logback.classic.Level, so the dependency must be added. Available levels: ERROR, WARN, INFO, DEBUG, TRACE, OFF4.0.1 or higher
goodBotsArray<String>N/AConfigures to exclude good bots (search engines, etc.) from NetFUNNEL entry requests. Accepts an array of strings. Example: ["Googlebot", "Bingbot"]4.0.1 or higher
userIdStringN/AWhen this value is entered, the ID is used to distinguish whitelist and permanently blocked users. The ID set in Console > Repeated Request Blocking > User Settings > Accessor Management is applied.4.0.1 or higher
vwrPageDomainStringN/AUsed when constructing VWR Page URL with CNAME domain only. Example: https://vwr.example.com4.0.1 or higher
cookieDomainStringN/AYou can directly specify the domain value of the NetFUNNEL cookie to be issued.4.0.1 or higher

Configuration Examples​

Basic Configuration​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .build();

Log Level Configuration​

import ch.qos.logback.classic.Level;

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .logLevel(Level.INFO)
    .build();

Good Bot Exception Handling​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .goodBots(new String[]{"Googlebot", "Bingbot", "Slurp", "Applebot", "facebookexternalhit"})
    .build();

User Identification Configuration​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .userId("{{USER_ID}}")
    .build();

Disable Automatic Entry Key Return​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .returnKey(false)
    .build();

Change Waiting Room Domain​

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .vwrPageDomain("https://wait.example.com")
    .build();
NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    .cookieDomain(".example.com")
    .build();

Complete Configuration Example​

import ch.qos.logback.classic.Level;

NetFunnelInitialize config = NetFunnelInitialize.Companion.builder()
    // Required
    .clientId("{{CLIENT_ID}}")
    .secretKey("{{SECRET_KEY}}")
    
    // Server configuration (optional)
    .serverUrl("https://custom-server.example.com")
    .settingUrl("https://custom-setting.example.com")
    .vwrPageUrl("https://custom-vwr.example.com")
    
    // Waiting room settings
    .vwrPageDomain("https://wait.example.com")
    .cookieDomain(".example.com")
    
    // Key management
    .returnKey(true)
    
    // Logging
    .logLevel(Level.INFO)
    
    // Bot exception handling
    .goodBots(new String[]{"Googlebot", "Bingbot"})
    
    // User identification
    .userId("{{USER_ID}}")
    .build();

Parameter Validation​

clientId​

  • Required
  • Type: String
  • Validation: Cannot be empty string
  • Source: NetFUNNEL Console → Profile Icon → Integration Credentials

secretKey​

  • Required
  • Type: String
  • Validation: Cannot be empty string
  • Source: NetFUNNEL Console → Profile Icon → Integration Credentials

logLevel​

  • Optional
  • Type: ch.qos.logback.classic.Level
  • Default: Level.OFF
  • Available Levels: ERROR, WARN, INFO, DEBUG, TRACE, OFF
  • Dependency: logback-classic required

goodBots​

  • Optional
  • Type: String[]
  • Default: null
  • Example: new String[]{"Googlebot", "Bingbot"}

returnKey​

  • Optional
  • Type: boolean
  • Default: true
  • Behavior: Returns key immediately when true, returns according to timeout settings when false