Ikev2VpnProfile
public
final
class
Ikev2VpnProfile
extends PlatformVpnProfile
| java.lang.Object | ||
| ↳ | android.net.PlatformVpnProfile | |
| ↳ | android.net.Ikev2VpnProfile | |
The Ikev2VpnProfile is a configuration for the platform setup of IKEv2/IPsec VPNs.
Together with VpnManager, this allows apps to provision IKEv2/IPsec VPNs that do not require the VPN app to constantly run in the background.
Summary
Nested classes | |
|---|---|
class |
Ikev2VpnProfile.Builder
A incremental builder for IKEv2 VPN profiles |
Inherited constants |
|---|
Public methods | |
|---|---|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
List<String>
|
getAllowedAlgorithms()
Returns all the algorithms allowed by this VPN profile. |
int
|
getMaxMtu()
Retrieves the maximum MTU set for this VPN profile. |
String
|
getPassword()
Retrieves the password. |
byte[]
|
getPresharedKey()
Retrieves the pre-shared key. |
ProxyInfo
|
getProxyInfo()
Retrieves the proxy information if any was set |
PrivateKey
|
getRsaPrivateKey()
Retrieves the RSA private key. |
String
|
getServerAddr()
Retrieves the server address string. |
X509Certificate
|
getServerRootCaCert()
Retrieves the certificate for the server's root CA. |
X509Certificate
|
getUserCert()
Retrieves the user certificate, if any was set. |
String
|
getUserIdentity()
Retrieves the user identity. |
String
|
getUsername()
Retrieves the username. |
int
|
hashCode()
Returns a hash code value for the object. |
boolean
|
isBypassable()
Returns whether or not the VPN profile should be bypassable. |
boolean
|
isMetered()
Returns whether or not the VPN profile should be always considered metered. |
Inherited methods | |
|---|---|
Public methods
equals
public boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
obj |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAllowedAlgorithms
public List<String> getAllowedAlgorithms ()
Returns all the algorithms allowed by this VPN profile.
| Returns | |
|---|---|
List<String> |
This value cannot be null. |
getMaxMtu
public int getMaxMtu ()
Retrieves the maximum MTU set for this VPN profile.
| Returns | |
|---|---|
int |
|
getPassword
public String getPassword ()
Retrieves the password.
May be null if the profile is not using Username/Password authentication
| Returns | |
|---|---|
String |
|
getPresharedKey
public byte[] getPresharedKey ()
Retrieves the pre-shared key.
May be null if the profile is not using Pre-shared key authentication.
| Returns | |
|---|---|
byte[] |
|
getProxyInfo
public ProxyInfo getProxyInfo ()
Retrieves the proxy information if any was set
| Returns | |
|---|---|
ProxyInfo |
This value may be null. |
getRsaPrivateKey
public PrivateKey getRsaPrivateKey ()
Retrieves the RSA private key.
May be null if the profile is not using RSA Digital Signature authentication
| Returns | |
|---|---|
PrivateKey |
|
getServerAddr
public String getServerAddr ()
Retrieves the server address string.
| Returns | |
|---|---|
String |
This value cannot be null. |
getServerRootCaCert
public X509Certificate getServerRootCaCert ()
Retrieves the certificate for the server's root CA.
May be null if the profile is not using RSA Digital Signature Authentication or Username/Password authentication
| Returns | |
|---|---|
X509Certificate |
|
getUserCert
public X509Certificate getUserCert ()
Retrieves the user certificate, if any was set.
| Returns | |
|---|---|
X509Certificate |
This value may be null. |
getUserIdentity
public String getUserIdentity ()
Retrieves the user identity.
| Returns | |
|---|---|
String |
This value cannot be null. |
getUsername
public String getUsername ()
Retrieves the username.
May be null if the profile is not using Username/Password authentication
| Returns | |
|---|---|
String |
|
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals(java.lang.Object)method, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
isBypassable
public boolean isBypassable ()
Returns whether or not the VPN profile should be bypassable.
| Returns | |
|---|---|
boolean |
|
isMetered
public boolean isMetered ()
Returns whether or not the VPN profile should be always considered metered.
| Returns | |
|---|---|
boolean |
|
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-06-10 UTC.

