PropertiesSecretSource (Configuration as Code Plugin 1775.v810dc950b_514 API)

java.lang.Object
- io.jenkins.plugins.casc.SecretSource
- - io.jenkins.plugins.casc.impl.secrets.PropertiesSecretSource

All Implemented Interfaces:

ExtensionPoint
```
@Extension
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class PropertiesSecretSource
extends SecretSource
```
This SecretSource implementation allows to use a .properties file for providing secrets. The default file path is /run/secrets/secrets.properties, which can be changed via SECRETS_FILE environment variable.

Since:

1.33

Author:

Daniel Estermann

- Nested Class Summary
  - Nested classes/interfaces inherited from interface hudson.ExtensionPoint
    ExtensionPoint.LegacyInstancesAreScopedToHudson
- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String SECRETS_DEFAULT_PATH
  Default path for .properties file
- Constructor Summary
  
  Constructors
  Constructor Description
  
  PropertiesSecretSource()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  void init()
  
  Optional<String> reveal(String secret)
  Reveal the plaintext value of a secret.
  - Methods inherited from class io.jenkins.plugins.casc.SecretSource
    all
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SECRETS_DEFAULT_PATH
```
public static final String SECRETS_DEFAULT_PATH
```
    Default path for .properties file
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertiesSecretSource
```
public PropertiesSecretSource()
```
- Method Detail
  - reveal
```
public Optional<String> reveal(String secret)
```
    Description copied from class: SecretSource
    
    Reveal the plaintext value of a secret.
    Specified by:
    
    reveal in class SecretSource
    
    Parameters:
    
    secret - the variable reference to reveal
    
    Returns:
    
    the secret's value, or Optional.empty() if a recoverable error occurred. (An empty Optional will allow CasC to continue processing the resolver chain.)
    Recoverable errors include:
    
    the secret was not found in the backing store
  - init
```
public void init()
```
    Overrides:
    
    init in class SecretSource