PersistenceSettings (msal4j-persistence-extension 1.0.0 API)

java.lang.Object
- com.microsoft.aad.msal4jextensions.PersistenceSettings

```
public class PersistenceSettings
extends Object
```
An immutable class containing persistence settings for MSAL caches in various platforms.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PersistenceSettings.Builder
An builder for PersistenceSettings objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PersistenceSettings.Builder` An builder for `PersistenceSettings` objects.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PersistenceSettings.Builder`	`builder(String cacheFileName, Path cacheDirectoryPath)` Constructs an instance of builder associated with provided cache file.
`Path`	`getCacheDirectoryPath()`
`String`	`getCacheFileName()`
`String`	`getKeychainAccount()`
`String`	`getKeychainService()`
`String`	`getKeyringAttribute1Key()`
`String`	`getKeyringAttribute1Value()`
`String`	`getKeyringAttribute2Key()`
`String`	`getKeyringAttribute2Value()`
`String`	`getKeyringCollection()`
`String`	`getKeyringSchemaName()`
`String`	`getKeyringSecretLabel()`
`int`	`getLockRetryDelayMilliseconds()`
`int`	`getLockRetryNumber()`
`boolean`	`isOnLinuxUseUnprotectedFileAsCacheStorage()`

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

- Method Detail
  - getCacheFileName
```
public String getCacheFileName()
```
    Returns:
    
    The name of the cache file.
  - getCacheDirectoryPath
```
public Path getCacheDirectoryPath()
```
    Returns:
    
    The path of the directory containing the cache file.
  - getKeychainService
```
public String getKeychainService()
```
    Returns:
    
    The mac keychain service.
  - getKeychainAccount
```
public String getKeychainAccount()
```
    Returns:
    
    The mac keychain account.
  - getKeyringCollection
```
public String getKeyringCollection()
```
    Returns:
    
    The linux keyring collection.
  - getKeyringSchemaName
```
public String getKeyringSchemaName()
```
    Returns:
    
    The linux keyring schema.
  - getKeyringSecretLabel
```
public String getKeyringSecretLabel()
```
    Returns:
    
    The linux keyring secret label.
  - getKeyringAttribute1Key
```
public String getKeyringAttribute1Key()
```
    Returns:
    
    Linux keyring additional attribute1 key.
  - getKeyringAttribute1Value
```
public String getKeyringAttribute1Value()
```
    Returns:
    
    Linux keyring additional attribute1 value.
  - getKeyringAttribute2Key
```
public String getKeyringAttribute2Key()
```
    Returns:
    
    Linux keyring additional2 attribute2 key.
  - getKeyringAttribute2Value
```
public String getKeyringAttribute2Value()
```
    Returns:
    
    Linux keyring additional2 attribute2 value.
  - isOnLinuxUseUnprotectedFileAsCacheStorage
```
public boolean isOnLinuxUseUnprotectedFileAsCacheStorage()
```
    Returns:
    
    is UNPROTECTED FILE wil be used as storage on Linux
  - getLockRetryDelayMilliseconds
```
public int getLockRetryDelayMilliseconds()
```
    Returns:
    
    Lock retry delay in milliseconds.
  - getLockRetryNumber
```
public int getLockRetryNumber()
```
    Returns:
    
    Lock retry number.
  - builder
```
public static PersistenceSettings.Builder builder(String cacheFileName,
                                                  Path cacheDirectoryPath)
```
    Constructs an instance of builder associated with provided cache file.
    
    Parameters:
    
    cacheFileName - The name of the cache file to use when reading/writing storage.
    
    cacheDirectoryPath - The path of the directory containing the cache file.
    
    Returns:
    
    The augmented builder

Class PersistenceSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getCacheFileName

getCacheDirectoryPath

getKeychainService

getKeychainAccount

getKeyringCollection

getKeyringSchemaName

getKeyringSecretLabel

getKeyringAttribute1Key

getKeyringAttribute1Value

getKeyringAttribute2Key

getKeyringAttribute2Value

isOnLinuxUseUnprotectedFileAsCacheStorage

getLockRetryDelayMilliseconds

getLockRetryNumber

builder