Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/net/VpnProfileState#constants) \| [Inherited Constants](https://developer.android.com/reference/android/net/VpnProfileState#inhconstants) \| [Fields](https://developer.android.com/reference/android/net/VpnProfileState#lfields) \| [Ctors](https://developer.android.com/reference/android/net/VpnProfileState#pubctors) \| [Methods](https://developer.android.com/reference/android/net/VpnProfileState#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/VpnProfileState#inhmethods)

# VpnProfileState

*** ** * ** ***

` public final class VpnProfileState `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.VpnProfileState |

<br />

*** ** * ** ***

Describe the state of VPN.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTED` The VPN was established successfully. |
| `int` | `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTING` The VPN is attempting to connect, potentially after a failure. |
| `int` | `https://developer.android.com/reference/android/net/VpnProfileState#STATE_DISCONNECTED` The VPN has not been started, or some other VPN is active. |
| `int` | `https://developer.android.com/reference/android/net/VpnProfileState#STATE_FAILED` A non-recoverable error has occurred, and will not be retried. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/net/VpnProfileState>` | `https://developer.android.com/reference/android/net/VpnProfileState#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/net/VpnProfileState#VpnProfileState(int,%20java.lang.String,%20boolean,%20boolean)(int state, https://developer.android.com/reference/java/lang/String sessionKey, boolean alwaysOn, boolean lockdown) ` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/VpnProfileState#describeContents()() ` Implement the Parcelable interface |
| ` boolean` | ` https://developer.android.com/reference/android/net/VpnProfileState#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/VpnProfileState#getSessionId()() ` Retrieves the Session Key The session key is an ephemeral key uniquely identifying the session for a Platform VPN. |
| ` int` | ` https://developer.android.com/reference/android/net/VpnProfileState#getState()() ` Returns the state of the Platform VPN This state represents the internal connection state of the VPN. |
| ` int` | ` https://developer.android.com/reference/android/net/VpnProfileState#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/net/VpnProfileState#isAlwaysOn()() ` Returns the always-on status of the PlatformVpnProfile. |
| ` boolean` | ` https://developer.android.com/reference/android/net/VpnProfileState#isLockdownEnabled()() ` Returns the lockdown mode status of the PlatformVpnProfile. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/VpnProfileState#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/net/VpnProfileState#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel out, int flags) ` Implement the Parcelable interface |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### STATE_CONNECTED

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_CONNECTED
```

The VPN was established successfully.

<br />

Constant Value: 2 (0x00000002)

### STATE_CONNECTING

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_CONNECTING
```

The VPN is attempting to connect, potentially after a failure.

<br />

Constant Value: 1 (0x00000001)

### STATE_DISCONNECTED

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_DISCONNECTED
```

The VPN has not been started, or some other VPN is active.

<br />

Constant Value: 0 (0x00000000)

### STATE_FAILED

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_FAILED
```

A non-recoverable error has occurred, and will not be retried.

<br />

Constant Value: 3 (0x00000003)

## Fields

### CREATOR

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<VpnProfileState> CREATOR
```

<br />

<br />

## Public constructors

### VpnProfileState

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public VpnProfileState (int state, 
                String sessionKey, 
                boolean alwaysOn, 
                boolean lockdown)
```

<br />

<br />

| Parameters ||
|---|---|
| `state` | `int`: Value is one of the following: - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTED` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTING` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_DISCONNECTED` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_FAILED` |
| `sessionKey` | `String`: This value may be `null`. <br /> |
| `alwaysOn` | `boolean` <br /> |
| `lockdown` | `boolean` <br /> |

## Public methods

### describeContents

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Implement the Parcelable interface

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

An equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getSessionId

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getSessionId ()
```

Retrieves the Session Key

The session key is an ephemeral key uniquely identifying the session for a Platform VPN. The lifetime of this key is tied to the lifetime of the VPN session. In other words, reprovisioning of the VPN profile, restarting of the device, or manually restarting the platform VPN session will result in a new VPN session, and a new key.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the unique key for the platform VPN session, or null if it is not running. <br /> |

### getState

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getState ()
```

Returns the state of the Platform VPN

This state represents the internal connection state of the VPN. This state may diverge from the VPN Network's state during error and recovery handling.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTED` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_CONNECTING` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_DISCONNECTED` - `https://developer.android.com/reference/android/net/VpnProfileState#STATE_FAILED` |

### hashCode

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/java/util/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 `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isAlwaysOn

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isAlwaysOn ()
```

Returns the always-on status of the PlatformVpnProfile.

If the PlatformVpnProfile is set to be running in always-on mode, the system will ensure that the profile is always started, and restarting it when necessary (e.g. after reboot).

Always-on can be set by an appropriately privileged user via the Settings VPN menus, or by the Device Policy Manager app programmatically. See DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### isLockdownEnabled

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isLockdownEnabled ()
```

Returns the lockdown mode status of the PlatformVpnProfile.

In lockdown mode, the system will ensure that apps are not allowed to bypass the VPN, including during startup or failure of the VPN.

Lockdown mode can be set by an appropriately privileged user via the Settings VPN menus, or by the Device Policy Manager app programmatically. See DevicePolicyManager#setAlwaysOnVpnPackage(ComponentName, String, boolean, Set)

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### toString

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel out, 
                int flags)
```

Implement the Parcelable interface

<br />

| Parameters ||
|---|---|
| `out` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |