com.opensymphony.user.provider.file
Class FileProfileProvider

java.lang.Object
  com.opensymphony.user.provider.file.FileProfileProvider

All Implemented Interfaces:

ProfileProvider, java.io.Serializable, UserProvider

Direct Known Subclasses:

SerializableProfileProvider

public class FileProfileProvider

extends java.lang.Object

implements ProfileProvider

Following properties are required:

• storeFile - the absolute path to the store file (ex:c:\properties.store)

See Also:

Serialized Form

Field Summary

protected static org.apache.commons.logging.Log	log
protected com.opensymphony.user.provider.file.FilePropertySetCache	propertySetCache

Constructor Summary

FileProfileProvider()

Method Summary

boolean	create(java.lang.String name) Create new Entity with given name.
void	flushCaches() Flush the providers caches - if it is caching.
com.opensymphony.module.propertyset.PropertySet	getPropertySet(java.lang.String name) Retrieve profile for User with given name.
boolean	handles(java.lang.String name) Determine whether this UserProvider implementation is responsible for handling this Entity.
boolean	init(java.util.Properties properties) Called by UserManager before any other method.
java.util.List	list() Returns List of names (Strings) of all Entities that can be accessed by this UserProvider If this UserProvider cannot retrieve a list of names, null is to be returned.
boolean	load(java.lang.String name, Entity.Accessor accessor) Load Entity.
boolean	remove(java.lang.String name) Remove Entity with given name.
boolean	store(java.lang.String name, Entity.Accessor accessor) Stores changes to Entity.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

propertySetCache

protected com.opensymphony.user.provider.file.FilePropertySetCache propertySetCache

Constructor Detail

FileProfileProvider

public FileProfileProvider()

Method Detail

getPropertySet

public com.opensymphony.module.propertyset.PropertySet getPropertySet(java.lang.String name)

Description copied from interface: ProfileProvider

Retrieve profile for User with given name.

Specified by:

getPropertySet in interface ProfileProvider

create

public boolean create(java.lang.String name)

Description copied from interface: UserProvider

Create new Entity with given name.

Specified by:

create in interface UserProvider

Returns:

Whether entity was successfully created.

flushCaches

public void flushCaches()

Description copied from interface: UserProvider

Flush the providers caches - if it is caching. Providers may implement their own caching strategies. This method merely indicates to the provider that it should flush it's caches now.

Specified by:

flushCaches in interface UserProvider

handles

public boolean handles(java.lang.String name)

Description copied from interface: UserProvider

Determine whether this UserProvider implementation is responsible for handling this Entity.

Specified by:

handles in interface UserProvider

init

public boolean init(java.util.Properties properties)

Description copied from interface: UserProvider

Called by UserManager before any other method. Allows for UserProvider specific initialization.

Specified by:

init in interface UserProvider

Parameters:

properties - Extra properties passed across by UserManager.

list

public java.util.List list()

Description copied from interface: UserProvider

Returns List of names (Strings) of all Entities that can be accessed by this UserProvider If this UserProvider cannot retrieve a list of names, null is to be returned. If there are no current Entities stored by this provider, an empty List is to be returned. The order of names returned can be determined by the UserProvider (it may or may not be relevant). This List should be immutable.

Specified by:

list in interface UserProvider

load

public boolean load(java.lang.String name,
                    Entity.Accessor accessor)

Description copied from interface: UserProvider

Load Entity.

Specified by:

load in interface UserProvider

Returns:

Whether entity was successfully loaded.

remove

public boolean remove(java.lang.String name)

Description copied from interface: UserProvider

Remove Entity with given name.

Specified by:

remove in interface UserProvider

Returns:

Whether entity was successfully removed.

store

public boolean store(java.lang.String name,
                     Entity.Accessor accessor)

Description copied from interface: UserProvider

Stores changes to Entity.

Specified by:

store in interface UserProvider

Returns:

Whether changes to entity were successfully stored.