com.opensymphony.user.provider.castor
Class CastorProfileProvider

java.lang.Object
  com.opensymphony.user.provider.castor.CastorBaseProvider
      com.opensymphony.user.provider.castor.CastorProfileProvider

All Implemented Interfaces:

ProfileProvider, java.io.Serializable, UserProvider

public class CastorProfileProvider

extends CastorBaseProvider

implements ProfileProvider

Author:

Dan Bachelder

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opensymphony.user.provider.castor.CastorBaseProvider

_dataProvider, DatabaseFile, GROUP_CLASS, groupQueryString, MappingFile, USER_CLASS, userQueryString

Constructor Summary

CastorProfileProvider()

Method Summary

boolean	create(java.lang.String name) Create new Entity with given name.
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.
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) Create Entity with given name.
boolean	store(java.lang.String name, Entity.Accessor accessor) Stores changes to Entity.

Methods inherited from class com.opensymphony.user.provider.castor.CastorBaseProvider

flushCaches, init, queryGroupsByNameKey, queryGroupsByNameKey, queryUsersByNameKey, queryUsersByNameKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.user.provider.UserProvider

flushCaches, init

Constructor Detail

CastorProfileProvider

public CastorProfileProvider()

Method Detail

getPropertySet

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

Retrieve profile for User with given name.

Specified by:

getPropertySet in interface ProfileProvider

create

public boolean create(java.lang.String name)

Create new Entity with given name.

Specified by:

create in interface UserProvider

Returns:

Whether entity was successfully created.

handles

public boolean handles(java.lang.String name)

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

Specified by:

handles in interface UserProvider

list

public 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. 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)

Load Entity.

Specified by:

load in interface UserProvider

Overrides:

load in class CastorBaseProvider

Returns:

Whether entity was successfully loaded.

remove

public boolean remove(java.lang.String name)

Create 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)

Stores changes to Entity.

Specified by:

store in interface UserProvider

Overrides:

store in class CastorBaseProvider

Returns:

Whether changes to entity were successfully stored.