com.opensymphony.user.provider.jdbc
Class BaseJDBCProvider

java.lang.Object
  com.opensymphony.user.provider.jdbc.BaseJDBCProvider

All Implemented Interfaces:

java.io.Serializable, UserProvider

Direct Known Subclasses:

JDBCAccessProvider, JDBCCredentialsProvider, JDBCProfileProvider

public abstract class BaseJDBCProvider

extends java.lang.Object

implements UserProvider

DOCUMENT ME!

Version:

$Revision: 1.2 $

Author:

$author$

See Also:

Serialized Form

Field Summary

protected boolean	closeConnWhenDone
protected javax.sql.DataSource	ds
protected java.lang.String	groupName
protected java.lang.String	groupTable
protected java.lang.String	membershipGroupName
protected java.lang.String	membershipTable
protected java.lang.String	membershipUserName
protected java.lang.String	userName
protected java.lang.String	userPassword
protected java.lang.String	userTable

Constructor Summary

BaseJDBCProvider()

Method Summary

protected void	cleanup(java.sql.Connection connection, java.sql.Statement statement, java.sql.ResultSet result)
boolean	create(java.lang.String name) Create new Entity with given name.
void	flushCaches() Flush the providers caches - if it is caching.
protected java.sql.Connection	getConnection()
boolean	init(java.util.Properties props) Called by UserManager before any other method.
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

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

handles, list

Field Detail

ds

protected javax.sql.DataSource ds

groupName

protected java.lang.String groupName

groupTable

protected java.lang.String groupTable

membershipGroupName

protected java.lang.String membershipGroupName

membershipTable

protected java.lang.String membershipTable

membershipUserName

protected java.lang.String membershipUserName

userName

protected java.lang.String userName

userPassword

protected java.lang.String userPassword

userTable

protected java.lang.String userTable

closeConnWhenDone

protected boolean closeConnWhenDone

Constructor Detail

BaseJDBCProvider

public BaseJDBCProvider()

Method Detail

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

init

public boolean init(java.util.Properties props)

Description copied from interface: UserProvider

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

Specified by:

init in interface UserProvider

Parameters:

props - Extra properties passed across by UserManager.

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.

getConnection

protected java.sql.Connection getConnection()
                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

cleanup

protected void cleanup(java.sql.Connection connection,
                       java.sql.Statement statement,
                       java.sql.ResultSet result)