org.javalite.activeweb.controller_filters

Class DBConnectionFilter

java.lang.Object

org.javalite.activeweb.controller_filters.ControllerFilterAdapter

org.javalite.activeweb.controller_filters.DBConnectionFilter

All Implemented Interfaces:

ControllerFilter

public class DBConnectionFilter
extends ControllerFilterAdapter

Class is to be used in web apps that use ActiveJDBC. This class will open a connection configured in DBConfig class of the application before controller is executed and will close it after.

Author:

Igor Polevoy

Constructor Summary

Constructors

Constructor and Description
DBConnectionFilter() This constructor is used to open all configured connections for a current environment.
DBConnectionFilter(String dbName) Use this constructor to only open a named DB connection for a given environment.
DBConnectionFilter(String dbName, boolean manageTransaction) Use this constructor to only open a named DB connection for a given environment and specify if this filter needs to manage transactions.

Method Summary

Methods

Modifier and Type	Method and Description
void	after() Called by framework after executing a controller
void	before() Called by framework before executing a controller
void	onException(Exception e) Called by framework in case there was an exception inside a controller

Methods inherited from class java.lang.Object

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

Constructor Detail

DBConnectionFilter

public DBConnectionFilter()

This constructor is used to open all configured connections for a current environment.

DBConnectionFilter

public DBConnectionFilter(String dbName)

Use this constructor to only open a named DB connection for a given environment.

Parameters:

dbName - name of DB to open

DBConnectionFilter

public DBConnectionFilter(String dbName,
                  boolean manageTransaction)

Use this constructor to only open a named DB connection for a given environment and specify if this filter needs to manage transactions.

Parameters:

dbName - name of DB to open

manageTransaction - if set to true, the filter will start a transaction inside before() method, commit inside the after() method, and rollback inside onException(Exception) method. This applies to all connections managed by this filter. If set to false, transactions are not managed. Configuration of J2EE container transaction management for a given JNDI DataSource can interfere with this filter. This filter uses simple java.sql.Connection methods: setAutocommit(boolean), commit() and rollback(). If you configure XA transactions, this parameter could be completely ignored by the container itself. For this filter to manage transactions, the datasources should not be type of XA. Read container documentation.

Method Detail

before

public void before()

Description copied from interface: ControllerFilter

Called by framework before executing a controller

Specified by:

before in interface ControllerFilter

Overrides:

before in class ControllerFilterAdapter

after

public void after()

Description copied from interface: ControllerFilter

Called by framework after executing a controller

Specified by:

after in interface ControllerFilter

Overrides:

after in class ControllerFilterAdapter

onException

public void onException(Exception e)

Description copied from interface: ControllerFilter

Called by framework in case there was an exception inside a controller

Specified by:

onException in interface ControllerFilter

Overrides:

onException in class ControllerFilterAdapter

Parameters:

e - exception.