Class Overview

GenericVpnContext is a class for applications to create custom VPN context object and achieve Knox VPN functionality.

GenericVpnContext class is basically extended from ContextWrapper class and accepts a context in its constructor. In general, this custom context creates a type matched object to pass context to Android`s prepare() API. This custom context facilitates passing extra parameters to achieve per-application VPN and meta-data passing with VPN traffic.

Please refer to Android`s VpnService documentation for further details on VPN solution creation.

Following are some key points:

• VPN clients can integrate with Knox VPN framework either by using the VPN service provided by Android (calling prepare function with GenericVpnContext) or by using GenericVpnService.
• When creating Knox VPN profile using GenericVpnContext, APIs available in VpnService.Builder class from API level 21 are not supported.
• When a VPN client needs to start a Knox VPN profile, the client can create object of GenericVpnContext.

  
   GenericVpnContext vpnContext = new GenericVpnContext(this);
  
   vpnContext.setGenericVpnParams(profileName, GenericVpnContext.CONNECTING);
  
   VpnService.prepare(vpnContext);
  
   

• When client needs to start a Knox VPN profile and get meta-data along with the traffic, then the client can create object of GenericVpnContext.

  
   GenericVpnContext vpnContext = new GenericVpnContext(this);
  
   vpnContext.setGenericVpnParams(profileName, GenericVpnContext.CONNECTING);
  
   vpnContext.enableMetaHeader(true);
  
   VpnService.prepare(vpnContext);
  
   

• When establishing the VPN connection for Knox profile, set the setSession value of the VpnService.Builder class to the profile name of the connection.
• When establishing the VPN connection for Knox profile, the addRoute value of the VpnService.Builder class is set to null by default.
• If the VPN client plans to support multiple VPN interfaces per user, they can achieve it by using the default VpnService provided by Android along with the changes mentioned above.

  Since

  API level 13

  KNOX 2.2.0

Summary

[Expand] Inherited Constants

From class android.content.Context String ACCESSIBILITY_SERVICE String ACCOUNT_SERVICE String ACTIVITY_SERVICE String ALARM_SERVICE String APPWIDGET_SERVICE String APP_OPS_SERVICE String AUDIO_SERVICE String BATTERY_SERVICE int BIND_ABOVE_CLIENT int BIND_ADJUST_WITH_ACTIVITY int BIND_ALLOW_OOM_MANAGEMENT int BIND_AUTO_CREATE int BIND_DEBUG_UNBIND int BIND_EXTERNAL_SERVICE int BIND_IMPORTANT int BIND_INCLUDE_CAPABILITIES int BIND_NOT_FOREGROUND int BIND_NOT_PERCEPTIBLE int BIND_WAIVE_PRIORITY String BIOMETRIC_SERVICE String BLOB_STORE_SERVICE String BLUETOOTH_SERVICE String CAMERA_SERVICE String CAPTIONING_SERVICE String CARRIER_CONFIG_SERVICE String CLIPBOARD_SERVICE String COMPANION_DEVICE_SERVICE String CONNECTIVITY_DIAGNOSTICS_SERVICE String CONNECTIVITY_SERVICE String CONSUMER_IR_SERVICE int CONTEXT_IGNORE_SECURITY int CONTEXT_INCLUDE_CODE int CONTEXT_RESTRICTED String CROSS_PROFILE_APPS_SERVICE String DEVICE_POLICY_SERVICE String DISPLAY_SERVICE String DOWNLOAD_SERVICE String DROPBOX_SERVICE String EUICC_SERVICE String FILE_INTEGRITY_SERVICE String FINGERPRINT_SERVICE String HARDWARE_PROPERTIES_SERVICE String INPUT_METHOD_SERVICE String INPUT_SERVICE String IPSEC_SERVICE String JOB_SCHEDULER_SERVICE String KEYGUARD_SERVICE String LAUNCHER_APPS_SERVICE String LAYOUT_INFLATER_SERVICE String LOCATION_SERVICE String MEDIA_PROJECTION_SERVICE String MEDIA_ROUTER_SERVICE String MEDIA_SESSION_SERVICE String MIDI_SERVICE int MODE_APPEND int MODE_ENABLE_WRITE_AHEAD_LOGGING int MODE_MULTI_PROCESS int MODE_NO_LOCALIZED_COLLATORS int MODE_PRIVATE int MODE_WORLD_READABLE int MODE_WORLD_WRITEABLE String NETWORK_STATS_SERVICE String NFC_SERVICE String NOTIFICATION_SERVICE String NSD_SERVICE String POWER_SERVICE String PRINT_SERVICE int RECEIVER_VISIBLE_TO_INSTANT_APPS String RESTRICTIONS_SERVICE String ROLE_SERVICE String SEARCH_SERVICE String SENSOR_SERVICE String SHORTCUT_SERVICE String STORAGE_SERVICE String STORAGE_STATS_SERVICE String SYSTEM_HEALTH_SERVICE String TELECOM_SERVICE String TELEPHONY_IMS_SERVICE String TELEPHONY_SERVICE String TELEPHONY_SUBSCRIPTION_SERVICE String TEXT_CLASSIFICATION_SERVICE String TEXT_SERVICES_MANAGER_SERVICE String TV_INPUT_SERVICE String UI_MODE_SERVICE String USAGE_STATS_SERVICE String USB_SERVICE String USER_SERVICE String VIBRATOR_SERVICE String VPN_MANAGEMENT_SERVICE String WALLPAPER_SERVICE String WIFI_AWARE_SERVICE String WIFI_P2P_SERVICE String WIFI_RTT_RANGING_SERVICE String WIFI_SERVICE String WINDOW_SERVICE

[Expand] Inherited Methods
From class android.content.ContextWrapper void attachBaseContext(Context arg0) boolean bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4) boolean bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3) boolean bindService(Intent arg0, ServiceConnection arg1, int arg2) boolean bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3) int checkCallingOrSelfPermission(String arg0) int checkCallingOrSelfUriPermission(Uri arg0, int arg1) int checkCallingPermission(String arg0) int checkCallingUriPermission(Uri arg0, int arg1) int checkPermission(String arg0, int arg1, int arg2) int checkSelfPermission(String arg0) int checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5) int checkUriPermission(Uri arg0, int arg1, int arg2, int arg3) void clearWallpaper() Context createAttributionContext(String arg0) Context createConfigurationContext(Configuration arg0) Context createContextForSplit(String arg0) Context createDeviceProtectedStorageContext() Context createDisplayContext(Display arg0) Context createPackageContext(String arg0, int arg1) Context createWindowContext(int arg0, Bundle arg1) String[] databaseList() boolean deleteDatabase(String arg0) boolean deleteFile(String arg0) boolean deleteSharedPreferences(String arg0) void enforceCallingOrSelfPermission(String arg0, String arg1) void enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2) void enforceCallingPermission(String arg0, String arg1) void enforceCallingUriPermission(Uri arg0, int arg1, String arg2) void enforcePermission(String arg0, int arg1, int arg2, String arg3) void enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6) void enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4) String[] fileList() Context getApplicationContext() ApplicationInfo getApplicationInfo() AssetManager getAssets() String getAttributionTag() Context getBaseContext() File getCacheDir() ClassLoader getClassLoader() File getCodeCacheDir() ContentResolver getContentResolver() File getDataDir() File getDatabasePath(String arg0) File getDir(String arg0, int arg1) Display getDisplay() File getExternalCacheDir() File[] getExternalCacheDirs() File getExternalFilesDir(String arg0) File[] getExternalFilesDirs(String arg0) File[] getExternalMediaDirs() File getFileStreamPath(String arg0) File getFilesDir() Executor getMainExecutor() Looper getMainLooper() File getNoBackupFilesDir() File getObbDir() File[] getObbDirs() String getOpPackageName() String getPackageCodePath() PackageManager getPackageManager() String getPackageName() String getPackageResourcePath() Resources getResources() SharedPreferences getSharedPreferences(String arg0, int arg1) Object getSystemService(String arg0) String getSystemServiceName(Class<?> arg0) Resources.Theme getTheme() Drawable getWallpaper() int getWallpaperDesiredMinimumHeight() int getWallpaperDesiredMinimumWidth() void grantUriPermission(String arg0, Uri arg1, int arg2) boolean isDeviceProtectedStorage() boolean isRestricted() boolean moveDatabaseFrom(Context arg0, String arg1) boolean moveSharedPreferencesFrom(Context arg0, String arg1) FileInputStream openFileInput(String arg0) FileOutputStream openFileOutput(String arg0, int arg1) SQLiteDatabase openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3) SQLiteDatabase openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2) Drawable peekWallpaper() Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1) Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2) Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4) Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3) void removeStickyBroadcast(Intent arg0) void removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1) void revokeUriPermission(Uri arg0, int arg1) void revokeUriPermission(String arg0, Uri arg1, int arg2) void sendBroadcast(Intent arg0, String arg1) void sendBroadcast(Intent arg0) void sendBroadcastAsUser(Intent arg0, UserHandle arg1) void sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) void sendOrderedBroadcast(Intent arg0, String arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) void sendOrderedBroadcast(Intent arg0, int arg1, String arg2, String arg3, BroadcastReceiver arg4, Handler arg5, String arg6, Bundle arg7, Bundle arg8) void sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) void sendOrderedBroadcast(Intent arg0, String arg1) void sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) void sendStickyBroadcast(Intent arg0) void sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1) void sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5) void sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) void setTheme(int arg0) void setWallpaper(Bitmap arg0) void setWallpaper(InputStream arg0) void startActivities(Intent[] arg0, Bundle arg1) void startActivities(Intent[] arg0) void startActivity(Intent arg0) void startActivity(Intent arg0, Bundle arg1) ComponentName startForegroundService(Intent arg0) boolean startInstrumentation(ComponentName arg0, String arg1, Bundle arg2) void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4) void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5) ComponentName startService(Intent arg0) boolean stopService(Intent arg0) void unbindService(ServiceConnection arg0) void unregisterReceiver(BroadcastReceiver arg0) void updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)
From class android.content.Context boolean bindIsolatedService(Intent arg0, int arg1, String arg2, Executor arg3, ServiceConnection arg4) boolean bindService(Intent arg0, int arg1, Executor arg2, ServiceConnection arg3) abstract boolean bindService(Intent arg0, ServiceConnection arg1, int arg2) boolean bindServiceAsUser(Intent arg0, ServiceConnection arg1, int arg2, UserHandle arg3) abstract int checkCallingOrSelfPermission(String arg0) abstract int checkCallingOrSelfUriPermission(Uri arg0, int arg1) abstract int checkCallingPermission(String arg0) abstract int checkCallingUriPermission(Uri arg0, int arg1) abstract int checkPermission(String arg0, int arg1, int arg2) abstract int checkSelfPermission(String arg0) abstract int checkUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5) abstract int checkUriPermission(Uri arg0, int arg1, int arg2, int arg3) abstract void clearWallpaper() Context createAttributionContext(String arg0) abstract Context createConfigurationContext(Configuration arg0) abstract Context createContextForSplit(String arg0) abstract Context createDeviceProtectedStorageContext() abstract Context createDisplayContext(Display arg0) abstract Context createPackageContext(String arg0, int arg1) Context createWindowContext(int arg0, Bundle arg1) abstract String[] databaseList() abstract boolean deleteDatabase(String arg0) abstract boolean deleteFile(String arg0) abstract boolean deleteSharedPreferences(String arg0) abstract void enforceCallingOrSelfPermission(String arg0, String arg1) abstract void enforceCallingOrSelfUriPermission(Uri arg0, int arg1, String arg2) abstract void enforceCallingPermission(String arg0, String arg1) abstract void enforceCallingUriPermission(Uri arg0, int arg1, String arg2) abstract void enforcePermission(String arg0, int arg1, int arg2, String arg3) abstract void enforceUriPermission(Uri arg0, String arg1, String arg2, int arg3, int arg4, int arg5, String arg6) abstract void enforceUriPermission(Uri arg0, int arg1, int arg2, int arg3, String arg4) abstract String[] fileList() abstract Context getApplicationContext() abstract ApplicationInfo getApplicationInfo() abstract AssetManager getAssets() String getAttributionTag() abstract File getCacheDir() abstract ClassLoader getClassLoader() abstract File getCodeCacheDir() final int getColor(int arg0) final ColorStateList getColorStateList(int arg0) abstract ContentResolver getContentResolver() abstract File getDataDir() abstract File getDatabasePath(String arg0) abstract File getDir(String arg0, int arg1) Display getDisplay() final Drawable getDrawable(int arg0) abstract File getExternalCacheDir() abstract File[] getExternalCacheDirs() abstract File getExternalFilesDir(String arg0) abstract File[] getExternalFilesDirs(String arg0) abstract File[] getExternalMediaDirs() abstract File getFileStreamPath(String arg0) abstract File getFilesDir() Executor getMainExecutor() abstract Looper getMainLooper() abstract File getNoBackupFilesDir() abstract File getObbDir() abstract File[] getObbDirs() String getOpPackageName() abstract String getPackageCodePath() abstract PackageManager getPackageManager() abstract String getPackageName() abstract String getPackageResourcePath() abstract Resources getResources() abstract SharedPreferences getSharedPreferences(String arg0, int arg1) final String getString(int arg0, Object... arg1) final String getString(int arg0) final <T> T getSystemService(Class<T> arg0) abstract Object getSystemService(String arg0) abstract String getSystemServiceName(Class<?> arg0) final CharSequence getText(int arg0) abstract Resources.Theme getTheme() abstract Drawable getWallpaper() abstract int getWallpaperDesiredMinimumHeight() abstract int getWallpaperDesiredMinimumWidth() abstract void grantUriPermission(String arg0, Uri arg1, int arg2) abstract boolean isDeviceProtectedStorage() boolean isRestricted() abstract boolean moveDatabaseFrom(Context arg0, String arg1) abstract boolean moveSharedPreferencesFrom(Context arg0, String arg1) final TypedArray obtainStyledAttributes(AttributeSet arg0, int[] arg1) final TypedArray obtainStyledAttributes(AttributeSet arg0, int[] arg1, int arg2, int arg3) final TypedArray obtainStyledAttributes(int arg0, int[] arg1) final TypedArray obtainStyledAttributes(int[] arg0) abstract FileInputStream openFileInput(String arg0) abstract FileOutputStream openFileOutput(String arg0, int arg1) abstract SQLiteDatabase openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2, DatabaseErrorHandler arg3) abstract SQLiteDatabase openOrCreateDatabase(String arg0, int arg1, SQLiteDatabase.CursorFactory arg2) abstract Drawable peekWallpaper() void registerComponentCallbacks(ComponentCallbacks arg0) abstract Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1) abstract Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, int arg2) abstract Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3, int arg4) abstract Intent registerReceiver(BroadcastReceiver arg0, IntentFilter arg1, String arg2, Handler arg3) abstract void removeStickyBroadcast(Intent arg0) abstract void removeStickyBroadcastAsUser(Intent arg0, UserHandle arg1) abstract void revokeUriPermission(Uri arg0, int arg1) abstract void revokeUriPermission(String arg0, Uri arg1, int arg2) abstract void sendBroadcast(Intent arg0, String arg1) abstract void sendBroadcast(Intent arg0) abstract void sendBroadcastAsUser(Intent arg0, UserHandle arg1) abstract void sendBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2) void sendBroadcastWithMultiplePermissions(Intent arg0, String[] arg1) void sendOrderedBroadcast(Intent arg0, String arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) abstract void sendOrderedBroadcast(Intent arg0, String arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) abstract void sendOrderedBroadcast(Intent arg0, String arg1) abstract void sendOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, String arg2, BroadcastReceiver arg3, Handler arg4, int arg5, String arg6, Bundle arg7) abstract void sendStickyBroadcast(Intent arg0) abstract void sendStickyBroadcastAsUser(Intent arg0, UserHandle arg1) abstract void sendStickyOrderedBroadcast(Intent arg0, BroadcastReceiver arg1, Handler arg2, int arg3, String arg4, Bundle arg5) abstract void sendStickyOrderedBroadcastAsUser(Intent arg0, UserHandle arg1, BroadcastReceiver arg2, Handler arg3, int arg4, String arg5, Bundle arg6) abstract void setTheme(int arg0) abstract void setWallpaper(Bitmap arg0) abstract void setWallpaper(InputStream arg0) abstract void startActivities(Intent[] arg0, Bundle arg1) abstract void startActivities(Intent[] arg0) abstract void startActivity(Intent arg0) abstract void startActivity(Intent arg0, Bundle arg1) abstract ComponentName startForegroundService(Intent arg0) abstract boolean startInstrumentation(ComponentName arg0, String arg1, Bundle arg2) abstract void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4) abstract void startIntentSender(IntentSender arg0, Intent arg1, int arg2, int arg3, int arg4, Bundle arg5) abstract ComponentName startService(Intent arg0) abstract boolean stopService(Intent arg0) abstract void unbindService(ServiceConnection arg0) void unregisterComponentCallbacks(ComponentCallbacks arg0) abstract void unregisterReceiver(BroadcastReceiver arg0) void updateServiceGroup(ServiceConnection arg0, int arg1, int arg2)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()