org.apache.qpid.server.model.adapter

Class FileSystemPreferencesProviderImpl

java.lang.Object

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

org.apache.qpid.server.model.adapter.FileSystemPreferencesProviderImpl

All Implemented Interfaces:

FileSystemPreferencesProvider<FileSystemPreferencesProviderImpl>, ConfiguredObject<FileSystemPreferencesProviderImpl>, PreferencesProvider<FileSystemPreferencesProviderImpl>

public class FileSystemPreferencesProviderImpl
extends AbstractConfiguredObject<FileSystemPreferencesProviderImpl>
implements FileSystemPreferencesProvider<FileSystemPreferencesProviderImpl>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemPreferencesProviderImpl.FileSystemPreferencesStore

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 inherited from class org.apache.qpid.server.model.AbstractConfiguredObject

SECURED_STRING_VALUE

Fields inherited from interface org.apache.qpid.server.model.adapter.FileSystemPreferencesProvider

PATH, PROVIDER_TYPE

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

Constructor and Description
FileSystemPreferencesProviderImpl(Map<String,Object> attributes, AuthenticationProvider<? extends AuthenticationProvider> authenticationProvider)

Method Summary

Modifier and Type	Method and Description
protected void	changeAttributes(Map<String,Object> attributes)
String[]	deletePreferences(String... userIDs) Delete preferences for given user IDs
AuthenticationProvider<? extends AuthenticationProvider>	getAuthenticationProvider() Returns authentication provider associated with this preferences provider
<C extends ConfiguredObject> Collection<C>	getChildren(Class<C> clazz) Return children of the ConfiguredObject of the given class
String	getPath()
Map<String,Object>	getPreferences(String userId) Returns preferences Map for a given user ID
Set<String>	listUserIDs() Returns set of the user IDs having preferences set
protected void	onClose()
protected void	onOpen()
void	onValidate() Validation performed for configured object creation and opening.
Map<String,Object>	setPreferences(String userId, Map<String,Object> preferences) Set user preferences as specified in a given Map
protected void	validateChange(ConfiguredObject<?> updatedObject, Set<String> changedAttributes)
protected void	validateOnCreate()

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

addChangeListener, addChildAsync, applyToChildren, asObjectRecord, attainState, attributeSet, authoriseCreate, authoriseCreateChild, authoriseDelete, authoriseSetAttributes, beforeClose, changeAttribute, 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, getContext, getContextKeys, getContextValue, getContextValue, getCreatedBy, getCreatedTime, getDescription, getDesiredState, getId, getLastOpenedTime, getLastUpdatedBy, getLastUpdatedTime, getLifetimePolicy, getModel, getName, getObjectFactory, getParent, getSecurityManager, getState, getStatistics, getTaskExecutor, getType, getTypeClass, handleExceptionOnOpen, isDurable, managesChildStorage, notifyStateChanged, onCreate, onExceptionInOpen, onResolve, open, openAsync, parentsMap, postResolve, postResolveChildren, registerWithParents, removeChangeListener, rethrowRuntimeExceptionsOnOpen, runTask, setAttribute, setAttributes, setAttributesAsync, setEncrypter, setState, start, startAsync, stop, toString

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.model.ConfiguredObject

addChangeListener, asObjectRecord, close, closeAsync, createChild, createChildAsync, decryptSecrets, delete, deleteAsync, findConfiguredObject, getActualAttributes, getAttainedChildById, getAttainedChildByName, getAttribute, getAttributeNames, getCategoryClass, getChildById, getChildByName, getChildExecutor, 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

Constructor Detail

FileSystemPreferencesProviderImpl

public FileSystemPreferencesProviderImpl(Map<String,Object> attributes,
                                         AuthenticationProvider<? extends AuthenticationProvider> authenticationProvider)

Method Detail

validateOnCreate

protected void validateOnCreate()

Overrides:

validateOnCreate in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

onOpen

protected void onOpen()

Overrides:

onOpen in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

onValidate

public void onValidate()

Description copied from class: AbstractConfiguredObject

Validation performed for configured object creation and opening.

Overrides:

onValidate in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

getPath

public String getPath()

Specified by:

getPath in interface FileSystemPreferencesProvider<FileSystemPreferencesProviderImpl>

getChildren

public <C extends ConfiguredObject> Collection<C> getChildren(Class<C> clazz)

Description copied from interface: ConfiguredObject

Return children of the ConfiguredObject of the given class

Specified by:

getChildren in interface ConfiguredObject<FileSystemPreferencesProviderImpl>

Overrides:

getChildren in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

Parameters:

clazz - the class of the children to return

Returns:

the children

onClose

protected void onClose()

Overrides:

onClose in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

getPreferences

public Map<String,Object> getPreferences(String userId)

Description copied from interface: PreferencesProvider

Returns preferences Map for a given user ID

Specified by:

getPreferences in interface PreferencesProvider<FileSystemPreferencesProviderImpl>

Parameters:

userId - user ID to retrieve preferences for

Returns:

preferences Map

setPreferences

public Map<String,Object> setPreferences(String userId,
                                         Map<String,Object> preferences)

Description copied from interface: PreferencesProvider

Set user preferences as specified in a given Map

Specified by:

setPreferences in interface PreferencesProvider<FileSystemPreferencesProviderImpl>

Parameters:

userId - user ID to set preferences for

preferences - new preferences

Returns:

existing user preferences

deletePreferences

public String[] deletePreferences(String... userIDs)

Description copied from interface: PreferencesProvider

Delete preferences for given user IDs

Specified by:

deletePreferences in interface PreferencesProvider<FileSystemPreferencesProviderImpl>

Parameters:

userIDs - user IDs to delete preferences for

Returns:

user an array with user IDs having preferences deleted

listUserIDs

public Set<String> listUserIDs()

Description copied from interface: PreferencesProvider

Returns set of the user IDs having preferences set

Specified by:

listUserIDs in interface PreferencesProvider<FileSystemPreferencesProviderImpl>

Returns:

user IDs

getAuthenticationProvider

public AuthenticationProvider<? extends AuthenticationProvider> getAuthenticationProvider()

Description copied from interface: PreferencesProvider

Returns authentication provider associated with this preferences provider

Specified by:

getAuthenticationProvider in interface PreferencesProvider<FileSystemPreferencesProviderImpl>

Returns:

authentication provider

changeAttributes

protected void changeAttributes(Map<String,Object> attributes)

Overrides:

changeAttributes in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>

validateChange

protected void validateChange(ConfiguredObject<?> updatedObject,
                              Set<String> changedAttributes)

Overrides:

validateChange in class AbstractConfiguredObject<FileSystemPreferencesProviderImpl>