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

Class MasterSourceSupport

java.lang.Object

org.codehaus.plexus.components.secdispatcher.internal.sources.MasterSourceSupport

All Implemented Interfaces:

MasterSource

Direct Known Subclasses:

PrefixMasterSourceSupport

public abstract class MasterSourceSupport
extends Object
implements MasterSource

Master password source support class.

Constructor Summary

Constructors

Constructor	Description
MasterSourceSupport(Predicate<String> matcher, Function<String,String> transformer)

Method Summary

Modifier and Type	Method	Description
protected abstract String	doHandle(String transformed)
protected abstract SecDispatcher.ValidationResponse	doValidateConfiguration(String transformed)
String	handle(String masterSource)	Handles the config to get master password.
SecDispatcher.ValidationResponse	validateConfiguration(String masterSource)	Validates master source configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

MasterSourceSupport

public MasterSourceSupport(Predicate<String> matcher,
 Function<String,String> transformer)

Method Details

handle

public String handle(String masterSource)
              throws SecDispatcherException

Description copied from interface: MasterSource

Handles the config to get master password. Implementation may do one of the following things:

• if the config cannot be handled by given source, return null
• otherwise, if master password retrieval based on config was attempted but failed, throw SecDispatcherException
• happy path: return the master password.

Specified by:

handle in interface MasterSource

Parameters:

masterSource - the source of master password, and opaque string.

Returns:

the master password, or null if implementation does not handle this config

Throws:

SecDispatcherException - If implementation does handle this masterSource, but cannot obtain master password

doHandle

protected abstract String doHandle(String transformed)
                            throws SecDispatcherException

Throws:

SecDispatcherException

validateConfiguration

public SecDispatcher.ValidationResponse validateConfiguration(String masterSource)

Description copied from interface: MasterSource

Validates master source configuration.

• if the config cannot be handled by given source, return null
• otherwise, implementation performs validation and returns non-null validation response

Specified by:

validateConfiguration in interface MasterSource

doValidateConfiguration

protected abstract SecDispatcher.ValidationResponse doValidateConfiguration(String transformed)