com.microsoft.aad.msal4jextensions

Class PersistenceSettings.Builder

java.lang.Object

com.microsoft.aad.msal4jextensions.PersistenceSettings.Builder

Enclosing class:

PersistenceSettings

public static class PersistenceSettings.Builder
extends Object

An builder for PersistenceSettings objects.

Method Summary

Modifier and Type	Method and Description
PersistenceSettings	build() Construct an immutable instance of PersistenceSettings.
PersistenceSettings.Builder	setLinuxKeyring(String collection, String schemaName, String secretLabel, String attributeKey1, String attributeValue1, String attributeKey2, String attributeValue2) Augments this builder with Linux KeyRing settings.
PersistenceSettings.Builder	setLinuxUseUnprotectedFileAsCacheStorage(boolean useUnprotectedFileAsCacheStorage) Augments this builder with linux persistence settings to use unprotected file as Cache storage.
PersistenceSettings.Builder	setLockRetry(int delayMilliseconds, int retryNumber) Augments this builder with lock retry settings.
PersistenceSettings.Builder	setMacKeychain(String service, String account) Augments this builder with mac keychain settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setMacKeychain

public PersistenceSettings.Builder setMacKeychain(String service,
                                                  String account)

Augments this builder with mac keychain settings.

Parameters:

service - The mac keychain service.

account - The mac keychain account

Returns:

The augmented builder

setLinuxKeyring

public PersistenceSettings.Builder setLinuxKeyring(String collection,
                                                   String schemaName,
                                                   String secretLabel,
                                                   String attributeKey1,
                                                   String attributeValue1,
                                                   String attributeKey2,
                                                   String attributeValue2)

Augments this builder with Linux KeyRing settings.

Parameters:

collection - A collection aggregates multiple schema. KeyRing defines 2 collections - "default' is a persisted schema and "session" is an in-memory schema that is destroyed on logout.

schemaName - Schema name is a logical container of secrets, similar to a namespace.

secretLabel - A user readable label for the secret.

attributeKey1 - A key for additional attribute1, that will be used to decorate the secret.

attributeValue1 - A value for additional attribute1, that will be used to decorate the secret.

attributeKey2 - A key for additional attribute2, that will be used to decorate the secret.

attributeValue2 - A value for additional attribute2, that will be used to decorate the secret.

Returns:

The augmented builder.

setLinuxUseUnprotectedFileAsCacheStorage

public PersistenceSettings.Builder setLinuxUseUnprotectedFileAsCacheStorage(boolean useUnprotectedFileAsCacheStorage)

Augments this builder with linux persistence settings to use unprotected file as Cache storage. KEY RING as linux storage SHOULD BE USED normally. But if Key Ring is not available, Cache file can be used, BUT it is RESPONSIBILITY OF USER TO PROTECT CACHE FILE, That should be clearly articulated and explained to end user.

Parameters:

useUnprotectedFileAsCacheStorage - boolean value

Returns:

The augmented builder.

setLockRetry

public PersistenceSettings.Builder setLockRetry(int delayMilliseconds,
                                                int retryNumber)

Augments this builder with lock retry settings.

Parameters:

delayMilliseconds - Delay between retries in ms, must be 1 or more. Default value is 100 ms.

retryNumber - Number of retries, must be 1 or more. Default value is 60.

Returns:

The augmented builder.

build

public PersistenceSettings build()

Construct an immutable instance of PersistenceSettings.

Returns:

An immutable instance of PersistenceSettings.