CustomProxyOptions (IG Aggregated Javadoc 2023.11.0 Documentation)

java.lang.Object
- org.forgerock.openig.proxy.CustomProxyOptions

All Implemented Interfaces:

ProxyOptions
```
public final class CustomProxyOptions
extends Object
implements ProxyOptions
```
A ProxyOptions representing custom proxy settings.
The password is managed as a SecretReference, ensuring its value is refreshed as necessary. This avoids breaking the promise chain too early and may unlock further usage up to the ClientHandler (like secret rotation).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CustomProxyOptions.Heaplet
Creates and initializes a CustomProxyOptions in a heap environment.

Constructor Summary

Constructors
Constructor	Description
`CustomProxyOptions(URI uri)`	Create a new `CustomProxyOptions` without login/password.
`CustomProxyOptions(URI uri, String username, SecretReference<GenericSecret> passwordReference)`	Creates a new `CustomProxyOptions` with login/password.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

Promise<Void,NeverThrowsException> configure(Options options)
Configure proxy settings.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CustomProxyOptions
```
public CustomProxyOptions(URI uri)
```
    Create a new CustomProxyOptions without login/password.
    
    Parameters:
    
    uri - the proxy URI
  - CustomProxyOptions
```
public CustomProxyOptions(URI uri,
                          String username,
                          SecretReference<GenericSecret> passwordReference)
```
    Creates a new CustomProxyOptions with login/password.
    
    Parameters:
    
    uri - the proxy URI
    
    username - the username to use to authenticate to the proxy
    
    passwordReference - the password to use to authenticate to the proxy
- Method Detail
  - configure
```
public Promise<Void,NeverThrowsException> configure(Options options)
```
    Description copied from interface: ProxyOptions
    
    Configure proxy settings.
    
    Specified by:
    
    configure in interface ProxyOptions
    
    Parameters:
    
    options - The options to add proxy configuration into.
    
    Returns:
    
    The promise that options have been set.