org.apache.qpid.server.security.auth.manager

Class ConfigModelPasswordManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

java.lang.Object

org.apache.qpid.server.model.AbstractConfiguredObject<T>

org.apache.qpid.server.security.auth.manager.AbstractAuthenticationManager<X>

org.apache.qpid.server.security.auth.manager.ConfigModelPasswordManagingAuthenticationProvider<X>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractScramAuthenticationManager, MD5AuthenticationProvider, PlainAuthenticationProvider

public abstract class ConfigModelPasswordManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>
extends AbstractAuthenticationManager<X>
implements PasswordCredentialManagingAuthenticationProvider<X>, PreferencesSupportingAuthenticationProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

AbstractConfiguredObject.CallableWithArgument<V,A>, AbstractConfiguredObject.ChainedListenableFuture<V>, AbstractConfiguredObject.ChainedSettableFuture<V>, AbstractConfiguredObject.DuplicateIdException, AbstractConfiguredObject.DuplicateNameException

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,org.apache.qpid.server.security.auth.manager.ManagedUser>	_users

Fields inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigModelPasswordManagingAuthenticationProvider(Map<String,Object> attributes, Broker broker)

Method Summary

Modifier and Type	Method and Description
<C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C>	addChildAsync(Class<C> childClass, Map<String,Object> attributes, ConfiguredObject... otherParents)
AuthenticationResult	authenticate(SaslServer server, byte[] response) Authenticates a user using SASL negotiation.
protected abstract String	createStoredPassword(String password)
boolean	createUser(String username, String password, Map<String,String> attributes)
void	deleteUser(String user)
protected SecurityManager	getSecurityManager()
Map<String,Map<String,String>>	getUsers()
void	recoverUser(User user)
void	reload() Refreshes the cache of user and password data from the underlying storage.
void	setPassword(String username, String password)

Methods inherited from class org.apache.qpid.server.security.auth.manager.AbstractAuthenticationManager

activate, doDelete, getBroker, getDisabledMechanisms, getPreferencesProvider, getSecureOnlyMechanisms, getSubjectCreator, getVirtualHostPortBindings, onOpen, onValidate, setPreferencesProvider, startQuiesced

Methods inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

addChangeListener, applyToChildren, asObjectRecord, attainState, attributeSet, authoriseCreate, authoriseCreateChild, authoriseDelete, authoriseSetAttributes, beforeClose, changeAttribute, changeAttributes, childAdded, childRemoved, close, closeAsync, closeChildren, create, createAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, deleted, doAfter, doAfter, doAfter, doAfter, doAfter, doAfter, doAfterAlways, doAfterAlways, doCreation, doOnConfigThread, doOpening, doResolution, doSync, doSync, doValidation, findConfiguredObject, forceUpdateAllSecureAttributes, 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, handleExceptionOnOpen, isDurable, managesChildStorage, notifyStateChanged, onClose, onCreate, onExceptionInOpen, onResolve, open, openAsync, parentsMap, postResolve, postResolveChildren, registerWithParents, removeChangeListener, rethrowRuntimeExceptionsOnOpen, runTask, setAttribute, setAttributes, setAttributesAsync, setEncrypter, setState, start, startAsync, stop, toString, validateChange, validateOnCreate

Methods inherited from class java.lang.Object

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

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

authenticate

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

createSaslServer, getDisabledMechanisms, getMechanisms, getPreferencesProvider, getSecureOnlyMechanisms, getSubjectCreator, getVirtualHostPortBindings, 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

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

getPreferencesProvider, setPreferencesProvider

Field Detail

_users

protected Map<String,org.apache.qpid.server.security.auth.manager.ManagedUser> _users

Constructor Detail

ConfigModelPasswordManagingAuthenticationProvider

protected ConfigModelPasswordManagingAuthenticationProvider(Map<String,Object> attributes,
                                                            Broker broker)

Method Detail

createUser

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

Specified by:

createUser in interface PasswordCredentialManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

getSecurityManager

protected SecurityManager getSecurityManager()

Overrides:

getSecurityManager in class AbstractConfiguredObject<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

deleteUser

public void deleteUser(String user)
                throws AccountNotFoundException

Specified by:

deleteUser in interface PasswordCredentialManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

Throws:

AccountNotFoundException

getUsers

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

Specified by:

getUsers in interface PasswordCredentialManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

reload

public void reload()
            throws IOException

Description copied from interface: PasswordCredentialManagingAuthenticationProvider

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.

Specified by:

reload in interface PasswordCredentialManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

Throws:

IOException

recoverUser

public void recoverUser(User user)

Specified by:

recoverUser in interface AuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

Overrides:

recoverUser in class AbstractAuthenticationManager<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

setPassword

public void setPassword(String username,
                        String password)
                 throws AccountNotFoundException

Specified by:

setPassword in interface PasswordCredentialManagingAuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

Throws:

AccountNotFoundException

authenticate

public AuthenticationResult authenticate(SaslServer server,
                                         byte[] response)

Description copied from interface: AuthenticationProvider

Authenticates a user using SASL negotiation.

Specified by:

authenticate in interface AuthenticationProvider<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>

Parameters:

server - SASL server

response - SASL response to process

Returns:

authentication result

createStoredPassword

protected abstract String createStoredPassword(String password)

addChildAsync

public <C extends ConfiguredObject> com.google.common.util.concurrent.ListenableFuture<C> addChildAsync(Class<C> childClass,
                                                                                                        Map<String,Object> attributes,
                                                                                                        ConfiguredObject... otherParents)

Overrides:

addChildAsync in class AbstractAuthenticationManager<X extends ConfigModelPasswordManagingAuthenticationProvider<X>>