OpenVpnService
Package: com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn
Class Methods
setup
void setup(com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn.OpenVpnConfiguration configuration)
throws KSException
This method setups OpenVpnService with OpenVpnConfiguration.
In case when we call this method and VPN is enabled it disables.
Parameters
- configuration
- OpenVpnConfiguration to be set
Throws:
clearConfiguration
void clearConfiguration()
throws KSException
This method removes current OpenVpnConfiguration if it is set up.
Throws:
isConfigurationSetupCompleted
boolean isConfigurationSetupCompleted()
Returns a boolean value which indicates whether OpenVpnConfiguration setup is completed or not.
Return value
boolean value which indicates whether OpenVpnConfiguration setup is completed or not
enableVPN
void enableVPN()
throws KSException
This method enables VPN with set OpenVpnConfiguration.
It also requires system permissions with request dialog in case they have not been obtained yet.
After VPN was enabled it sends broadcast with action "com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn.OpenVpnService.ENABLE_VPN_CONNECTION_BROADCAST_ACTION"
Throws:
disableVPN
void disableVPN()
This method disables OpenVpnConfiguration.
After VPN was enabled it sends broadcast with action "com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn.OpenVpnService.DISABLE_VPN_CONNECTION_BROADCAST_ACTION"
Throws:
isVpnEnabled
boolean isVpnEnabled()
Gets a boolean value which indicates whether VPN is enabled at the moment.
Return value
boolean value which indicates whether VPN is enabled at the moment
setReconnectMode
void setReconnectMode(int reconnectMode)
This method allows to set VPNUReconnectMode value to change OpenVpnService behaviour in case when connection was lost.
Parameters
- reconnectMode
- VPNUReconnectMode value which means one of available reconnection modes
getStatus
com.keepsolid.androidkeepsolidcommon.vpnunlimitesdk.vpn.openvpn.OpenVpnStatus getStatus()
Retrieves current OpenVpnStatus
Return value
OpenVpnStatus
getVpnBuilder
VpnService.Builder getVpnBuilder()
Retrieves android.net.VpnService.Builder, which can help to create a VPN interface.
Return value
android.net.VpnService.Builder
protect
boolean protect(int socket)
Retrieves a boolean value, which indicates whether to protect a socket from VPN connections.
After protecting, data sent through this socket will go directly to the underlying network,
so its traffic will not be forwarded through the VPN.
Return value
true on success.
Properties
OPEN_VPN_STATE_BROADCAST_ACTION
static final java.lang.String OPEN_VPN_STATE_BROADCAST_ACTION
OPEN_VPN_STATE_BROADCAST_STATUS_KEY
static final java.lang.String OPEN_VPN_STATE_BROADCAST_STATUS_KEY
ENABLE_VPN_CONNECTION_BROADCAST_ACTION
static final java.lang.String ENABLE_VPN_CONNECTION_BROADCAST_ACTION
DISABLE_VPN_CONNECTION_BROADCAST_ACTION
static final java.lang.String DISABLE_VPN_CONNECTION_BROADCAST_ACTION
CHECK_SERVICE_CONNECTION_BROADCAST_ACTION
static final java.lang.String CHECK_SERVICE_CONNECTION_BROADCAST_ACTION