Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#inhmethods)
# ChildSessionParams
*** ** * ** ***
`
public
abstract
class
ChildSessionParams
`
`
extends https://developer.android.com/reference/java/lang/Object
`
`
`
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.ipsec.ike.ChildSessionParams |
|---|
| Known direct subclasses [TransportModeChildSessionParams](https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams), [TunnelModeChildSessionParams](https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams) |---|---| | [TransportModeChildSessionParams](https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams) | TransportModeChildSessionParams represents proposed configurations for negotiating a transport mode Child Session. | | [TunnelModeChildSessionParams](https://developer.android.com/reference/android/net/ipsec/ike/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 `https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams` and `https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams`
## Summary
| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/java/util/List` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#getChildSaProposals()() ` Retrieves all ChildSaProposals configured |
| ` int` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#getHardLifetimeSeconds()() ` Retrieves hard lifetime in seconds |
| ` https://developer.android.com/reference/java/util/List` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#getInboundTrafficSelectors()() ` Retrieves configured inbound traffic selectors @see `https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` or `https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` |
| ` https://developer.android.com/reference/java/util/List` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#getOutboundTrafficSelectors()() ` Retrieves configured outbound traffic selectors @see `https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` or `https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` |
| ` int` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#getSoftLifetimeSeconds()() ` Retrieves soft lifetime in seconds |
| ` int` | ` https://developer.android.com/reference/android/net/ipsec/ike/ChildSessionParams#hashCode()() ` Returns a hash code value for the object. |
| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
## Public methods
### equals
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean equals (Object o)
```
Indicates whether some other object is "equal to" this one.
The `equals` method implements an equivalence relation
on non-null object references:
- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.
An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.
| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare.
|
| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise.
|
### getChildSaProposals
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getChildSaProposals ()
```
Retrieves all ChildSaProposals configured
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List` | This value cannot be `null`.
|
### getHardLifetimeSeconds
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getHardLifetimeSeconds ()
```
Retrieves hard lifetime in seconds
| Returns ||
|---|---|
| `int` | Value is between `https://developer.android.com/` and `https://developer.android.com/` inclusive
|
### getInboundTrafficSelectors
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getInboundTrafficSelectors ()
```
Retrieves configured inbound traffic selectors
@see `https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` or
`https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams.Builder#addInboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)`
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List` | This value cannot be `null`.
|
### getOutboundTrafficSelectors
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getOutboundTrafficSelectors ()
```
Retrieves configured outbound traffic selectors
@see `https://developer.android.com/reference/android/net/ipsec/ike/TunnelModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)` or
`https://developer.android.com/reference/android/net/ipsec/ike/TransportModeChildSessionParams.Builder#addOutboundTrafficSelectors(android.net.ipsec.ike.IkeTrafficSelector)`
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List` | This value cannot be `null`.
|
### getSoftLifetimeSeconds
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSoftLifetimeSeconds ()
```
Retrieves soft lifetime in seconds
| Returns ||
|---|---|
| `int` | Value is between `https://developer.android.com/` and `https://developer.android.com/` inclusive
|
### hashCode
Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int hashCode ()
```
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.
The general contract of `hashCode` is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns ||
|---|---|
| `int` | a hash code value for this object.
|