com.opensymphony.user.provider.castor
Class CastorBaseProvider

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

Direct Known Subclasses:

CastorAccessProvider, CastorCredentialsProvider, CastorProfileProvider

public class CastorBaseProvider

extends java.lang.Object

Author:

Dan Bachelder

Field Summary

protected CastorDataProvider	_dataProvider
static java.lang.String	DatabaseFile
protected static java.lang.String	GROUP_CLASS
protected static java.lang.String	groupQueryString
static java.lang.String	MappingFile
protected static java.lang.String	USER_CLASS
protected static java.lang.String	userQueryString

Constructor Summary

CastorBaseProvider()

Method Summary

void	flushCaches()
boolean	init(java.util.Properties properties) Called by UserManager before any other method.
boolean	load(java.lang.String name, Entity.Accessor accessor) Load Entity.
protected CastorGroup	queryGroupsByNameKey(org.exolab.castor.jdo.Database db, java.lang.String name) binds name to queryString, executes it and returns a single object.
protected CastorGroup	queryGroupsByNameKey(java.lang.String name) binds name to queryString, executes it and returns a single object.
protected CastorUser	queryUsersByNameKey(org.exolab.castor.jdo.Database db, java.lang.String name) querys users by name and returns a single object.
protected CastorUser	queryUsersByNameKey(java.lang.String name) querys users by name and returns a single object.
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

GROUP_CLASS

protected static final java.lang.String GROUP_CLASS

See Also:

Constant Field Values

USER_CLASS

protected static final java.lang.String USER_CLASS

See Also:

Constant Field Values

groupQueryString

protected static final java.lang.String groupQueryString

See Also:

Constant Field Values

userQueryString

protected static final java.lang.String userQueryString

See Also:

Constant Field Values

DatabaseFile

public static final java.lang.String DatabaseFile

See Also:

Constant Field Values

MappingFile

public static final java.lang.String MappingFile

See Also:

Constant Field Values

_dataProvider

protected CastorDataProvider _dataProvider

Constructor Detail

CastorBaseProvider

public CastorBaseProvider()

Method Detail

flushCaches

public void flushCaches()

init

public boolean init(java.util.Properties properties)

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

Parameters:

properties - Extra properties passed across by UserManager.

load

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

Load Entity.

Returns:

Whether entity was successfully loaded.

store

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

Stores changes to Entity.

Returns:

Whether changes to entity were successfully stored.

queryGroupsByNameKey

protected CastorGroup queryGroupsByNameKey(org.exolab.castor.jdo.Database db,
                                           java.lang.String name)
                                    throws org.exolab.castor.jdo.PersistenceException

binds name to queryString, executes it and returns a single object.

Parameters:

db - - the database object to execute the query on

name - - the name to bind to the query

Throws:

org.exolab.castor.jdo.PersistenceException - - any castor failure

queryGroupsByNameKey

protected CastorGroup queryGroupsByNameKey(java.lang.String name)
                                    throws org.exolab.castor.jdo.PersistenceException

binds name to queryString, executes it and returns a single object. starts and ends its own transaction.

Parameters:

name - - the name to bind to the query

Throws:

org.exolab.castor.jdo.PersistenceException - - any castor failure

queryUsersByNameKey

protected CastorUser queryUsersByNameKey(org.exolab.castor.jdo.Database db,
                                         java.lang.String name)
                                  throws org.exolab.castor.jdo.PersistenceException

querys users by name and returns a single object.

Parameters:

db - - the database object to execute the query on

name - - the name to bind to the query

Throws:

org.exolab.castor.jdo.PersistenceException - - any castor failure

queryUsersByNameKey

protected CastorUser queryUsersByNameKey(java.lang.String name)
                                  throws org.exolab.castor.jdo.PersistenceException

querys users by name and returns a single object. starts and ends its own transaction.

Parameters:

name - - the name to bind to the query

Throws:

org.exolab.castor.jdo.PersistenceException - - any castor failure