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

Class MasterDispatcher

java.lang.Object

org.codehaus.plexus.components.secdispatcher.internal.dispatchers.MasterDispatcher

All Implemented Interfaces:

Dispatcher, DispatcherMeta

@Singleton
@Named("master")
public class MasterDispatcher
extends Object
implements Dispatcher, DispatcherMeta

This dispatcher is logically equivalent (but much more secure) that Maven3 "master password" encryption.

Nested Class Summary

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

Dispatcher.EncryptPayload

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

DispatcherMeta.Field

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,Cipher>	masterCiphers
protected final Map<String,MasterSource>	masterSources
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
MasterDispatcher(Map<String,Cipher> masterCiphers, Map<String,MasterSource> masterSources)

Method Summary

Modifier and Type	Method	Description
String	decrypt(String str, Map<String,String> attributes, Map<String,String> config)	Decrypt given encrypted string.
String	displayName()	Returns the display (human) name of the dispatcher.
Dispatcher.EncryptPayload	encrypt(String str, Map<String,String> attributes, Map<String,String> config)	Encrypt given plaintext string.
Collection<DispatcherMeta.Field>	fields()	Returns the configuration fields of the dispatcher.
protected String	getMasterCipher(Map<String,String> source, boolean config)
protected String	getMasterPassword(Map<String,String> config)
String	name()	The name of the dispatcher.
protected Cipher	requireCipher(String name)
SecDispatcher.ValidationResponse	validateConfiguration(Map<String,String> config)	Validates dispatcher 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.DispatcherMeta

isHidden

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

masterCiphers

protected final Map<String,Cipher> masterCiphers

masterSources

protected final Map<String,MasterSource> masterSources

Constructor Details

MasterDispatcher

@Inject
public MasterDispatcher(Map<String,Cipher> masterCiphers,
 Map<String,MasterSource> masterSources)

Method Details

name

public String name()

Description copied from interface: DispatcherMeta

The name of the dispatcher.

Specified by:

name in interface DispatcherMeta

displayName

public String displayName()

Description copied from interface: DispatcherMeta

Returns the display (human) name of the dispatcher.

Specified by:

displayName in interface DispatcherMeta

fields

public Collection<DispatcherMeta.Field> fields()

Description copied from interface: DispatcherMeta

Returns the configuration fields of the dispatcher.

Specified by:

fields in interface DispatcherMeta

encrypt

public Dispatcher.EncryptPayload encrypt(String str,
 Map<String,String> attributes,
 Map<String,String> config)
                                  throws SecDispatcherException

Description copied from interface: Dispatcher

Encrypt given plaintext string. Implementation must return at least same attributes it got, but may add more attributes to returned payload.

Specified by:

encrypt in interface Dispatcher

Parameters:

str - string to encrypt, never null

attributes - attributes, never null

config - configuration from settings-security.xml, never null

Returns:

encrypted string and attributes in Dispatcher.EncryptPayload

Throws:

SecDispatcherException

decrypt

public String decrypt(String str,
 Map<String,String> attributes,
 Map<String,String> config)
               throws SecDispatcherException

Description copied from interface: Dispatcher

Decrypt given encrypted string.

Specified by:

decrypt in interface Dispatcher

Parameters:

str - string to decrypt, never null

attributes - attributes, never null

config - configuration from settings-security.xml, never null

Returns:

decrypted string

Throws:

SecDispatcherException

validateConfiguration

public SecDispatcher.ValidationResponse validateConfiguration(Map<String,String> config)

Description copied from interface: Dispatcher

Validates dispatcher configuration.

Specified by:

validateConfiguration in interface Dispatcher

getMasterPassword

protected String getMasterPassword(Map<String,String> config)
                            throws SecDispatcherException

Throws:

SecDispatcherException

getMasterCipher

protected String getMasterCipher(Map<String,String> source,
 boolean config)
                          throws SecDispatcherException

Throws:

SecDispatcherException

requireCipher

protected Cipher requireCipher(String name)