Added in API level 31

Summary: Constants | Methods | Inherited Methods

IkeProtocolException

Kotlin |Java

public abstract class IkeProtocolException
extends IkeException

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

Known direct subclasses

InvalidKeException, InvalidMajorVersionException, InvalidSelectorsException

InvalidKeException	This exception is thrown when the remote server expected a different Diffie-Hellman group.
InvalidMajorVersionException	This exception is thrown when major version of an inbound message is higher than 2.
InvalidSelectorsException	This exception is thrown if the remote server received an IPsec packet with mismatched selectors.

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)

Summary

Constants
`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 methods
`int`	`getErrorType()` Returns the IKE protocol error type of this `IkeProtocolException` instance.

Inherited methods

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.

Constants

ERROR_TYPE_AUTHENTICATION_FAILED

Added in API level 31

public static final int ERROR_TYPE_AUTHENTICATION_FAILED

IKE authentication failed

Constant Value: 24 (0x00000018)

ERROR_TYPE_CHILD_SA_NOT_FOUND

Added in API level 31

public static final int ERROR_TYPE_CHILD_SA_NOT_FOUND

Child SA in the received packet does not exist

Constant Value: 44 (0x0000002c)

ERROR_TYPE_FAILED_CP_REQUIRED

Added in API level 31

public static final int ERROR_TYPE_FAILED_CP_REQUIRED

Configuration Payload required but not found in IKE setup

Constant Value: 37 (0x00000025)

ERROR_TYPE_INTERNAL_ADDRESS_FAILURE

Added in API level 31

public static final int ERROR_TYPE_INTERNAL_ADDRESS_FAILURE

No internal addresses can be assigned

Constant Value: 36 (0x00000024)

ERROR_TYPE_INVALID_IKE_SPI

Added in API level 31

public static final int ERROR_TYPE_INVALID_IKE_SPI

Unrecognized destination IKE SPI

Constant Value: 4 (0x00000004)

ERROR_TYPE_INVALID_KE_PAYLOAD

Added in API level 31

public static final int ERROR_TYPE_INVALID_KE_PAYLOAD

Invalid Key Exchange Payload

Constant Value: 17 (0x00000011)

ERROR_TYPE_INVALID_MAJOR_VERSION

Added in API level 31

public static final int ERROR_TYPE_INVALID_MAJOR_VERSION

Invalid major version

Constant Value: 5 (0x00000005)

ERROR_TYPE_INVALID_MESSAGE_ID

Added in API level 31

public static final int ERROR_TYPE_INVALID_MESSAGE_ID

Invalid message ID

Constant Value: 9 (0x00000009)

ERROR_TYPE_INVALID_SELECTORS

Added in API level 31

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

Constant Value: 39 (0x00000027)

ERROR_TYPE_INVALID_SYNTAX

Added in API level 31

public static final int ERROR_TYPE_INVALID_SYNTAX

Invalid syntax

Constant Value: 7 (0x00000007)

ERROR_TYPE_NO_ADDITIONAL_SAS

Added in API level 31

public static final int ERROR_TYPE_NO_ADDITIONAL_SAS

No additional SAa are acceptable

Constant Value: 35 (0x00000023)

ERROR_TYPE_NO_PROPOSAL_CHOSEN

Added in API level 31

public static final int ERROR_TYPE_NO_PROPOSAL_CHOSEN

No SA Proposal Chosen is acceptable

Constant Value: 14 (0x0000000e)

ERROR_TYPE_SINGLE_PAIR_REQUIRED

Added in API level 31

public static final int ERROR_TYPE_SINGLE_PAIR_REQUIRED

Only Traffic Selectors specifying a single pair of addresses are acceptable

Constant Value: 34 (0x00000022)

ERROR_TYPE_TEMPORARY_FAILURE

Added in API level 31

public static final int ERROR_TYPE_TEMPORARY_FAILURE

Temporary failure

Constant Value: 43 (0x0000002b)

ERROR_TYPE_TS_UNACCEPTABLE

Added in API level 31

public static final int ERROR_TYPE_TS_UNACCEPTABLE

No Traffic Selectors are acceptable

Constant Value: 38 (0x00000026)

ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD

Added in API level 31

public static final int ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD

Unsupported critical payload

Constant Value: 1 (0x00000001)

Public methods

getErrorType

Added in API level 31

public int getErrorType ()

Returns the IKE protocol error type of this IkeProtocolException instance.

Returns

Returns
`int`	the IKE standard protocol error type defined in `IkeProtocolException` or the error code for an unrecognized error type. Value is `ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD`, `ERROR_TYPE_INVALID_IKE_SPI`, `ERROR_TYPE_INVALID_MAJOR_VERSION`, `ERROR_TYPE_INVALID_SYNTAX`, `ERROR_TYPE_INVALID_MESSAGE_ID`, `ERROR_TYPE_NO_PROPOSAL_CHOSEN`, `ERROR_TYPE_INVALID_KE_PAYLOAD`, `ERROR_TYPE_AUTHENTICATION_FAILED`, `ERROR_TYPE_SINGLE_PAIR_REQUIRED`, `ERROR_TYPE_NO_ADDITIONAL_SAS`, `ERROR_TYPE_INTERNAL_ADDRESS_FAILURE`, `ERROR_TYPE_FAILED_CP_REQUIRED`, `ERROR_TYPE_TS_UNACCEPTABLE`, `ERROR_TYPE_INVALID_SELECTORS`, `ERROR_TYPE_TEMPORARY_FAILURE`, or `ERROR_TYPE_CHILD_SA_NOT_FOUND`

int

the IKE standard protocol error type defined in IkeProtocolException or the error code for an unrecognized error type. Value is ERROR_TYPE_UNSUPPORTED_CRITICAL_PAYLOAD, ERROR_TYPE_INVALID_IKE_SPI, ERROR_TYPE_INVALID_MAJOR_VERSION, ERROR_TYPE_INVALID_SYNTAX, ERROR_TYPE_INVALID_MESSAGE_ID, ERROR_TYPE_NO_PROPOSAL_CHOSEN, ERROR_TYPE_INVALID_KE_PAYLOAD, ERROR_TYPE_AUTHENTICATION_FAILED, ERROR_TYPE_SINGLE_PAIR_REQUIRED, ERROR_TYPE_NO_ADDITIONAL_SAS, ERROR_TYPE_INTERNAL_ADDRESS_FAILURE, ERROR_TYPE_FAILED_CP_REQUIRED, ERROR_TYPE_TS_UNACCEPTABLE, ERROR_TYPE_INVALID_SELECTORS, ERROR_TYPE_TEMPORARY_FAILURE, or ERROR_TYPE_CHILD_SA_NOT_FOUND