Package org.codehaus.plexus.components.secdispatcher

Interface Dispatcher

All Known Implementing Classes:

LegacyDispatcher, MasterDispatcher

public interface Dispatcher

Dispatcher.

Version:

$Id$

Author:

Oleg Gusakov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Dispatcher.EncryptPayload	The "encrypt payload" prepared by dispatcher.

Method Summary

Modifier and Type	Method	Description
String	decrypt(String str, Map<String,String> attributes, Map<String,String> config)	Decrypt given encrypted string.
Dispatcher.EncryptPayload	encrypt(String str, Map<String,String> attributes, Map<String,String> config)	Encrypt given plaintext string.
SecDispatcher.ValidationResponse	validateConfiguration(Map<String,String> config)	Validates dispatcher configuration.

Method Details

encrypt

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

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

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

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

Decrypt given encrypted string.

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

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

Validates dispatcher configuration.