com.opensymphony.user.provider.hibernate
Class HibernateProfileProvider

java.lang.Object
  com.opensymphony.user.provider.hibernate.HibernateBaseProvider
      com.opensymphony.user.provider.hibernate.HibernateProfileProvider

All Implemented Interfaces:

ProfileProvider, java.io.Serializable, UserProvider

public class HibernateProfileProvider

extends HibernateBaseProvider

implements ProfileProvider

Author:

Matthew E. Porter

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opensymphony.user.provider.hibernate.HibernateBaseProvider

log

Constructor Summary

HibernateProfileProvider()

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	remove(java.lang.String name) Create Entity with given name.

Methods inherited from class com.opensymphony.user.provider.hibernate.HibernateBaseProvider

getGroupDAO, getUserDAO, load, store

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

load, store

Constructor Detail

HibernateProfileProvider

public HibernateProfileProvider()

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

Overrides:

create in class HibernateBaseProvider

Returns:

Whether entity was successfully created.

flushCaches

public void flushCaches()

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)

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)

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

Specified by:

init in interface UserProvider

Overrides:

init in class HibernateBaseProvider

Parameters:

properties - Extra properties passed across by UserManager.

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

Overrides:

list in class HibernateBaseProvider

remove

public boolean remove(java.lang.String name)

Create Entity with given name.

Specified by:

remove in interface UserProvider

Overrides:

remove in class HibernateBaseProvider

Returns:

Whether entity was successfully removed.