Added in API level 31

Builder

class Builder
kotlin.Any
   ↳ android.net.ipsec.ike.TransportModeChildSessionParams.Builder

This class can be used to incrementally construct a TransportModeChildSessionParams.

Summary

Public constructors

Create a Builder for negotiating a transport mode Child Session.

Construct Builder from the TransportModeChildSessionParams object.
Public methods
TransportModeChildSessionParams.Builder

Adds a Child SA proposal to the TransportModeChildSessionParams being built.
TransportModeChildSessionParams.Builder

Adds an inbound IkeTrafficSelector to the TransportModeChildSessionParams being built.
TransportModeChildSessionParams.Builder

Adds an outbound IkeTrafficSelector to the TransportModeChildSessionParams being built.
TransportModeChildSessionParams

Validates and builds the TransportModeChildSessionParams.
TransportModeChildSessionParams.Builder
setLifetimeSeconds(hardLifetimeSeconds: Int, softLifetimeSeconds: Int)

Sets hard and soft lifetimes.

Public constructors

Builder

Added in API level 31
Builder()

Create a Builder for negotiating a transport mode Child Session.

Builder

Added in API level 31
Builder(childParams: TransportModeChildSessionParams)

Construct Builder from the TransportModeChildSessionParams object.

Parameters
childParams TransportModeChildSessionParams: the object this Builder will be constructed with. This value cannot be null.

Public methods

addChildSaProposal

Added in API level 31
fun addChildSaProposal(proposal: ChildSaProposal): TransportModeChildSessionParams.Builder

Adds a Child SA proposal to the TransportModeChildSessionParams being built.

Parameters
proposal ChildSaProposal: Child SA proposal. This value cannot be null.
Return
TransportModeChildSessionParams.Builder Builder this, to facilitate chaining. This value cannot be null.

addInboundTrafficSelectors

Added in API level 31
fun addInboundTrafficSelectors(trafficSelector: IkeTrafficSelector): TransportModeChildSessionParams.Builder

Adds an inbound IkeTrafficSelector to the TransportModeChildSessionParams being built.

This method allows callers to limit the inbound traffic transmitted over the Child Session to the given range. The IKE server may further narrow the range. Callers should refer to ChildSessionConfiguration for the negotiated traffic selectors.

If no inbound IkeTrafficSelector is provided, a default value will be used that covers all IP addresses and ports.

Parameters
trafficSelector IkeTrafficSelector: the inbound IkeTrafficSelector. This value cannot be null.
Return
TransportModeChildSessionParams.Builder Builder this, to facilitate chaining. This value cannot be null.

addOutboundTrafficSelectors

Added in API level 31
fun addOutboundTrafficSelectors(trafficSelector: IkeTrafficSelector): TransportModeChildSessionParams.Builder

Adds an outbound IkeTrafficSelector to the TransportModeChildSessionParams being built.

This method allows callers to limit the outbound traffic transmitted over the Child Session to the given range. The IKE server may further narrow the range. Callers should refer to ChildSessionConfiguration for the negotiated traffic selectors.

If no outbound IkeTrafficSelector is provided, a default value will be used that covers all IP addresses and ports.

Parameters
trafficSelector IkeTrafficSelector: the outbound IkeTrafficSelector. This value cannot be null.
Return
TransportModeChildSessionParams.Builder Builder this, to facilitate chaining. This value cannot be null.

build

Added in API level 31
fun build(): TransportModeChildSessionParams

Validates and builds the TransportModeChildSessionParams.

Return
TransportModeChildSessionParams the validated TransportModeChildSessionParams. This value cannot be null.

setLifetimeSeconds

Added in API level 31
fun setLifetimeSeconds(
    hardLifetimeSeconds: Int, 
    softLifetimeSeconds: Int
): TransportModeChildSessionParams.Builder

Sets hard and soft lifetimes.

Lifetimes will not be negotiated with the remote IKE server.

Parameters
hardLifetimeSeconds Int: number of seconds after which Child SA will expire. Defaults to 7200 seconds (2 hours). Considering IPsec packet lifetime, IKE library requires hard lifetime to be a value from 300 seconds (5 minutes) to 14400 seconds (4 hours), inclusive. Value is between CHILD_HARD_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive
softLifetimeSeconds Int: number of seconds after which Child SA will request rekey. Defaults to 3600 seconds (1 hour). MUST be at least 120 seconds (2 minutes), and at least 60 seconds (1 minute) shorter than the hard lifetime. Value is between CHILD_SOFT_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive
Return
TransportModeChildSessionParams.Builder This value cannot be null.