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

# InvalidKeException

*** ** * ** ***


`
public

final

class
InvalidKeException
`


`


`

`


`

`


`

`


`

`

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


`

`


`

|---|---|---|---|---|---|
| [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](https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException) ||
|   |   |   |   | ↳ | android.net.ipsec.ike.exceptions.InvalidKeException |

<br />

*** ** * ** ***

This exception is thrown when the remote server expected a different Diffie-Hellman group.

This exception indicates that the remote server received a different KE payload in the Child
creation request from accepted Diffie-Hellman group. Callers can retry Child creation by
proposing the expected DH group included in this exception.
**See also:**

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

## Summary

| ### Inherited constants |
|---|
| From class `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException` |---|---| | `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 constructors ||
|---|---|
| ` https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidKeException#InvalidKeException(int)(int dhGroup) ` Construct an instance of InvalidKeException. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/net/ipsec/ike/exceptions/InvalidKeException#getDhGroup()() ` Return the expected DH Group included in this exception. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException ` |---|---| | ` 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. | ||
| 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*. | ||

## Public constructors

### InvalidKeException

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

```
public InvalidKeException (int dhGroup)
```

Construct an instance of InvalidKeException.

Except for testing, IKE library users normally do not instantiate this object themselves
but instead get a reference via `https://developer.android.com/reference/android/net/ipsec/ike/IkeSessionCallback` or `https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionCallback`.

<br />

| Parameters ||
|---|---|
| `dhGroup` | `int`: the expected DH group <br /> |

## Public methods

### getDhGroup

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

```
public int getDhGroup ()
```

Return the expected DH Group included in this exception.

<br />

| Returns ||
|---|---|
| `int` | the expected DH Group. <br /> |