# Print output for @column tags ?> ChildSessionParams - Android SDK | Android Developers

Most visited

Recently visited

ChildSessionParams

public abstract class ChildSessionParams
extends Object

java.lang.Object
   ↳ android.net.ipsec.ike.ChildSessionParams


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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

List<ChildSaProposal> getChildSaProposals()

Retrieves all ChildSaProposals configured

int getHardLifetimeSeconds()

Retrieves hard lifetime in seconds

List<IkeTrafficSelector> getInboundTrafficSelectors()

Retrieves configured inbound traffic selectors

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

List<IkeTrafficSelector> getOutboundTrafficSelectors()

Retrieves configured outbound traffic selectors

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

int getSoftLifetimeSeconds()

Retrieves soft lifetime in seconds

int hashCode()

Returns a hash code value for the object.

Inherited methods

Public methods

equals

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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

public List<ChildSaProposal> getChildSaProposals ()

Retrieves all ChildSaProposals configured

Returns
List<ChildSaProposal> This value cannot be null.

getHardLifetimeSeconds

public int getHardLifetimeSeconds ()

Retrieves hard lifetime in seconds

Returns
int Value is between CHILD_HARD_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive

getInboundTrafficSelectors

public List<IkeTrafficSelector> getInboundTrafficSelectors ()

Retrieves configured inbound traffic selectors

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

Returns
List<IkeTrafficSelector> This value cannot be null.

getOutboundTrafficSelectors

public List<IkeTrafficSelector> getOutboundTrafficSelectors ()

Retrieves configured outbound traffic selectors

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

Returns
List<IkeTrafficSelector> This value cannot be null.

getSoftLifetimeSeconds

public int getSoftLifetimeSeconds ()

Retrieves soft lifetime in seconds

Returns
int Value is between CHILD_SOFT_LIFETIME_SEC_MINIMUM and CHILD_HARD_LIFETIME_SEC_MAXIMUM inclusive

hashCode

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 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 equals(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 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.