Introduction to Android Agent features

This document contains instructions on how to install the agent, how it works, and how to use it.
Please make sure you have successfully installed the agent before reading this document.

• Install the NetFUNNEL Android Agent

NetFUNNEL Android Agent Key Features

NetFUNNEL applied to Android applications supports the following features

• Communicates with the NetFUNNEL server based on the domain address registered in NetFUNNEL Console, providing waiting and blocking window functions at specific points.
• Collect data on device status information and task processing time at the set interval to use the End User Monitoring (EUM) function.
  • It automatically collects data for NetFUNNEL requests, but the API application method allows you to measure data for the desired interval when applied.

Netfunnel Agent Operation

The internal operation of the NetFUNNEL Agent goes like this:

Preferences, Domains and Segment checks

1. Communicate with surffy center api server to read Netfunnel settings.
   1. On success → Go to step 2
   2. On failure → ByPass
2. Checks whether the Activity received as a factor exists.
   1. Present → Go to step 3
   2. None → Execute failure logic
3. Check if it is in airplane mode.
   1. Yes -> Go to step 4
   2. No -> Execute failure logic
4. Read project information from Netfunnel settings.
   1. If project information exists → Go to step 5
   2. If there is no project information → ByPass
5. Analyze the domain address used as the key. (main domain, subdomain, path, query-string)
   1. If the main domain is not the value registered in surffy-console → ByPass
   2. Others → Go to step 6
6. Check for overlapping operations. (Prevent multiple hits)
7. Check whether it is the basic control or path control.
8. Start Netfunnel check logic.

Netfunnel server Request and Response handling

Basic control

• Netfunnel server entry request and key issuance
  • Response allowing entry → Execute response success logic
  • Response waiting → switch to response activity → call webview of waiting window
  • Response blocking → switch to response activity → call webview of blocking window
  • Server request failure (network failure, etc.) → Response success logic execution (basic operation guaranteed)
  • Error response → Execute response success logic (ByPass)
• Return the finally key

The WebView itself communicates with the Netfunnel server to maintain a persistent waiting state.

• Actions that occur during waiting window operation
  • Continuous communication with the Netfunnel server
  • Response allowing entry → Execute response success logic
  • Response blocking → Call blocking room
  • Response bypass → Execute response success logic (ByPass)
  • Error response → Execute response success logic (basic operation guaranteed)
  • When user cancels → Execute user cancel logic
  • When going back → Execute user cancel logic
  • When airplane mode is switched → Execute user cancel logic
• finally key return

Path Control

• Same as basic control, but key return does not proceed.
• The key is returned when the user requests to end the path control.

Even if the user exits the app without requesting the path control termination, the Netfunnel server's own max working time value is used to process the user's outflow.

Netfunnel Agent Object & Function descriptions

Object & Class

Type	Name	Description
Object	Netfunnel	It is responsible for the frame of the Netfunnel function operation, and uses the function of the corresponding object to execute the Netfunnel operation.
Abstract Class	AgentInterface	An abstraction class, provided as an interface for defining functionality for Netfunnel responses. You need to create the corresponding object and pass it as an argument when executing the Netfunnel operation.
Class	NFIterceptor	This class inherites from the Interceptor of OkHttp3. If you are using the OkHttp3 library, you can set up Netfunnel functionality by adding its interceptor to automatically detect requests for registered segments.

AgentInterface works as a callback function.

Function

• Parent : Netfunnel
  • Function : nflnit

Description	Argument	Type	Argument Description
* A function that receives initialization data to operate the NetFUNNEL feature and reads the NetFUNNEL settings. * For the detail arguments, copy the values from the Agent tab in the NetFUNNLE console.	appName	String	User's unique AppName for application identification
	tenantAPIURL	String	API server address
	tenantNFURL	String	Netfunnel server address
	settingURL	String	Address of Netfunnel action settings file
	eumURL	String	Collection server address for data analysis
	Activity	Activity	Activity for which the waiting/blocking room is created
	context	Context	Activity's Context (If there is no value, it is set to Activity.baseContext).

• • Function : nfStart

Description	Argument	Type	Argument Description
A function that controls the launch of the NetFUNNEL feature.	serviceURL	String	Segment's registered URLs
	callback	AgentInterface	An interface whose behavior is defined by NetFUNNEL's control response.

• • Function : setActivity

Description	Argument	Type	Argument Description
Change Activity	Activity	Activity	Activity to create a waiting/blocking room

• • Function : clearActivity

Description	Argument	Type	Argument Description
When you run this function. Activity is set to null after closing the NetFUNNEL function.	-	-	-

• • Function : setContext 

Description	Argument	Type	Argument Description
Change Context	Context	Context	Activity Context (If there is no value, it is set to Activity.baseContext)

• • Function : eumStart

Description	Argument	Type	Argument Description
Use eumStart, eumEnd to see the processing time in between in the UI.	serviceURL	String	If you enter something like https://www.example, it will automatically be split into mainDomain, subDomain, and Path. These values are displayed in the end-user monitoring screen of the NetFUNNEL console.

• • Function : eumEnd

Description	Argument	Type	Argument Description
Use eumStart, eumEnd to see the processing time in between in the UI.	mainDomain	String	These values are displayed in the end-user monitoring screen of the NetFUNNEL console. (Arguments to specify only some arguments in the URL.)
	subDomain	String
	Path	String

• Parent : AgentInterface
  • Function : onSuccess

Description	Argument	Type	Argument Description
Invoked on a successful response.	-	-	-

• • Function : onCancel

Description	Argument	Type	Argument Description
Invoked when the user has canceled the waiting / blocking room.	CancelURL	String	Invoked when the user has canceled the waiting / blocking room.

• • Function : onFail

Description	Argument	Type	Argument Description
Invoked when there is no Activity value or when the initial request is a network error.	-	-	-

• • Function : nfLog

Description	Argument	Type	Argument Description
Pass logs to this function so that you can understand the internal behavior of the library as you test it with your own application.	_message	String	Library action log

Please note that normal operation may not be guaranteed if an incorrect parameter is entered.