Package org.codehaus.plexus.components.secdispatcher.internal

Class DefaultSecDispatcher

java.lang.Object

org.codehaus.plexus.components.secdispatcher.internal.DefaultSecDispatcher

All Implemented Interfaces:

SecDispatcher

public class DefaultSecDispatcher
extends Object
implements SecDispatcher

Note: this implementation is NOT a JSR330 component. Integrating apps anyway want to customize it (at least the name and location of configuration file), so instead as before (providing "bad" configuration file just to have one), it is the duty of integrator to wrap and "finish" the implementation in a way it suits the integrator. Also, using "globals" like Java System Properties are bad thing, and it is integrator who knows what is needed anyway.

Recommended way for integration is to create JSR330 Provider.

Author:

Oleg Gusakov

Nested Class Summary

Nested classes/interfaces inherited from interface org.codehaus.plexus.components.secdispatcher.SecDispatcher

SecDispatcher.ValidationResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_START
static final String	ATTR_STOP
protected final Path	configurationFile
protected final Map<String,Dispatcher>	dispatchers
static final String	SHIELD_BEGIN
static final String	SHIELD_END

Fields inherited from interface org.codehaus.plexus.components.secdispatcher.SecDispatcher

DISPATCHER_NAME_ATTR, DISPATCHER_VERSION_ATTR

Constructor Summary

Constructors

Constructor	Description
DefaultSecDispatcher(Map<String,Dispatcher> dispatchers, Path configurationFile)

Method Summary

Modifier and Type	Method	Description
Set<DispatcherMeta>	availableDispatchers()	Returns the set of available dispatcher metadata, never null.
String	decrypt(String str)	Decrypt given encrypted string.
String	encrypt(String str, Map<String,String> attr)	Encrypt given plaintext string.
boolean	isEncryptedString(String str)	Current: {[name=master,cipher=AES/GCM/NoPadding,version=4.0]vvq66pZ7rkvzSPStGTI9q4QDnsmuDwo+LtjraRel2b0XpcGJFdXcYAHAS75HUA6GLpcVtEkmyQ==}
boolean	isLegacyEncryptedString(String str)	Legacy: {jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}
protected Map<String,String>	prepareDispatcherConfig(String name)
SettingsSecurity	readConfiguration(boolean createIfMissing)	Reads the effective configuration, eventually creating new instance if not present.
protected String	strip(String str)
protected Map<String,String>	stripAttributes(String str)
protected String	unDecorate(String str)
protected String	unDecorateLegacy(String str)
SecDispatcher.ValidationResponse	validateConfiguration()	Performs a "deep validation" and reports the status.
void	writeConfiguration(SettingsSecurity configuration)	Writes the effective configuration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.plexus.components.secdispatcher.SecDispatcher

isAnyEncryptedString

Field Details

SHIELD_BEGIN

public static final String SHIELD_BEGIN

See Also:

• Constant Field Values

SHIELD_END

public static final String SHIELD_END

See Also:

• Constant Field Values

ATTR_START

public static final String ATTR_START

See Also:

• Constant Field Values

ATTR_STOP

public static final String ATTR_STOP

See Also:

• Constant Field Values

dispatchers

protected final Map<String,Dispatcher> dispatchers

configurationFile

protected final Path configurationFile

Constructor Details

DefaultSecDispatcher

public DefaultSecDispatcher(Map<String,Dispatcher> dispatchers,
 Path configurationFile)

Method Details

availableDispatchers

public Set<DispatcherMeta> availableDispatchers()

Description copied from interface: SecDispatcher

Returns the set of available dispatcher metadata, never null.

Specified by:

availableDispatchers in interface SecDispatcher

encrypt

public String encrypt(String str,
 Map<String,String> attr)
               throws SecDispatcherException,
IOException

Description copied from interface: SecDispatcher

Encrypt given plaintext string.

Specified by:

encrypt in interface SecDispatcher

Parameters:

str - the plaintext to encrypt

attr - the attributes, may be null

Returns:

encrypted string

Throws:

SecDispatcherException - in case of problem

IOException

decrypt

public String decrypt(String str)
               throws SecDispatcherException,
IOException

Description copied from interface: SecDispatcher

Decrypt given encrypted string.

Specified by:

decrypt in interface SecDispatcher

Parameters:

str - the encrypted string

Returns:

decrypted string

Throws:

SecDispatcherException - in case of problem

IOException

isEncryptedString

public boolean isEncryptedString(String str)

• Current: {[name=master,cipher=AES/GCM/NoPadding,version=4.0]vvq66pZ7rkvzSPStGTI9q4QDnsmuDwo+LtjraRel2b0XpcGJFdXcYAHAS75HUA6GLpcVtEkmyQ==}

Specified by:

isEncryptedString in interface SecDispatcher

isLegacyEncryptedString

public boolean isLegacyEncryptedString(String str)

• Legacy: {jSMOWnoPFgsHVpMvz5VrIt5kRbzGpI8u+9EF1iFQyJQ=}

Specified by:

isLegacyEncryptedString in interface SecDispatcher

readConfiguration

public SettingsSecurity readConfiguration(boolean createIfMissing)
                                   throws IOException

Description copied from interface: SecDispatcher

Reads the effective configuration, eventually creating new instance if not present.

Specified by:

readConfiguration in interface SecDispatcher

Parameters:

createIfMissing - If true, it will create a new empty instance

Returns:

the configuration, of null if it does not exist in createIfMissing is false

Throws:

IOException - In case of IO problem

writeConfiguration

public void writeConfiguration(SettingsSecurity configuration)
                        throws IOException

Description copied from interface: SecDispatcher

Writes the effective configuration.

Specified by:

writeConfiguration in interface SecDispatcher

Parameters:

configuration - The configuration to write, may not be null

Throws:

IOException - In case of IO problem

validateConfiguration

public SecDispatcher.ValidationResponse validateConfiguration()

Description copied from interface: SecDispatcher

Performs a "deep validation" and reports the status. If return instance SecDispatcher.ValidationResponse.isValid() is true, configuration is usable.

Specified by:

validateConfiguration in interface SecDispatcher

prepareDispatcherConfig

protected Map<String,String> prepareDispatcherConfig(String name)
                                              throws IOException

Throws:

IOException

strip

protected String strip(String str)

stripAttributes

protected Map<String,String> stripAttributes(String str)

unDecorate

protected String unDecorate(String str)

unDecorateLegacy

protected String unDecorateLegacy(String str)