IkeSessionConfiguration

Kotlin |Java

class IkeSessionConfiguration

kotlin.Any
↳	android.net.ipsec.ike.IkeSessionConfiguration

IkeSessionConfiguration represents the negotiated configuration for a IkeSession.

Configurations include remote application version and enabled IKE extensions.

Summary

Nested classes
	`Builder` This class can be used to incrementally construct a `IkeSessionConfiguration`.

Constants
static Int	`EXTENSION_TYPE_FRAGMENTATION` IKE Message Fragmentation
static Int	`EXTENSION_TYPE_MOBIKE` IKEv2 Mobility and Multihoming Protocol

Public methods
EapInfo?	`getEapInfo()` Retrieves the EAP information.
IkeSessionConnectionInfo	`getIkeSessionConnectionInfo()` Returns the connection information.
String	`getRemoteApplicationVersion()` Gets remote (server) version information.
MutableList<ByteArray!>	`getRemoteVendorIds()` Returns remote vendor IDs received during IKE Session setup.
Boolean	`isIkeExtensionEnabled(extensionType: Int)` Checks if an IKE extension is enabled.

Constants

EXTENSION_TYPE_FRAGMENTATION

Added in API level 31

static val EXTENSION_TYPE_FRAGMENTATION: Int

IKE Message Fragmentation

Value: 1

EXTENSION_TYPE_MOBIKE

Added in API level 31

static val EXTENSION_TYPE_MOBIKE: Int

IKEv2 Mobility and Multihoming Protocol

Value: 2

Public methods

getEapInfo

Added in API level 33

fun getEapInfo(): EapInfo?

Retrieves the EAP information.

Return
`EapInfo?`	the EAP information provided by the server during EAP authentication (e.g. next re-authentication ID), or null if the server did not provide any information that will be useful after the authentication.

getIkeSessionConnectionInfo

Added in API level 31

fun getIkeSessionConnectionInfo(): IkeSessionConnectionInfo

Returns the connection information.

Return
`IkeSessionConnectionInfo`	the IKE Session connection information. This value cannot be `null`.

getRemoteApplicationVersion

Added in API level 31

fun getRemoteApplicationVersion(): String

Gets remote (server) version information.

Return
`String`	application version of the remote server, or an empty string if the remote server did not provide the application version. This value cannot be `null`.

getRemoteVendorIds

Added in API level 31

fun getRemoteVendorIds(): MutableList<ByteArray!>

Returns remote vendor IDs received during IKE Session setup.

According to the IKEv2 specification (RFC 7296), a vendor ID may indicate the sender is capable of accepting certain extensions to the protocol, or it may simply identify the implementation as an aid in debugging.

Return
`MutableList<ByteArray!>`	the vendor IDs of the remote server, or an empty list if no vendor ID is received during IKE Session setup. This value cannot be `null`.

isIkeExtensionEnabled

Added in API level 31

fun isIkeExtensionEnabled(extensionType: Int): Boolean

Checks if an IKE extension is enabled.

An IKE extension is enabled when both sides can support it. This negotiation always happens in IKE initial exchanges (IKE INIT and IKE AUTH).

Parameters
`extensionType`	Int: the extension type. Value is `android.net.ipsec.ike.IkeSessionConfiguration#EXTENSION_TYPE_FRAGMENTATION`, or `android.net.ipsec.ike.IkeSessionConfiguration#EXTENSION_TYPE_MOBIKE`

Return
`Boolean`	`true` if this extension is enabled.