org.geotools.jdbc

Class SessionCommandsListener

Object

SessionCommandsListener

All Implemented Interfaces:

ConnectionLifecycleListener

public class SessionCommandsListener
extends Object
implements ConnectionLifecycleListener

A ConnectionLifecycleListener that executes custom SQL commands on connection grab and release. The SQL commands can contain environment variable references, where the enviroment variable reference contains a name and an eventual default value. Parsing rules are:

• whatever is between ${ and } is considered a enviroment variable reference in the form ${name,defaultvalue}, the default value being optional
• $ and } can be used stand alone only escaped with \ (e.g. \$ and \})
• \ can be used stand alone only escaped with another \
(e.g. \\)
• a enviroment variable name cannot contain a comma, which is used as the separator between the enviroemnt variable name and its default value (first comma acts as a separator)
• the default value is always interpreted as a string and expanded as such in the sql commands

Examples of valid expressions:

• "one two three \} \$ \\" (simple literal with special chars escaped)
• "My name is ${name}" (a simple enviroment variable reference without a default value)
• "My name is ${name,Joe}" (a simple enviroment variable reference with a default value)

Examples of non valid expressions:

• "bla ${myAttName" (unclosed expression section)
• "bla } bla" (} is reserved, should have been escaped)

Author:

Andrea Aime - GeoSolutions

Constructor Summary

Constructors

Constructor and Description
SessionCommandsListener(String sqlOnBorrow, String sqlOnRelease)

Method Summary

Modifier and Type	Method and Description
void	onBorrow(JDBCDataStore store, Connection cx) Called when the collection is being borrowed from the connection pool
void	onCommit(JDBCDataStore store, Connection cx) Called when the connection comes to a commit
void	onRelease(JDBCDataStore store, Connection cx) Called when the collection is being released back to the connection pool
void	onRollback(JDBCDataStore store, Connection cx) Called when the connection comes to a rollback

Methods inherited from class Object

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

Constructor Detail

SessionCommandsListener

public SessionCommandsListener(String sqlOnBorrow,
                               String sqlOnRelease)

Method Detail

onBorrow

public void onBorrow(JDBCDataStore store,
                     Connection cx)
              throws SQLException

Description copied from interface: ConnectionLifecycleListener

Called when the collection is being borrowed from the connection pool

Specified by:

onBorrow in interface ConnectionLifecycleListener

Throws:

SQLException

onRelease

public void onRelease(JDBCDataStore store,
                      Connection cx)
               throws SQLException

Description copied from interface: ConnectionLifecycleListener

Called when the collection is being released back to the connection pool

Specified by:

onRelease in interface ConnectionLifecycleListener

Throws:

SQLException

onCommit

public void onCommit(JDBCDataStore store,
                     Connection cx)

Description copied from interface: ConnectionLifecycleListener

Called when the connection comes to a commit

Specified by:

onCommit in interface ConnectionLifecycleListener

onRollback

public void onRollback(JDBCDataStore store,
                       Connection cx)

Description copied from interface: ConnectionLifecycleListener

Called when the connection comes to a rollback

Specified by:

onRollback in interface ConnectionLifecycleListener