Package org.apache.juneau.secret.macos.keychain

Class KeychainSecretStoreProvider

java.lang.Object

org.apache.juneau.secret.macos.keychain.KeychainSecretStoreProvider

All Implemented Interfaces:

SecretStoreProvider

public class KeychainSecretStoreProvider
extends Object
implements SecretStoreProvider

Provider that contributes a KeychainSecretStore via ServiceLoader, discoverable through SecretStores.fromServiceLoader() when this module is on the classpath and the host is macOS.

The service name defaults to "org.apache.juneau" but can be overridden via the "juneau.secret.macos.keychain.service" system property; the fail mode defaults to FailMode.FAIL_CLOSED. On a non-macOS host (or when the keychain CLI is absent) create() returns null so discovery skips it.

Since:

10.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SERVICE	Default keychain service name when SERVICE_PROPERTY is unset.
static final String	SERVICE_PROPERTY	System property overriding the keychain service name used by the discovered store.

Constructor Summary

Constructors

Constructor	Description
KeychainSecretStoreProvider()

Method Summary

Modifier and Type	Method	Description
SecretStore	create()	Creates a secret store.
int	order()	Sort key used by ServiceLoader wiring.

Methods inherited from class java.lang.Object

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

Field Details

SERVICE_PROPERTY

public static final String SERVICE_PROPERTY

System property overriding the keychain service name used by the discovered store.

See Also:

• Constant Field Values

DEFAULT_SERVICE

public static final String DEFAULT_SERVICE

Default keychain service name when SERVICE_PROPERTY is unset.

See Also:

• Constant Field Values

Constructor Details

KeychainSecretStoreProvider

public KeychainSecretStoreProvider()

Method Details

create

public SecretStore create()

Description copied from interface: SecretStoreProvider

Creates a secret store.

Specified by:

create in interface SecretStoreProvider

Returns:

The secret store, or null to skip registration.

order

public int order()

Description copied from interface: SecretStoreProvider

Sort key used by ServiceLoader wiring.

Lower values sort first.

Specified by:

order in interface SecretStoreProvider

Returns:

The order value.