ChildSessionCallback

See also:

• RFC 7296, Internet Key Exchange Protocol Version 2 (IKEv2)
• RFC 4301, Security Architecture for the Internet Protocol (IKEv2)

onClosed

public abstract void onClosed ()

Called when the Child Session is closed.

This method will be called immediately after onIpSecTransformDeleted(android.net.IpSecTransform, int) for the deleted IPsec SA pair is fired.

When the closure is caused by a local, fatal error, onClosedWithException(android.net.ipsec.ike.exceptions.IkeException) will be fired instead of this method.

onClosedWithException

public void onClosedWithException (IkeException exception)

Called if the Child Session setup failed or Child Session is closed because of a fatal error.

This method will be called immediately after onIpSecTransformDeleted(android.net.IpSecTransform, int) for the deleted IPsec SA pair is fired.

onIpSecTransformCreated

public abstract void onIpSecTransformCreated (IpSecTransform ipSecTransform, 
                int direction)

Called when an IpSecTransform is created by this Child Session.

This method is fired when a Child Session is created or rekeyed.

The IpSecTransform must be applied to relevant sockets or interfaces when this method is called; traffic may otherwise flow over the socket or interface unprotected.

As this method is fired on an executor, there is an inherent race condition during rekeys where traffic may be routed through the old transforms while the remote has switched to using the new set of transforms.

To avoid the initial startup race condition where the transforms have not yet been applied, the onOpened(android.net.ipsec.ike.ChildSessionConfiguration) callback should be used as the authoritative signal that the socket or tunnel is ready, as it is fired after both transforms have had a chance to be applied.

onIpSecTransformDeleted

public abstract void onIpSecTransformDeleted (IpSecTransform ipSecTransform, 
                int direction)

Called when an IpSecTransform is deleted by this Child Session.

This method is fired when a Child Session is closed or a Child Session has deleted old IPsec SA during rekey. When this method is fired due to Child Session closure, it will be followed by onClosed() or onClosedWithException(android.net.ipsec.ike.exceptions.IkeException).

Users SHOULD remove the IpSecTransform from the socket or interface when this method is called. Otherwise the IPsec traffic protected by this IpSecTransform will be discarded.

onOpened

public abstract void onOpened (ChildSessionConfiguration sessionConfiguration)

Called when the Child Session setup succeeds.

This method will be called immediately after onIpSecTransformCreated(android.net.IpSecTransform, int) for the created IPsec SA pair is fired.