VPNUConfigurator
This class provides an interface for managing VPN connection.
A basic workflow looks as follows:
1. Call prepare() method to establish connection to VPN Unlimited service or creates a new one.
2. Configure VPN server item using setup(com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.entities.VPNUServer, boolean) method.
3. Add OpenVpnStatusChangedListener for observing connection status.
3. Connect to the configured VPN server using startVpn() method.
4. Disconnect at any time using stopVpn() method.
Before using this class you must authorize or register with the help of KSAuthorizer class.
You must pass the same KSAuthorizer instance to its constructor as you have passed to KSAuthorizer instance constructor.
1. Call prepare() method to establish connection to VPN Unlimited service or creates a new one.
2. Configure VPN server item using setup(com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.entities.VPNUServer, boolean) method.
3. Add OpenVpnStatusChangedListener for observing connection status.
3. Connect to the configured VPN server using startVpn() method.
4. Disconnect at any time using stopVpn() method.
Before using this class you must authorize or register with the help of KSAuthorizer class.
You must pass the same KSAuthorizer instance to its constructor as you have passed to KSAuthorizer instance constructor.
Package: com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.api.managers.vpn
Class Methods
prepare
void prepare()
throws KSException
Prepare to establish a VPN connection.
This method should be called once before using VPNUConfigurator.
It creates VPN Unlimited service or connects to an existing one.
It blocks a calling thread.
This method shouldn't be called from main thread.
Throws:
onFinish
void onFinish()
Shut down connection to VPN Unlimited service.
Note that VPN Unlimited service will be destroyed only in case of disabled VPN.
Should be called on Activity#onDestroy().
Throws:
setup
void setup(VPNUServer server, boolean obfuscate) throws KSException
Installs VPN configuration for the specified server.
This method retrieves VPN configuration from cache in RAM.
If no stored configuration present for the server item, it loads configuration from VPN Unlimited API.
It blocks a calling thread.
This method shouldn't be called from main thread.
Parameters
- server
- A model object which describes a VPN server.
- obfuscate
- sets obfuscate mode (vpn will use port 443) disabled (false) or enabled (true)
Throws:
startVpn
void startVpn()
throws KSException
Sets VPN configuration enabled.
This method blocks a calling thread.
This method shouldn't be called from main thread.
Throws:
stopVpn
void stopVpn()
throws KSException
Sets VPN configuration disabled.
This method blocks a calling thread.
This method shouldn't be called from main thread.
Throws:
onLogout
void onLogout()
This method should be called on user logout action
Shuts down VPNU service.
This method blocks a calling thread.
This method shouldn't be called from main thread.
Throws:
addOnStatusChangedListener
void addOnStatusChangedListener(OpenVpnStatusChangedListener openVpnStatusChangedListener)
Adds VPN connection status observer
Parameters
- openVpnStatusChangedListener
- observer object for VPN connection status events
removeOnStatusChangedListener
void removeOnStatusChangedListener(OpenVpnStatusChangedListener openVpnStatusChangedListener)
Removes VPN connection status observer
Parameters
- openVpnStatusChangedListener
- observer object for VPN connection status events
getVpnStatus
com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn.OpenVpnStatus getVpnStatus()
throws KSException
Gets current VPN connection status
Return value
object of OpenVpnStatus class which represents current VPN connection status
Throws:
getLastConfiguredServer
VPNUServer getLastConfiguredServer()
Gets server object which was used for VPN Unlimited service configuration last time
Return value
A model object which describes a last configured VPN server.
clearLastConfiguration
void clearLastConfiguration()
Clears server and configuration which was used for VPN Unlimited service last time
setVpnReconnectMode
void setVpnReconnectMode(int reconnectMode)
Sets vpn reconnect mode:
0 = Always
1 = on WiFi network
2 = on unprotected Wifi network
3 = reconnect off
4 = reconnect on mobile networks only
Following values can be referenced using VPNUReconnectMode entity class.
Parameters
- reconnectMode
- reconnect mode to set
Properties
STATUS_NOTIFICATION_ACTION
static final java.lang.String STATUS_NOTIFICATION_ACTION
Action of status broadcast
STATUS_KEY
static final java.lang.String STATUS_KEY
Key for status code extra of status broadcast with STATUS_NOTIFICATION_ACTION action.
You can retrieve OpenVpnStatus with following code: int statusCode = intent.getIntExtra(VPNUConfigurator.STATUS_KEY, OpenVpnStatus.STATE_CODE_UNKNOWN); OpenVpnStatus status = new OpenVpnStatus(statusCode);
ON_NOTIFICATION_CLICK_ACTION
static final java.lang.String ON_NOTIFICATION_CLICK_ACTION
Action of broadcast, thrown then user clicks on VPN Unlimited service notification