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

Class LegacyDispatcher

java.lang.Object

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

All Implemented Interfaces:

Dispatcher, DispatcherMeta

@Singleton
@Named("legacy")
public class LegacyDispatcher
extends Object
implements Dispatcher, DispatcherMeta

This dispatcher is legacy, serves the purpose of migration only. Should not be used.

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
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
LegacyDispatcher()

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.
boolean	isHidden()	Option to hide this instance from users, like for migration or legacy purposes.
String	name()	The name of the dispatcher.
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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

LegacyDispatcher

@Inject
public LegacyDispatcher()

Method Details

isHidden

public boolean isHidden()

Description copied from interface: DispatcherMeta

Option to hide this instance from users, like for migration or legacy purposes.

Specified by:

isHidden in interface DispatcherMeta

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