com.pingidentity.sdk.password

Interface PasswordCredentialValidator

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface PasswordCredentialValidator
extends Plugin

A plugin for validating usernames and passwords.

Method Summary

Modifier and Type	Method and Description
AttributeMap	processPasswordCredential(String username, String password) Validates the given username and password in the manner appropriate to the plugin implementation.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin

getPluginDescriptor

Method Detail

processPasswordCredential

AttributeMap processPasswordCredential(String username,
                                       String password)
                                throws PasswordValidationException

Validates the given username and password in the manner appropriate to the plugin implementation.

Parameters:

username - the given username/id

password - the given password

Returns:

An AttributeMap with at least one entry representing the principal. The key of the entry does not matter, so long as the map is not empty. If the map is empty or null, the username and password combination is considered invalid.

Throws:

PasswordValidationException - Runtime exception to indicate the password validator fails to process the username/password combination. This exception can be the result of configuration or validation errors, system errors (e.g. data source is unreachable), or, when sub-classed, to redirect the workflow (e.g. force a password reset).