Stay organized with collections
Save and categorize content based on your preferences.
IpSecManager.SecurityParameterIndex
public
static
final
class
IpSecManager.SecurityParameterIndex
extends Object
implements
AutoCloseable
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 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 |
|---|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object.
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(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
|
wait(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
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
|
|
Public methods
close
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
public int getSpi ()
Get the underlying SPI held by this object.
toString
public String toString ()
Returns a string representation of the object.
| Returns |
|---|
String |
a string representation of the object. |
Protected methods
finalize
protected void finalize ()
Check that the SPI was closed properly.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# IpSecManager.SecurityParameterIndex\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Protected Methods](#promethods) \\| [Inherited Methods](#inhmethods) \n\nIpSecManager.SecurityParameterIndex\n===================================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/net/IpSecManager.SecurityParameterIndex \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\nstatic\nfinal\n\nclass\nIpSecManager.SecurityParameterIndex\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\nimplements\n\n`[AutoCloseable](/reference/java/lang/AutoCloseable)`\n\n\n`\n\n|---|-------------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.net.IpSecManager.SecurityParameterIndex |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThis class represents a reserved SPI.\n\nObjects of this type are used to track reserved security parameter indices. They can be\nobtained by calling [IpSecManager.allocateSecurityParameterIndex](/reference/android/net/IpSecManager#allocateSecurityParameterIndex(java.net.InetAddress)) and must be released\nby calling [close()](/reference/android/net/IpSecManager.SecurityParameterIndex#close()) when they are no longer needed.\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[close](/reference/android/net/IpSecManager.SecurityParameterIndex#close())`() ` Release an SPI that was previously reserved. |\n| ` int` | ` `[getSpi](/reference/android/net/IpSecManager.SecurityParameterIndex#getSpi())`() ` Get the underlying SPI held by this object. |\n| ` `[String](/reference/java/lang/String) | ` `[toString](/reference/android/net/IpSecManager.SecurityParameterIndex#toString())`() ` Returns a string representation of the object. |\n\n| ### Protected methods ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[finalize](/reference/android/net/IpSecManager.SecurityParameterIndex#finalize())`() ` Check that the SPI was closed properly. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n| From interface ` `[java.lang.AutoCloseable](/reference/java/lang/AutoCloseable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` `[close](/reference/java/lang/AutoCloseable#close())`() ` Closes this resource, relinquishing any underlying resources. | ||\n\nPublic methods\n--------------\n\n### close\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void close ()\n```\n\nRelease an SPI that was previously reserved.\n\nRelease an SPI for use by other users in the system. If a SecurityParameterIndex is\napplied to an IpSecTransform, it will become unusable for future transforms but should\nstill be closed to ensure system resources are released.\n\n\u003cbr /\u003e\n\n### getSpi\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic int getSpi ()\n```\n\nGet the underlying SPI held by this object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-------|--------|\n| `int` | \u003cbr /\u003e |\n\n### toString\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic String toString ()\n```\n\nReturns a string representation of the object.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|-----------------------------------------------|\n| [String](/reference/java/lang/String) | a string representation of the object. \u003cbr /\u003e |\n\nProtected methods\n-----------------\n\n### finalize\n\nAdded in [API level 28](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\nprotected void finalize ()\n```\n\nCheck that the SPI was closed properly.\n\n\u003cbr /\u003e\n\n| Throws ||\n|---------------------------------------------|---|\n| [Throwable](/reference/java/lang/Throwable) | |"]]
