Credentials (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.security.Credentials

```
public final class Credentials
extends Object
```
An immutable bundle of resolved secret values keyed by name, with an optional expiry.
Values are held as char[] so they can be wiped with clear(). Well-known keys (USERNAME, PASSWORD, ACCESS_KEY, SECRET_KEY, SESSION_TOKEN, TOKEN) let backends agree on names without a rigid type hierarchy; backends may also define their own keys.
toString() prints key names only — never secret values.

See Also:

CredentialsResolver

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Credentials.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Credentials.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_KEY`
`static String`	`PASSWORD`
`static String`	`SECRET_KEY`
`static String`	`SESSION_TOKEN`
`static String`	`TOKEN`
`static String`	`USERNAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Credentials.Builder`	`builder()`
`void`	`clear()` Overwrites all secret values with zeros and empties this bundle.
`boolean`	`contains(String key)`
`Credentials`	`copy()` Returns an independent copy of these credentials.
`String`	`get(String key)` Returns the value for the given key or `null` if it's absent (or this instance was cleared).
`long`	`getExpiresOn()` Returns the time in milliseconds when these credentials expire or zero (0) if no expiry is known.
`Set<String>`	`getKeys()`
`boolean`	`isExpired()`
`boolean`	`isExpired(long skewMilliseconds)` Indicates if these credentials have expired or will expire within the next `skewMilliseconds`.
`static Credentials`	`of(String... keyValuePairs)` Creates credentials from alternating key-value pairs: `Credentials.of(Credentials.USERNAME, "scott", Credentials.PASSWORD, "tiger")`.
`String`	`require(String key)` Returns the value for the given key or throws a `DataException` if it's absent.
`String`	`toString()`

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

- Field Detail
  - USERNAME
```
public static final String USERNAME
```
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    See Also:
    
    Constant Field Values
  - ACCESS_KEY
```
public static final String ACCESS_KEY
```
    See Also:
    
    Constant Field Values
  - SECRET_KEY
```
public static final String SECRET_KEY
```
    See Also:
    
    Constant Field Values
  - SESSION_TOKEN
```
public static final String SESSION_TOKEN
```
    See Also:
    
    Constant Field Values
  - TOKEN
```
public static final String TOKEN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - builder
```
public static Credentials.Builder builder()
```
  - of
```
public static Credentials of(String... keyValuePairs)
```
    Creates credentials from alternating key-value pairs: Credentials.of(Credentials.USERNAME, "scott", Credentials.PASSWORD, "tiger").
  - get
```
public String get(String key)
```
    Returns the value for the given key or null if it's absent (or this instance was cleared).
  - require
```
public String require(String key)
               throws DataException
```
    Returns the value for the given key or throws a DataException if it's absent.
    
    Throws:
    
    DataException
  - contains
```
public boolean contains(String key)
```
  - getKeys
```
public Set<String> getKeys()
```
  - getExpiresOn
```
public long getExpiresOn()
```
    Returns the time in milliseconds when these credentials expire or zero (0) if no expiry is known.
  - isExpired
```
public boolean isExpired(long skewMilliseconds)
```
    Indicates if these credentials have expired or will expire within the next skewMilliseconds. Always returns false when no expiry is known.
  - isExpired
```
public boolean isExpired()
```
  - copy
```
public Credentials copy()
```
    Returns an independent copy of these credentials. Clearing the copy does not affect this instance.
  - clear
```
public void clear()
```
    Overwrites all secret values with zeros and empties this bundle. Subsequent calls to get(String) return null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Credentials

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USERNAME

PASSWORD

ACCESS_KEY

SECRET_KEY

SESSION_TOKEN

TOKEN

Method Detail

builder

of

get

require

contains

getKeys

getExpiresOn

isExpired

isExpired

copy

clear

toString