Androidエージェント機能のご紹介

本書は、エージェントインストール後の動作過程と使用に関する案内を含む文書です。

内容を確認する前に、エージェントのインストールが正常に行われたことを確認してください。

• NetFUNNEL Android エージェントのインストール

NetFUNNEL エージェント機能のご案内

NetFUNNEL applicationに適用されるNetFUNNELは以下のような機能をサポートします。

• NetFUNNEL コンソールに登録されたドメインアドレスに基づいてNetFUNNELサーバーと通信し、特定のポイントに待合室と遮断室機能を提供します。
• EUM(End User Monitoring)機能を活用するためのデバイス状態情報と設定した区間での作業処理所要時間のデータ収集を行います。
  • NetFUNNELのリクエストに対して自動的にデータを収集しますが、APIの適用方法により、適用時に希望する区間のデータも一緒に測定することができます。

NetFUNNELエージェント動作のご案内

NetFUNNELエージェントは下記のように動作します。

1. NetFUNNEL center apiサーバーと通信してNetFUNNELの設定を読み込みます。
   1. 成功時 → 2番にアクセス
   2. 失敗時 → ByPass
2. 引数で渡されたActivityが存在するかチェックします。
   1. 存在する場合 → 3番にアクセス
   2. ない場合 → 失敗ロジック実行
3. 飛行機モードかどうかを確認します。
   1. 飛行機モードでない場合 → 4番に進みます。
   2. 飛行機モードの場合 → 失敗ロジックを実行
4. NetFUNNEL設定のプロジェクト情報を読み込みます。
   1. プロジェクト情報が存在する場合 → 5番にアクセス
   2. プロジェクト情報がない場合 → ByPass
5. Keyで使用したドメインアドレスを分析します。 (main domain, sub domain, path, query string)
   
   1. main domainがsurffy-consoleで登録した値でない場合 → ByPass
   2. その他 → 6番にアクセス
6. 重複動作の有無をチェックします。 (複数回連打防止)
7. 基本コントロール、区間コントロールのどちらのタイプかをチェックします。
8. NetFUNNELチェックロジック開始

NetFUNNELサーバーのリクエストと応答処理

基本コントロール

• NetFUNNELサーバーへのアクセスリクエストとキー発行
  • 入室許可応答時 → 応答成功ロジック実行
  • 待機応答時 → 応答Activityに切り替え → 待機室webview呼び出し
  • 遮断応答時 → 応答Activityに切り替え → 遮断室webviewを呼び出し
  • サーバーリクエスト失敗時(ネットワーク障害など) → 応答成功ロジック実行(基本動作保証)
  • エラー応答時 → 応答成功ロジック実行(Bypass)
• finally キーの返却

Web Viewは独自にNetFUNNELサーバーと通信して継続的な待機状態を維持します。

• 待合室運転中に発生する動作
  • NetFUNNELサーバーとの継続的な通信アクセス応答許可時 → 応答成功ロジック実行
  • 遮断応答時 → 遮断ウィンドウ呼び出し
  • バイパス応答時 → 応答成功ロジック実行(Bypass)
  • エラー応答時 → 応答成功ロジックを実行(基本動作保証)
  • ユーザーキャンセル時 → ユーザーキャンセルロジック実行
  • 戻る実行時 → ユーザーキャンセルロジックを実行します。
  • 機内モード切り替え時 → ユーザーキャンセルロジック実行
  • アイドル状態に入る時 → ユーザーキャンセルロジック実行
  • 電波遮断時 → ユーザーキャンセルロジック実行
• finally キーの返却

アイドル状態とは、アプリをバックグラウンドに切り替えて一定時間が経過した後、バッテリー節約のためのDoze Mode動作が実行されることを意味します。

区間コントロール

• 基本コントロールと同じですが、キー返却は行いません。
• ユーザーの区間コントロール終了リクエスト時にキーを返却します。

ユーザーが区間コントロール終了リクエストをせずにアプリを終了しても、NetFUNNELlサーバー自体のmax working time値を利用してユーザーの離脱を処理します。

NetFUNNEL エージェントオブジェクトと関数の説明

Object & Class

Type	Name	Description
Object	Netfunnel	NetFUNNEL機能動作の骨格を担当しており、該当するObjectの関数を使用してNetFUNNEL動作を実行します。
Abstract Class	AgentInterface	抽象化クラスでNetFUNNEL応答の機能を定義するためのインターフェースとして提供されます。 該当するオブジェクトを生成してNetFUNNEL動作実行時、引数として渡す必要があります。
Class	NFInterceptor	OkHttp3 の Interceptor を継承したクラスで OkHttp3 ライブラリを使う場合、そのインターセプターを追加して登録したセグメントに対するリクエストを自動で検知して NetFUNNEL 機能を設定することができます。

AgentInterfaceはCallback関数で動作します。

Function

• Parent : Netfunnel
  • Function : nflnit

Description	Argument	Type	Argument Description
NetFUNNEL機能動作のための初期化データを渡してNetFUNNEL設定値を読み込む関数です。 * 詳細引数はSurffy-Consoleのエージェントタブの値をコピーして使用します	appName	String	App 区別のためのユーザー固有の AppName
	tenantAPIURL	String	APIサーバーアドレス
	tenantNFURL	String	Netfunnelサーバーアドレス
	settingURL	String	Netfunnel動作設定ファイルのアドレス
	eumURL	String	データ解析のための収集サーバーアドレス
	Activity	Activity	待合室/遮断室が生成されるためのActivity
	context	Context	ActivityのContext (値がない場合はActivity.baseContextに設定されます。)

• • Function : nfStart

Description	Argument	Type	Argument Description
Netfunnelの機能開始をコントロールする関数です。	serviceURL	String	セグメントに登録したURL
	callback	AgentInterface	Netfunnel コントロール応答による動作が定義されたインターフェース

• • Function : setActivity

Description	Argument	Type	Argument Description
Activity変更機能	Activity	Activity	待合室/遮断室が生成されるためのActivity

• • Function : clearActivity

Description	Argument	Type	Argument Description
該当関数を実行する場合。Netfunnel機能が終了した後、該当Activityをnull処理します。	-	-	-

• • Function : setContext

Description	Argument	Type	Argument Description
Context変更機能	Context	Context	該当関数を実行する場合。Netfunnel機能が終了した後、該当Activityをnull処理します。

• • Function : eumStart

Description	Argument	Type	Argument Description
eumStart、eumEndを使用して、その間の所要時間をUIで確認することができます。	serviceURL	String	https://www.example のように入力する場合、mainDomain, subDomain, Pathの形で自動的に分離します。 その値でSurffy Consoleのend user monitoring画面に表示されます。

• • Function : eumEnd

Description	Argument	Type	Argument Description
eumStart、eumEndを使用して、その間の所要時間をUIで確認することができます。	mainDomain	String	この値で Consoleのend user monitoring画面に表示されます。 (URL内の一部の引数だけ特定するためのArgumentです。)
	subDomain	String
	Path	String

• Parent : AgentInterface
  • Funtion : onSuccess

Description	Argument	Type	Argument Description
Netfunnel応答成功時に呼び出されます。	-	-	-

• • Function : onCancel

Description	Argument	Type	Argument Description
ユーザーが待合室/遮断室をキャンセルした場合に呼び出されます。	CancelURL	String	Surffy-Consoleの待合室/遮断室の '待機解除リダイレクトURL'

• • Funtion : onFail

Description	Argument	Type	Argument Description
Activity値がない場合、または最初のリクエスト時にネットワークエラーが発生した場合に呼び出されます。	-	-	-

• • Function : nfLog

Description	Argument	Type	Argument Description
ライブラリ内部の動作をユーザーのアプリでテストしながら把握できるように該当関数にログを渡します。	_message	String	Library 動作ログ

引数を正しく入力したことをご確認ください。