org.apache.qpid.server.model

Interface PasswordCredentialManagingAuthenticationProvider<X extends PasswordCredentialManagingAuthenticationProvider<X>>

All Superinterfaces:

AuthenticationProvider<X>, ConfiguredObject<X>, ManagedInterface, UsernamePasswordAuthenticationProvider<X>

All Known Subinterfaces:

ExternalFileBasedAuthenticationManager<X>

All Known Implementing Classes:

AbstractScramAuthenticationManager, Base64MD5PasswordDatabaseAuthenticationManager, ConfigModelPasswordManagingAuthenticationProvider, MD5AuthenticationProvider, PlainAuthenticationProvider, PlainPasswordDatabaseAuthenticationManager, PrincipalDatabaseAuthenticationManager, ScramSHA1AuthenticationManager, ScramSHA256AuthenticationManager

public interface PasswordCredentialManagingAuthenticationProvider<X extends PasswordCredentialManagingAuthenticationProvider<X>>
extends AuthenticationProvider<X>, UsernamePasswordAuthenticationProvider<X>, ManagedInterface

Field Summary

Fields inherited from interface org.apache.qpid.server.model.ConfiguredObject

CONTEXT, CREATED_BY, CREATED_TIME, DESCRIPTION, DESIRED_STATE, DURABLE, ID, LAST_UPDATED_BY, LAST_UPDATED_TIME, LIFETIME_POLICY, NAME, OVER_SIZED_ATTRIBUTE_ALTERNATIVE_TEXT, STATE, TYPE

Method Summary

Modifier and Type	Method and Description
boolean	createUser(String username, String password, Map<String,String> attributes)
void	deleteUser(String user)
Map<String,Map<String,String>>	getUsers()
void	reload() Refreshes the cache of user and password data from the underlying storage.
void	setPassword(String username, String password)

Methods inherited from interface org.apache.qpid.server.security.auth.manager.UsernamePasswordAuthenticationProvider

authenticate

Methods inherited from interface org.apache.qpid.server.model.AuthenticationProvider

authenticate, createSaslServer, getDisabledMechanisms, getMechanisms, getPreferencesProvider, getSecureOnlyMechanisms, getSubjectCreator, getVirtualHostPortBindings, recoverUser, setPreferencesProvider

Methods inherited from interface org.apache.qpid.server.model.ConfiguredObject

addChangeListener, asObjectRecord, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, getChildren, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getState, getStatistics, getTaskExecutor, getType, getTypeClass, isDurable, managesChildStorage, open, openAsync, removeChangeListener, setAttribute, setAttributes, setAttributesAsync

Method Detail

createUser

boolean createUser(String username,
                   String password,
                   Map<String,String> attributes)

deleteUser

void deleteUser(String user)
         throws AccountNotFoundException

Throws:

AccountNotFoundException

setPassword

void setPassword(String username,
                 String password)
          throws AccountNotFoundException

Throws:

AccountNotFoundException

getUsers

Map<String,Map<String,String>> getUsers()

reload

void reload()
     throws IOException

Refreshes the cache of user and password data from the underlying storage. If there is a failure whilst reloading the data, the implementation must throw an IOException and revert to using the previous cached username and password data. In this way, the broker will remain usable.

Throws:

IOException