Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/net/IpSecTransform#nestedclasses) \| [Methods](https://developer.android.com/reference/android/net/IpSecTransform#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/net/IpSecTransform#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/IpSecTransform#inhmethods)

# IpSecTransform

*** ** * ** ***


`
public

final

class
IpSecTransform
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/java/lang/AutoCloseable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.IpSecTransform |

<br />

*** ** * ** ***

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

Transforms are created using `https://developer.android.com/reference/android/net/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.
**See also:**

- [RFC 4301, Security Architecture for the
  Internet Protocol](https://tools.ietf.org/html/rfc4301)

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/net/IpSecTransform.Builder` This class is used to build `https://developer.android.com/reference/android/net/IpSecTransform` objects. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/IpSecTransform#close()() ` Deactivate this `IpSecTransform` and free allocated resources. |
| ` boolean` | ` https://developer.android.com/reference/android/net/IpSecTransform#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Standard equals. |
| ` void` | ` https://developer.android.com/reference/android/net/IpSecTransform#requestIpSecTransformState(java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.net.IpSecTransformState,java.lang.RuntimeException>)(https://developer.android.com/reference/java/util/concurrent/Executor executor, https://developer.android.com/reference/android/os/OutcomeReceiver<https://developer.android.com/reference/android/net/IpSecTransformState, https://developer.android.com/reference/java/lang/RuntimeException> callback) ` Retrieve the current state of this IpSecTransform. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/IpSecTransform#toString()() ` Returns a string representation of the object. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/IpSecTransform#finalize()() ` Check that the transform was closed properly. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/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 https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/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` | ` https://developer.android.com/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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/java/lang/AutoCloseable ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/java/lang/AutoCloseable#close()() ` Closes this resource, relinquishing any underlying resources. | ||

## Public methods

### close

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/net/IpSecManager#removeTransportModeTransforms(java.io.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.

<br />

### equals

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object other)
```

Standard equals.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### requestIpSecTransformState

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void requestIpSecTransformState (Executor executor, 
                OutcomeReceiver<IpSecTransformState, RuntimeException> callback)
```

Retrieve the current state of this IpSecTransform.

<br />

| Parameters ||
|---|---|
| `executor` | `Executor`: The `https://developer.android.com/reference/java/util/concurrent/Executor` on which to call the supplied callback. Callback and listener events are dispatched through this `https://developer.android.com/reference/java/util/concurrent/Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `https://developer.android.com/reference/android/content/Context#getMainExecutor()`. Otherwise, provide an `https://developer.android.com/reference/java/util/concurrent/Executor` that dispatches to an appropriate thread. This value cannot be `null`. <br /> |
| `callback` | `OutcomeReceiver`: Callback that's called after the transform state is ready or when an error occurs. This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/IpSecTransformState`

### toString

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

## Protected methods

### finalize

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected void finalize ()
```

Check that the transform was closed properly.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/Throwable` |   |