CapturedUserPasswordContext (IG Aggregated Javadoc 2023.11.1 Documentation)

java.lang.Object
- org.forgerock.services.context.AbstractContext
- - org.forgerock.openig.openam.CapturedUserPasswordContext

All Implemented Interfaces:

Context
```
public class CapturedUserPasswordContext
extends AbstractContext
```
A CapturedUserPasswordContext to store the user's decrypted password.

Field Summary

Fields
Modifier and Type Field Description

static String NAME
Context's name.
- Fields inherited from class org.forgerock.services.context.AbstractContext
  data

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`getRaw()`	The bytes of the decrypted password.
`String`	`getValue()`	Returns the decrypted password as an UTF-8 `String`.
`String`	`getValue(Charset charset)`	Returns a new `String` by decoding the password using the specified charset.

Methods inherited from class org.forgerock.services.context.AbstractContext
as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    Context's name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getRaw
```
public byte[] getRaw()
```
    The bytes of the decrypted password.
    
    Returns:
    
    the bytes of the decrypted password.
  - getValue
```
public String getValue()
```
    Returns the decrypted password as an UTF-8 String.
    
    Returns:
    
    the decrypted password as an UTF-8 String.
  - getValue
```
public String getValue(Charset charset)
```
    Returns a new String by decoding the password using the specified charset.
    
    Parameters:
    
    charset - The charset to be used to decode the bytes.
    
    Returns:
    
    the decrypted password as a String.