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

IpSecManager.SecurityParameterIndex

public static final class IpSecManager.SecurityParameterIndex
extends Object implements AutoCloseable

java.lang.Object
   ↳ android.net.IpSecManager.SecurityParameterIndex


This class represents a reserved SPI.

Objects of this type are used to track reserved security parameter indices. They can be obtained by calling IpSecManager.allocateSecurityParameterIndex(InetAddress) and must be released by calling close() when they are no longer needed.

Summary

Public methods

void close()

Release an SPI that was previously reserved.

int getSpi()

Get the underlying SPI held by this object.

String toString()

Returns a string representation of the object.

Protected methods

void finalize()

Check that the SPI was closed properly.

Inherited methods

Public methods

close

added in API level 28
public void close ()

Release an SPI that was previously reserved.

Release an SPI for use by other users in the system. If a SecurityParameterIndex is applied to an IpSecTransform, it will become unusable for future transforms but should still be closed to ensure system resources are released.

getSpi

added in API level 28
public int getSpi ()

Get the underlying SPI held by this object.

Returns
int

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 SPI was closed properly.

Throws
Throwable