# Print output for @column tags ?>
public
static
final
class
TransportModeChildSessionParams.Builder
extends Object
| java.lang.Object | |
| ↳ | android.net.ipsec.ike.TransportModeChildSessionParams.Builder |
This class can be used to incrementally construct a TransportModeChildSessionParams.
Public constructors | |
|---|---|
Builder()
Create a Builder for negotiating a transport mode Child Session. |
|
Builder(TransportModeChildSessionParams childParams)
Construct Builder from the |
|
Public methods | |
|---|---|
TransportModeChildSessionParams.Builder
|
addChildSaProposal(ChildSaProposal proposal)
Adds a Child SA proposal to the |
TransportModeChildSessionParams.Builder
|
addInboundTrafficSelectors(IkeTrafficSelector trafficSelector)
Adds an inbound |
TransportModeChildSessionParams.Builder
|
addOutboundTrafficSelectors(IkeTrafficSelector trafficSelector)
Adds an outbound |
TransportModeChildSessionParams
|
build()
Validates and builds the |
TransportModeChildSessionParams.Builder
|
setLifetimeSeconds(int hardLifetimeSeconds, int softLifetimeSeconds)
Sets hard and soft lifetimes. |
Inherited methods | |
|---|---|
public Builder ()
Create a Builder for negotiating a transport mode Child Session.
public Builder (TransportModeChildSessionParams childParams)
Construct Builder from the TransportModeChildSessionParams object.
| Parameters | |
|---|---|
childParams |
TransportModeChildSessionParams: the object this Builder will be constructed with.
This value cannot be null. |
public TransportModeChildSessionParams.Builder addChildSaProposal (ChildSaProposal proposal)
Adds a Child SA proposal to the TransportModeChildSessionParams being built.
| Parameters | |
|---|---|
proposal |
ChildSaProposal: Child SA proposal.
This value cannot be null. |
| Returns | |
|---|---|
TransportModeChildSessionParams.Builder |
Builder this, to facilitate chaining.
This value cannot be null. |
public TransportModeChildSessionParams.Builder addInboundTrafficSelectors (IkeTrafficSelector trafficSelector)
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. |
| Returns | |
|---|---|
TransportModeChildSessionParams.Builder |
Builder this, to facilitate chaining.
This value cannot be null. |
public TransportModeChildSessionParams.Builder addOutboundTrafficSelectors (IkeTrafficSelector trafficSelector)
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. |
| Returns | |
|---|---|
TransportModeChildSessionParams.Builder |
Builder this, to facilitate chaining.
This value cannot be null. |
public TransportModeChildSessionParams build ()
Validates and builds the TransportModeChildSessionParams.
| Returns | |
|---|---|
TransportModeChildSessionParams |
the validated TransportModeChildSessionParams.
This value cannot be null. |
public TransportModeChildSessionParams.Builder setLifetimeSeconds (int hardLifetimeSeconds, int softLifetimeSeconds)
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 |
| Returns | |
|---|---|
TransportModeChildSessionParams.Builder |
This value cannot be null. |