org.azyva.dragom.execcontext.plugin.impl

Class DefaultCredentialStorePluginImpl

java.lang.Object

org.azyva.dragom.execcontext.plugin.impl.DefaultCredentialStorePluginImpl

All Implemented Interfaces:

org.azyva.dragom.execcontext.plugin.CredentialStorePlugin, org.azyva.dragom.execcontext.plugin.ExecContextPlugin

public class DefaultCredentialStorePluginImpl
extends Object
implements org.azyva.dragom.execcontext.plugin.CredentialStorePlugin

This default implementation of CredentialStorePlugin uses CredentialStore to manage credentials.

The default master password file is that defined by CredentialStore, namely dragom-master-password in the user home directory. If the org.azyva.dragom.MasterKeyFile system property is defined, it specifies the Path of the master password file.

The default credential file is credentials.properties in the workspace metadata directory. If the org.azyva.dragom.CredentialFile is defined, it specifies the Path of the credential file. The default credential file defined by CredentialStore is not used.

This mappings between resource Pattern's and corresponding realms and users are defined using runtime properties defined on the root ClassificationNode:

• RESOURCE_PATTERN_REALM_USER_MAPPINGS: ","-separated list of resource-realm-user mapping names. For each such name, a CredentialStore.ResourcePatternRealmUser is created.
• RESOURCE_PATTERN_REALM_USER_MAPPING_RESOURCE_PATTERN.<name>: Literal value of CredentialStore.ResourcePatternRealmUser.patternResource.
• RESOURCE_PATTERN_REALM_USER_MAPPING_REALM.<name>: Value of CredentialStore.ResourcePatternRealmUser.realm.
• RESOURCE_PATTERN_REALM_USER_MAPPING_USER.<name>: Value of CredentialStore.ResourcePatternRealmUser.user.

If UserInteractionCallbackPlugin.isBatchMode() returns false, this class interacts with the user when appropriate to obtain missing passwords, as recommended in CredentialStorePlugin.

In addition to implementing CredentialStorePlugin, this class publicly provides access to the CredentialStore instance allowing to obtain information about realms and explicitly modify the passwords, operations which are not supported by the interface. This is meant to be used by a tool that would assume this specific implementation of the CredentialStorePlugin to allow the user to manage the credential store. CredentialManagerTool from dragom-cli-tools is such a CLI tool.

Author:

David Raymond

Nested Class Summary

Nested classes/interfaces inherited from interface org.azyva.dragom.execcontext.plugin.CredentialStorePlugin

org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.Credentials, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator

Field Summary

Fields

Modifier and Type	Field and Description
static String	RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_REALM Runtime property prefix for the realm for a given resource-pattern-realm-user mapping.
static String	RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_RESOURCE_PATTERN Runtime property prefix for the resource Pattern for a given resource-pattern-realm-user mapping.
static String	RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_USER Runtime property prefix for the user for a given resource-pattern-realm-user mapping.
static String	RUNTIME_PROPERTY_RESOURCE_PATTERN_REALM_USER_MAPPINGS Runtime property for the list of resource-pattern-realm-user mappings.
static String	SYS_PROPERTY_MASTER_KEY_FILE System property that specifies the master password file.

Constructor Summary

Constructors

Constructor and Description
DefaultCredentialStorePluginImpl(org.azyva.dragom.execcontext.ExecContext execContext) Constructor.

Method Summary

Modifier and Type	Method and Description
org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.Credentials	getCredentials(String resource, String user, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator)
org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.Credentials	getCredentialsInternal(String resource, String user, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator) The code for isCredentialsExist(java.lang.String, java.lang.String, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator) and getCredentials(java.lang.String, java.lang.String, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator) is very similar and is factored out here.
CredentialStore	getCredentialStore()
boolean	isCredentialsExist(String resource, String user, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator)
void	resetCredentials(String resource, String user)

Methods inherited from class java.lang.Object

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

Field Detail

SYS_PROPERTY_MASTER_KEY_FILE

public static final String SYS_PROPERTY_MASTER_KEY_FILE

System property that specifies the master password file. "~" in the value of this property is replaced by the user home directory.

See Also:

Constant Field Values

RUNTIME_PROPERTY_RESOURCE_PATTERN_REALM_USER_MAPPINGS

public static final String RUNTIME_PROPERTY_RESOURCE_PATTERN_REALM_USER_MAPPINGS

Runtime property for the list of resource-pattern-realm-user mappings.

See Also:

Constant Field Values

RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_RESOURCE_PATTERN

public static final String RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_RESOURCE_PATTERN

Runtime property prefix for the resource Pattern for a given resource-pattern-realm-user mapping.

See Also:

Constant Field Values

RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_REALM

public static final String RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_REALM

Runtime property prefix for the realm for a given resource-pattern-realm-user mapping.

See Also:

Constant Field Values

RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_USER

public static final String RUNTIME_PROPERTY_PREFIX_RESOURCE_PATTERN_REALM_USER_MAPPING_USER

Runtime property prefix for the user for a given resource-pattern-realm-user mapping.

See Also:

Constant Field Values

Constructor Detail

DefaultCredentialStorePluginImpl

public DefaultCredentialStorePluginImpl(org.azyva.dragom.execcontext.ExecContext execContext)

Constructor.

Parameters:

execContext - ExecContext.

Method Detail

getCredentialStore

public CredentialStore getCredentialStore()

Returns:

CredentialStore.

isCredentialsExist

public boolean isCredentialsExist(String resource,
                                  String user,
                                  org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator)

Specified by:

isCredentialsExist in interface org.azyva.dragom.execcontext.plugin.CredentialStorePlugin

getCredentials

public org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.Credentials getCredentials(String resource,
                                                                                            String user,
                                                                                            org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator)

Specified by:

getCredentials in interface org.azyva.dragom.execcontext.plugin.CredentialStorePlugin

getCredentialsInternal

public org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.Credentials getCredentialsInternal(String resource,
                                                                                                    String user,
                                                                                                    org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator credentialValidator)

The code for isCredentialsExist(java.lang.String, java.lang.String, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator) and getCredentials(java.lang.String, java.lang.String, org.azyva.dragom.execcontext.plugin.CredentialStorePlugin.CredentialValidator) is very similar and is factored out here.

The difference between this method and getCredentials is that this one returns null if the requested credentials are not available, making it usable for isCredentialsExist.

Parameters:

resource - Resource.

user - User. Can be null.

credentialValidator - CredentialValidator.

Returns:

Credentials. null if not available.s

resetCredentials

public void resetCredentials(String resource,
                             String user)

Specified by:

resetCredentials in interface org.azyva.dragom.execcontext.plugin.CredentialStorePlugin