Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#constants) \| [Methods](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#inhmethods)

# IkeProtocolException

*** ** * ** ***


`
public


abstract
class
IkeProtocolException
`


`


`

`


`

`


`

`

extends https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeException


`

`


`

|---|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||||
| ↳ | [java.lang.Throwable](https://developer.android.com/reference/java/lang/Throwable) ||||
|   | ↳ | [java.lang.Exception](https://developer.android.com/reference/java/lang/Exception) |||
|   |   | ↳ | [android.net.ipsec.ike.exceptions.IkeException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeException) ||
|   |   |   | ↳ | android.net.ipsec.ike.exceptions.IkeProtocolException |

|---|
| Known direct subclasses [InvalidKeException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidKeException), [InvalidMajorVersionException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidMajorVersionException), [InvalidSelectorsException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidSelectorsException) |---|---| | [InvalidKeException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidKeException) | This exception is thrown when the remote server expected a different Diffie-Hellman group. | | [InvalidMajorVersionException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidMajorVersionException) | This exception is thrown when major version of an inbound message is higher than 2. | | [InvalidSelectorsException](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidSelectorsException) | This exception is thrown if the remote server received an IPsec packet with mismatched selectors. | |

<br />

*** ** * ** ***

IkeProtocolException is an abstract class that represents the common information for all IKE
protocol errors.

Error types are as defined by RFC 7296.
**See also:**

- [RFC 7296, Internet Key Exchange
  Protocol Version 2 (IKEv2)](https://tools.ietf.org/html/rfc7296#section-3.10.1)

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_AUTHENTICATION_FAILED` IKE authentication failed |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_CHILD_SA_NOT_FOUND` Child SA in the received packet does not exist |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_FAILED_CP_REQUIRED` Configuration Payload required but not found in IKE setup |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INTERNAL_ADDRESS_FAILURE` No internal addresses can be assigned |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_IKE_SPI` Unrecognized destination IKE SPI |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_KE_PAYLOAD` Invalid Key Exchange Payload |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_MAJOR_VERSION` Invalid major version |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_MESSAGE_ID` Invalid message ID |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_SELECTORS` An IPsec Packet was found to have mismatched Traffic Selectors of the IPsec SA on which it was delivered |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_SYNTAX` Invalid syntax |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_NO_ADDITIONAL_SAS` No additional SAa are acceptable |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_NO_PROPOSAL_CHOSEN` No SA Proposal Chosen is acceptable |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_SINGLE_PAIR_REQUIRED` Only Traffic Selectors specifying a single pair of addresses are acceptable |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_TEMPORARY_FAILURE` Temporary failure |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_TS_UNACCEPTABLE` No Traffic Selectors are acceptable |
| `int` | `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD` Unsupported critical payload |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#getErrorType()() ` Returns the IKE protocol error type of this `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException` instance. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Throwable ` |---|---| | ` final void` | ` https://developer.android.com/reference/java/lang/Throwable#addSuppressed(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable exception) ` Appends the specified exception to the exceptions that were suppressed in order to deliver this exception. | | ` https://developer.android.com/reference/java/lang/Throwable` | ` https://developer.android.com/reference/java/lang/Throwable#fillInStackTrace()() ` Fills in the execution stack trace. | | ` https://developer.android.com/reference/java/lang/Throwable` | ` https://developer.android.com/reference/java/lang/Throwable#getCause()() ` Returns the cause of this throwable or `null` if the cause is nonexistent or unknown. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Throwable#getLocalizedMessage()() ` Creates a localized description of this throwable. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Throwable#getMessage()() ` Returns the detail message string of this throwable. | | ` https://developer.android.com/reference/java/lang/StackTraceElement` | ` https://developer.android.com/reference/java/lang/Throwable#getStackTrace()() ` Provides programmatic access to the stack trace information printed by `https://developer.android.com/reference/java/lang/Throwable#printStackTrace()`. | | ` final https://developer.android.com/reference/java/lang/Throwable` | ` https://developer.android.com/reference/java/lang/Throwable#getSuppressed()() ` Returns an array containing all of the exceptions that were suppressed, typically by the `try`-with-resources statement, in order to deliver this exception. | | ` https://developer.android.com/reference/java/lang/Throwable` | ` https://developer.android.com/reference/java/lang/Throwable#initCause(java.lang.Throwable)(https://developer.android.com/reference/java/lang/Throwable cause) ` Initializes the *cause* of this throwable to the specified value. | | ` void` | ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace()() ` Prints this throwable and its backtrace to the standard error stream. | | ` void` | ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintWriter)(https://developer.android.com/reference/java/io/PrintWriter s) ` Prints this throwable and its backtrace to the specified print writer. | | ` void` | ` https://developer.android.com/reference/java/lang/Throwable#printStackTrace(java.io.PrintStream)(https://developer.android.com/reference/java/io/PrintStream s) ` Prints this throwable and its backtrace to the specified print stream. | | ` void` | ` https://developer.android.com/reference/java/lang/Throwable#setStackTrace(java.lang.StackTraceElement[])(https://developer.android.com/reference/java/lang/StackTraceElement stackTrace) ` Sets the stack trace elements that will be returned by `https://developer.android.com/reference/java/lang/Throwable#getStackTrace()` and printed by `https://developer.android.com/reference/java/lang/Throwable#printStackTrace()` and related methods. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Throwable#toString()() ` Returns a short description of this throwable. | ||
| 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*. | ||

## Constants

### ERROR_TYPE_AUTHENTICATION_FAILED

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

```
public static final int ERROR_TYPE_AUTHENTICATION_FAILED
```

IKE authentication failed

<br />

Constant Value:

24
(0x00000018)


### ERROR_TYPE_CHILD_SA_NOT_FOUND

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

```
public static final int ERROR_TYPE_CHILD_SA_NOT_FOUND
```

Child SA in the received packet does not exist

<br />

Constant Value:

44
(0x0000002c)


### ERROR_TYPE_FAILED_CP_REQUIRED

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

```
public static final int ERROR_TYPE_FAILED_CP_REQUIRED
```

Configuration Payload required but not found in IKE setup

<br />

Constant Value:

37
(0x00000025)


### ERROR_TYPE_INTERNAL_ADDRESS_FAILURE

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

```
public static final int ERROR_TYPE_INTERNAL_ADDRESS_FAILURE
```

No internal addresses can be assigned

<br />

Constant Value:

36
(0x00000024)


### ERROR_TYPE_INVALID_IKE_SPI

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

```
public static final int ERROR_TYPE_INVALID_IKE_SPI
```

Unrecognized destination IKE SPI

<br />

Constant Value:

4
(0x00000004)


### ERROR_TYPE_INVALID_KE_PAYLOAD

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

```
public static final int ERROR_TYPE_INVALID_KE_PAYLOAD
```

Invalid Key Exchange Payload

<br />

Constant Value:

17
(0x00000011)


### ERROR_TYPE_INVALID_MAJOR_VERSION

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

```
public static final int ERROR_TYPE_INVALID_MAJOR_VERSION
```

Invalid major version

<br />

Constant Value:

5
(0x00000005)


### ERROR_TYPE_INVALID_MESSAGE_ID

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

```
public static final int ERROR_TYPE_INVALID_MESSAGE_ID
```

Invalid message ID

<br />

Constant Value:

9
(0x00000009)


### ERROR_TYPE_INVALID_SELECTORS

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

```
public static final int ERROR_TYPE_INVALID_SELECTORS
```

An IPsec Packet was found to have mismatched Traffic Selectors of the IPsec SA on which it
was delivered

<br />

Constant Value:

39
(0x00000027)


### ERROR_TYPE_INVALID_SYNTAX

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

```
public static final int ERROR_TYPE_INVALID_SYNTAX
```

Invalid syntax

<br />

Constant Value:

7
(0x00000007)


### ERROR_TYPE_NO_ADDITIONAL_SAS

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

```
public static final int ERROR_TYPE_NO_ADDITIONAL_SAS
```

No additional SAa are acceptable

<br />

Constant Value:

35
(0x00000023)


### ERROR_TYPE_NO_PROPOSAL_CHOSEN

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

```
public static final int ERROR_TYPE_NO_PROPOSAL_CHOSEN
```

No SA Proposal Chosen is acceptable

<br />

Constant Value:

14
(0x0000000e)


### ERROR_TYPE_SINGLE_PAIR_REQUIRED

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

```
public static final int ERROR_TYPE_SINGLE_PAIR_REQUIRED
```

Only Traffic Selectors specifying a single pair of addresses are acceptable

<br />

Constant Value:

34
(0x00000022)


### ERROR_TYPE_TEMPORARY_FAILURE

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

```
public static final int ERROR_TYPE_TEMPORARY_FAILURE
```

Temporary failure

<br />

Constant Value:

43
(0x0000002b)


### ERROR_TYPE_TS_UNACCEPTABLE

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

```
public static final int ERROR_TYPE_TS_UNACCEPTABLE
```

No Traffic Selectors are acceptable

<br />

Constant Value:

38
(0x00000026)


### ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD

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

```
public static final int ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD
```

Unsupported critical payload

<br />

Constant Value:

1
(0x00000001)


## Public methods

### getErrorType

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

```
public int getErrorType ()
```

Returns the IKE protocol error type of this `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException` instance.

<br />

| Returns ||
|---|---|
| `int` | the IKE standard protocol error type defined in `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException` or the error code for an unrecognized error type. Value is one of the following: - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_IKE_SPI` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_MAJOR_VERSION` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_SYNTAX` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_MESSAGE_ID` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_NO_PROPOSAL_CHOSEN` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_KE_PAYLOAD` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_AUTHENTICATION_FAILED` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_SINGLE_PAIR_REQUIRED` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_NO_ADDITIONAL_SAS` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INTERNAL_ADDRESS_FAILURE` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_FAILED_CP_REQUIRED` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_TS_UNACCEPTABLE` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_INVALID_SELECTORS` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_TEMPORARY_FAILURE` - `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException#ERROR_TYPE_CHILD_SA_NOT_FOUND` |