ChildSessionParams

Kotlin |Java

abstract class ChildSessionParams

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

Known Direct Subclasses

TransportModeChildSessionParams, TunnelModeChildSessionParams

TransportModeChildSessionParams	TransportModeChildSessionParams represents proposed configurations for negotiating a transport mode Child Session.
TunnelModeChildSessionParams	TunnelModeChildSessionParams represents proposed configurations for negotiating a tunnel mode Child Session.

ChildSessionParams is an abstract class that represents proposed configurations for negotiating a Child Session.

Note that references to negotiated configurations will be held, and the same parameters will be reused during rekey. This includes SA Proposals, lifetimes and traffic selectors.

IKE library will send out KE payload only if user has configured one or more DH groups. The KE payload in a request will use the first DH group from the first user provided SA proposal (or the peer selected SA proposal if it's a rekey request). The KE payload in a response will depend on the SA proposal negotiation result.

When requesting the first Child Session in IKE AUTH, IKE library will not propose any DH group even if user has configured it, as per RFC 7296. When rekeying this child session, IKE library will accept DH groups that are configured in its ChildSessionParams. If after rekeying user needs to have the same DH group as that of the IKE Session, then they need to explicitly set the same DH Group in ChildSessionParams.

@see TunnelModeChildSessionParams and TransportModeChildSessionParams

Summary

Public methods
open Boolean	`equals(other: Any?)`
open MutableList<ChildSaProposal!>	`getChildSaProposals()` Retrieves all ChildSaProposals configured
open Int	`getHardLifetimeSeconds()` Retrieves hard lifetime in seconds
open MutableList<IkeTrafficSelector!>	`getInboundTrafficSelectors()` Retrieves configured inbound traffic selectors
open MutableList<IkeTrafficSelector!>	`getOutboundTrafficSelectors()` Retrieves configured outbound traffic selectors
open Int	`getSoftLifetimeSeconds()` Retrieves soft lifetime in seconds
open Int	`hashCode()`

Public methods

equals

Added in API level 31

open fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getChildSaProposals

Added in API level 31

open fun getChildSaProposals(): MutableList<ChildSaProposal!>

Retrieves all ChildSaProposals configured

Return
`MutableList<ChildSaProposal!>`	This value cannot be `null`.

getHardLifetimeSeconds

Added in API level 31

open fun getHardLifetimeSeconds(): Int

Retrieves hard lifetime in seconds

Return
`Int`	Value is between CHILD_HARD_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive

getInboundTrafficSelectors

Added in API level 31

open fun getInboundTrafficSelectors(): MutableList<IkeTrafficSelector!>

Retrieves configured inbound traffic selectors

@see android.net.ipsec.ike.TunnelModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector) or android.net.ipsec.ike.TransportModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)

Return
`MutableList<IkeTrafficSelector!>`	This value cannot be `null`.

getOutboundTrafficSelectors

Added in API level 31

open fun getOutboundTrafficSelectors(): MutableList<IkeTrafficSelector!>

Retrieves configured outbound traffic selectors

@see android.net.ipsec.ike.TunnelModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector) or android.net.ipsec.ike.TransportModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)

Return
`MutableList<IkeTrafficSelector!>`	This value cannot be `null`.

getSoftLifetimeSeconds

Added in API level 31

open fun getSoftLifetimeSeconds(): Int

Retrieves soft lifetime in seconds

Return
`Int`	Value is between CHILD_SOFT_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive

hashCode

Added in API level 31

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.