InvalidKeException

Kotlin |Java

public final class InvalidKeException
extends IkeProtocolException

java.lang.Object
↳	java.lang.Throwable
	↳	java.lang.Exception
		↳	android.net.ipsec.ike.exceptions.IkeException
			↳	android.net.ipsec.ike.exceptions.IkeProtocolException
				↳	android.net.ipsec.ike.exceptions.InvalidKeException

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)

Summary

Inherited constants

From class android.net.ipsec.ike.exceptions.IkeProtocolException

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

Public constructors
`InvalidKeException(int dhGroup)` Construct an instance of InvalidKeException.

Public methods
`int`	`getDhGroup()` Return the expected DH Group included in this exception.

Inherited methods

From class


        
          android.net.ipsec.ike.exceptions.IkeProtocolException

int


      getErrorType()

Returns the IKE protocol error type of this IkeProtocolException instance.

From class


        
          java.lang.Throwable

`final void`	`addSuppressed(Throwable exception)` Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
`Throwable`	`fillInStackTrace()` Fills in the execution stack trace.
`Throwable`	`getCause()` Returns the cause of this throwable or `null` if the cause is nonexistent or unknown.
`String`	`getLocalizedMessage()` Creates a localized description of this throwable.
`String`	`getMessage()` Returns the detail message string of this throwable.
`StackTraceElement[]`	`getStackTrace()` Provides programmatic access to the stack trace information printed by `printStackTrace()`.
`final 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.
`Throwable`	`initCause(Throwable cause)` Initializes the cause of this throwable to the specified value.
`void`	`printStackTrace()` Prints this throwable and its backtrace to the standard error stream.
`void`	`printStackTrace(PrintWriter s)` Prints this throwable and its backtrace to the specified print writer.
`void`	`printStackTrace(PrintStream s)` Prints this throwable and its backtrace to the specified print stream.
`void`	`setStackTrace(StackTraceElement[] stackTrace)` Sets the stack trace elements that will be returned by `getStackTrace()` and printed by `printStackTrace()` and related methods.
`String`	`toString()` Returns a short description of this throwable.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`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

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 IkeSessionCallback or ChildSessionCallback.

Parameters
`dhGroup`	`int`: the expected DH group

Public methods

getDhGroup

Added in API level 31

public int getDhGroup ()

Return the expected DH Group included in this exception.

Returns
`int`	the expected DH Group.