lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

IpSecTransform

public final class IpSecTransform
extends Object implements AutoCloseable

java.lang.Object
   ↳ android.net.IpSecTransform


This class represents a transform, which roughly corresponds to an IPsec Security Association.

Transforms are created using IpSecTransform.Builder. Each IpSecTransform object encapsulates the properties and state of an IPsec security association. That includes, but is not limited to, algorithm choice, key material, and allocated system resources.

Summary

Nested classes

class IpSecTransform.Builder

This class is used to build IpSecTransform objects. 

Public methods

void close()

Deactivate this IpSecTransform and free allocated resources.

String toString()

Returns a string representation of the object.

Protected methods

void finalize()

Check that the transform was closed properly.

Inherited methods

Public methods

close

added in API level 28
public void close ()

Deactivate this IpSecTransform and free allocated resources.

Deactivating a transform while it is still applied to a socket will result in errors on that socket. Make sure to remove transforms by calling IpSecManager.removeTransportModeTransforms(FileDescriptor). Note, removing an IpSecTransform from a socket will not deactivate it (because one transform may be applied to multiple sockets).

It is safe to call this method on a transform that has already been deactivated.

toString

added in API level 28
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

Protected methods

finalize

added in API level 28
protected void finalize ()

Check that the transform was closed properly.

Throws
Throwable