Pango Platform
HomeConsole
  • What is Pango Developer Platform
  • Getting started
    • Sign up on the Management Console
    • Create a new project
    • Switch projects
    • Change console settings
    • Edit your profile
    • Try out the demo app
    • Keep exploring
    • Deprecation and Sunset
  • Console details
    • Dashboard
      • General
      • Location loading
    • Users
      • User page
    • Active sessions
    • Network
      • Countries
      • Locations
      • Pools
        • Optimal location
        • Location rules
    • Settings
      • General
        • Project config description (JSON format)
          • Server selector (JSON format)
          • Request selector (JSON format)
      • Authentication methods
        • Auth Plugin requirements
      • VPN
        • General
        • VPN Bypass list
        • Client Networks
      • Member
    • Export Data
    • Log
  • SDK
    • Unified VPN SDK for Android
      • Setup
        • Application Setup
        • Proguard Rules, Notification, and Analytics Configurations
        • Backend URL Configuration
      • Usage
        • Initialization
        • VPN Interface
        • Backend interface
      • Features
        • Hydra Protocol
          • Location profile (Hydra only)
        • Custom sdk dependencies
        • Deferred VPN Service Initialization
        • Authentication
        • Client Network List (CNL)
        • OpenVPN transport
        • Wireguard Transport
        • Reconnection strategy
        • Single Protocol SDK
        • Killswitch
        • Domain route via VPN
        • Process route via VPN
        • Process Bypass
        • Domain Bypass
        • Traffic rules
        • VPN Node DNS Configuration
        • Multihop
          • Optimal Location
      • Exceptions
      • Version migration
      • Changelog
    • Unified VPN SDK for Apple
      • Setup
        • Application Setup
        • Network Extension Setup
          • Network Extension Setup for tvOS
        • Backend URL Configuration
      • Usage
        • Single Protocol SDK
        • Unified SDK
        • Logging
        • Decoding Encoded VPN SDK Logs
      • Features
        • Deferred VPN Service Initialization
        • Authentication
        • Wireguard Transport
        • Reconnection strategy
        • Killswitch
        • Domain Bypass
        • Multihop
          • Optimal Location
        • Client Network List (CNL)
        • Domain route via VPN
      • Changelog
      • API Reference
    • IPSEC VPN SDK for Apple
    • Unified VPN SDK for Windows
      • Setup
        • Backend URL Configuration
        • Service command line arguments
        • ARM Platform Support
      • Usage
        • CoreAPI
        • Events
        • Generating a Unique Device Identifier
        • Error processing
        • Pipe Messaging
      • Features
        • Traffic protection
          • Killswitch
          • Prevent IP Leaks
          • Block Local Networks
        • Other
          • Firewall
            • DNS Monitor
            • Process Bypass
            • Domain Bypass
            • Process route via VPN
            • Domain route via VPN
          • Throttling
          • Optimal Location
          • Common issues
        • Hydra Protocol
          • CustomDNS, UserDNS, MultiHop, VpnProfiles
        • OpenVPN Protocol
        • Wireguard Protocol
        • IPSec Protocol
      • Collecting Debug Logs
      • Changelog
    • Unified VPN SDK for Routers
      • SDK. Shared library.
      • Configuration Interface (CI)
        • Unix Domain Sockets CI
        • REST API CI
    • Unified VPN SDK Feature Comparison By Platform
    • Unified VPN SDK
      • Features
        • Personal Bridge
    • Tunnel Vision and Tunnel Crack Prevention
  • REST API
    • Partner API
  • Sample applications
    • Unified VPN SDK demo for Windows
    • Hydra VPN SDK demo for iOS
    • IPSEC VPN SDK demo for iOS
    • Unified VPN SDK demo for Android
    • Hydra VPN SDK demo for OpenWRT
    • OpenVPN configuration file
  • Resources
    • Use cases
      • Public VPN
      • Business VPN
        • Creating a Business VPN Project
        • Wi-Fi Security for Business
      • Application anti-blocking
    • How-to
      • Create a Firebase project for User Authentication
      • AWS CloudFront Distribution of the Platform URL
      • How can I get Shared Secret key from iTunes Connect for In-App Purchase
  • FAQ
    • General
      • VPN Platform Flow
      • What data is collected by the Platform?
      • What analytic data is collected by your SDK?
      • How the Platform restricts access to our data?
      • Why DNS Leak tests often indicate positive result?
      • Do we need to perform endpoint health checks?
      • How is the VPN exit node found?
      • How are streams re-marked if VPN is enabled/disabled on an active flow?
      • Is there a maximum number of supported devices?
      • Are both IPv4 and IPv6 supported?
      • What is the MTU of the tunnel?
      • Are any redundancy measures in terms of reliability provided?
      • Is there any load balancing?
      • Do you block broadcast and multicast to/from the VPN?
    • List of Open Source libs
Powered by GitBook
On this page
  • Customize the SDK internal logic
  • Possible dependencies overrides
  • Custom logger
  • Custom backend URL rotator
  • Custom notification builder

Was this helpful?

  1. SDK
  2. Unified VPN SDK for Android
  3. Features

Custom sdk dependencies

Customize the SDK internal logic

  1. Create a Configuration File. Define a raw resource file named sdk_deps.json to specify custom dependencies. General structure of dependencies config may look like:

{
  "dependency 1 key": {
    "type": "class 1 name for dependency to use"
  },
  "dependency 2 key": {
    "type": "class 2 name for dependency to use"
  }
}
  1. Set up metadata in AndroidManifest.xml. Add the following code to the <application> section of your AndroidManifest.xml to link the configuration file:

<meta-data
         android:name="unified.vpn.sdk.deps"
         android:resource="@raw/sdk_deps"/>
  1. Configure ProGuard. Make sure that your custom dependency classes are not renamed or removed by ProGuard or other code obfuscation tools.

Possible dependencies overrides

You can override various SDK dependencies by creating custom classes and specifying them in the sdk_deps.json file. Below is an example of overriding the SDK's logging functionality.

Custom logger

  1. Define a class that extends unified.vpn.sdk.UnifiedLogDelegate. This class will handle logging for the SDK:

@Keep
public class CustomLogger extends UnifiedLogDelegate {
    @Override
    public void log(final int priority, Throwable throwable, String tag, String format, Object... args) {

    }

    @Override
    public void setLogLevel(final int logLevel) {

    }
}

Configure the SDK to Use the Custom Logger: Add the following entry in your sdk_deps.json file to specify the custom logger class:

{
    "logger": {
        "type": "com.sdk.sample.CustomLogger"
    }
}

Additional configuration of OkHttpClient used in sdk

  1. Define class that implements OkHttpNetworkLayer.HttpClientConfigurer

@Keep
public class SampleOkHttpConfigurer implements OkHttpNetworkLayer.HttpClientConfigurer {
    @Override
    public void configure(@NonNull final OkHttpClient.Builder builder) {
        //perform custom configuration of OkHttpClient.Builder
    }
}
  1. Setup SDK dependency override in sdk_deps

 {
     "okHttpConfigurer": {
        "type": "com.sdk.sample.SampleOkHttpConfigurer"
     }
 }

Custom backend URL rotator

  1. Create a Custom URL Rotator: Define a class that implements the UrlRotator interface. This class controls the behavior for rotating backend.

public class SampleUrlRotator implements UrlRotator {
    @Override
    public void failure(String httpUrl, PartnerRequestException error) {
        //mark url as failed
    }

    @Override
    public void success(String httpUrl) {
        //mark url as success
    }

    @Override
    public String provide() {
        // return url for backend calls
        return null;
    }

    @Override
    public int size() {
        // return number of possible urls for rotation
        return 1;
    }
}
  1. Create a URL Rotator Factory: Define a class that implements the UrlRotatorFactory interface, which creates instances of your custom UrlRotator

@Keep
public class SampleUrlRotatorFactory implements UrlRotatorFactory {
    @Override
    public BackendUrlRotator create(Context context, ClientInfo clientInfo) {
        return new SampleUrlRotator();
    }
}
  1. Configure the SDK to Use the Custom URL Rotator: Update the sdk_deps.json file to specify the custom URL rotator factory.

 {
     "urlRotator": {
        "type": "com.sdk.sample.SampleUrlRotatorFactory"
     }
 }

Custom notification builder

You can customize how notifications are displayed by defining your own notification builder. Follow these steps to set up a custom notification delegate:

  1. Create a Custom Notification Delegate Class: Define a class that implements the NotificationDelegate interface. This class controls the appearance and behavior of notifications related to VPN activity.

@Keep
public class SampleNotificationDelegate implements NotificationDelegate {
    @Nullable
    @Override
    public Notification create(
            @NonNull Context context, 
            @Nullable SdkNotificationConfig config, 
            @NonNull VpnState state, 
            long trafficRx, 
            long trafficTx, 
            long speedRx, 
            long speedTx, 
            @Nullable NotificationDelegate fallback
    ) {
        return null;
    }
}
  1. Configure the SDK to Use the Custom Notification Delegate: Update the sdk_deps.json file to specify your custom notification delegate class.

 {
     "notificationDelegate": {
        "type": "com.sdk.sample.SampleNotificationDelegate"
     }
 }
PreviousLocation profile (Hydra only)NextDeferred VPN Service Initialization

Last updated 5 months ago

Was this helpful?