org.mule.providers.jdbc
Class JdbcConnector

java.lang.Object
  extended byorg.mule.providers.AbstractConnector
      extended byorg.mule.providers.jdbc.JdbcConnector
All Implemented Interfaces:
Disposable, EventListener, ExceptionListener, Initialisable, UMOConnectable, UMOConnector, WorkListener

public class JdbcConnector
extends AbstractConnector


Field Summary
protected  DataSource dataSource
           
protected  String dataSourceJndiName
           
static long DEFAULT_POLLING_FREQUENCY
           
protected  Context jndiContext
           
protected  String jndiInitialFactory
           
protected  String jndiProviderUrl
           
protected  long pollingFrequency
           
static String PROPERTY_POLLING_FREQUENCY
           
protected  Set propertyExtractors
           
protected  Map providerProperties
           
protected  Map queries
           
protected  String queryRunner
           
protected  Set queryValueExtractors
           
protected  String resultSetHandler
           
 
Fields inherited from class org.mule.providers.AbstractConnector
connected, connecting, connectionStrategy, createMultipleTransactedReceivers, DEFAULT_NUM_CONCURRENT_TX_RECEIVERS, defaultInboundTransformer, defaultOutboundTransformer, defaultResponseTransformer, dispatcherFactory, dispatchers, disposed, disposing, exceptionListener, initialised, logger, name, numberOfConcurrentTransactedReceivers, receivers, serviceDescriptor, serviceOverrides, sessionHandler, started, startOnConnect
 
Fields inherited from interface org.mule.umo.provider.UMOConnector
INT_VALUE_NOT_SET
 
Constructor Summary
JdbcConnector()
           
 
Method Summary
protected  void createDataSource()
           
protected  org.apache.commons.dbutils.QueryRunner createQueryRunner()
           
 UMOMessageReceiver createReceiver(UMOComponent component, UMOEndpoint endpoint)
          Create a Message receiver for this connector
protected  org.apache.commons.dbutils.ResultSetHandler createResultSetHandler()
           
protected  void doConnect()
          Template method where any connections should be made for the connector
protected  void doDisconnect()
          Template method where any connected resources used by the connector should be disconnected
protected  void doDispose()
          Template method to perform any work when destroying the connectoe
protected  void doInitialise()
           
protected  void doStart()
          Template method to perform any work when starting the connectoe
protected  void doStop()
          Template method to perform any work when stopping the connectoe
 Connection getConnection()
           
 DataSource getDataSource()
           
 String getDataSourceJndiName()
           
 Context getJndiContext()
           
 String getJndiInitialFactory()
           
 String getJndiProviderUrl()
           
 Object[] getParams(UMOImmutableEndpoint endpoint, List paramNames, Object message)
           
 long getPollingFrequency()
           
 String getProtocol()
           
 Map getProviderProperties()
           
 Map getQueries()
           
 String getQuery(UMOImmutableEndpoint endpoint, String stmt)
           
 String getQueryRunner()
           
 Set getQueryValueExtractors()
           
 String[] getReadAndAckStatements(UMOImmutableEndpoint endpoint)
           
 String getResultSetHandler()
           
protected  void initJndiContext()
           
 String parseStatement(String stmt, List params)
          Parse the given statement filling the parameter list and return the ready to use statement.
 void setDataSource(DataSource dataSource)
           
 void setDataSourceJndiName(String dataSourceJndiName)
           
 void setJndiContext(Context jndiContext)
           
 void setJndiInitialFactory(String jndiInitialFactory)
           
 void setJndiProviderUrl(String jndiProviderUrl)
           
 void setPollingFrequency(long pollingFrequency)
           
 void setProviderProperties(Map providerProperties)
           
 void setQueries(Map queries)
           
 void setQueryRunner(String queryRunner)
           
 void setQueryValueExtractors(Set queryValueExtractors)
           
 void setResultSetHandler(String resultSetHandler)
           
 
Methods inherited from class org.mule.providers.AbstractConnector
checkDisposed, connect, destroyReceiver, disconnect, dispatch, dispose, disposeDispatchers, disposeReceivers, disposeWorkManagers, exceptionThrown, fireNotification, getConnectEventId, getConnectionDescription, getConnectionStrategy, getDefaultInboundTransformer, getDefaultOutboundTransformer, getDefaultResponseTransformer, getDispatcherFactory, getDispatcherThreadingProfile, getDispatcherWorkManager, getExceptionListener, getMaxDispatchersActive, getMessageAdapter, getName, getNumberOfConcurrentTransactedReceivers, getOutputStream, getReceiver, getReceiverKey, getReceivers, getReceivers, getReceiverThreadingProfile, getReceiverWorkManager, getReplyToHandler, getScheduler, getServiceDescriptor, getServiceOverrides, getSessionHandler, getStreamMessageAdapter, getSupportedProtocols, handleException, handleWorkException, initFromServiceDescriptor, initialise, initialiseFromUrl, isConnected, isCreateMultipleTransactedReceivers, isDisposed, isDisposing, isEnableMessageEvents, isRemoteSyncEnabled, isStarted, lookupReceiver, receive, receive, registerListener, registerSupportedProtocol, registerSupportedProtocolWithoutPrefix, send, setConnectionStrategy, setCreateMultipleTransactedReceivers, setDefaultInboundTransformer, setDefaultOutboundTransformer, setDefaultResponseTransformer, setDispatcherFactory, setDispatcherThreadingProfile, setEnableMessageEvents, setExceptionListener, setMaxDispatchersActive, setName, setNumberOfConcurrentTransactedReceivers, setReceiverThreadingProfile, setServiceOverrides, setSessionHandler, setSupportedProtocols, startConnector, stopConnector, supportsProtocol, toString, unregisterListener, unregisterSupportedProtocol, workAccepted, workCompleted, workRejected, workStarted
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROPERTY_POLLING_FREQUENCY

public static final String PROPERTY_POLLING_FREQUENCY
See Also:
Constant Field Values

DEFAULT_POLLING_FREQUENCY

public static final long DEFAULT_POLLING_FREQUENCY
See Also:
Constant Field Values

pollingFrequency

protected long pollingFrequency

dataSource

protected DataSource dataSource

dataSourceJndiName

protected String dataSourceJndiName

jndiContext

protected Context jndiContext

jndiInitialFactory

protected String jndiInitialFactory

jndiProviderUrl

protected String jndiProviderUrl

providerProperties

protected Map providerProperties

queries

protected Map queries

resultSetHandler

protected String resultSetHandler

queryRunner

protected String queryRunner

queryValueExtractors

protected Set queryValueExtractors

propertyExtractors

protected Set propertyExtractors
Constructor Detail

JdbcConnector

public JdbcConnector()
Method Detail

doInitialise

protected void doInitialise()
                     throws InitialisationException
Specified by:
doInitialise in class AbstractConnector
Throws:
InitialisationException

doDispose

protected void doDispose()
Description copied from class: AbstractConnector
Template method to perform any work when destroying the connectoe

Specified by:
doDispose in class AbstractConnector

doConnect

protected void doConnect()
                  throws Exception
Description copied from class: AbstractConnector
Template method where any connections should be made for the connector

Specified by:
doConnect in class AbstractConnector
Throws:
Exception

doDisconnect

protected void doDisconnect()
                     throws Exception
Description copied from class: AbstractConnector
Template method where any connected resources used by the connector should be disconnected

Specified by:
doDisconnect in class AbstractConnector
Throws:
Exception

doStart

protected void doStart()
                throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when starting the connectoe

Specified by:
doStart in class AbstractConnector
Throws:
UMOException - if the method fails

doStop

protected void doStop()
               throws UMOException
Description copied from class: AbstractConnector
Template method to perform any work when stopping the connectoe

Specified by:
doStop in class AbstractConnector
Throws:
UMOException - if the method fails

getProtocol

public String getProtocol()
Returns:
the primary protocol name for endpoints of this connector

createReceiver

public UMOMessageReceiver createReceiver(UMOComponent component,
                                         UMOEndpoint endpoint)
                                  throws Exception
Description copied from class: AbstractConnector
Create a Message receiver for this connector

Overrides:
createReceiver in class AbstractConnector
Parameters:
component - the component that will receive events from this receiver, the listener
endpoint - the endpoint that defies this inbound communication
Returns:
an instance of the message receiver defined in this connectors' TransportServiceDescriptor initialised using the component and endpoint.
Throws:
Exception - if there is a problem creating the receiver. This exception really depends on the underlying transport, thus any exception could be thrown

initJndiContext

protected void initJndiContext()
                        throws NamingException
Throws:
NamingException

createDataSource

protected void createDataSource()
                         throws InitialisationException,
                                NamingException
Throws:
InitialisationException
NamingException

getReadAndAckStatements

public String[] getReadAndAckStatements(UMOImmutableEndpoint endpoint)

getQuery

public String getQuery(UMOImmutableEndpoint endpoint,
                       String stmt)

getDataSource

public DataSource getDataSource()
Returns:
Returns the dataSource.

setDataSource

public void setDataSource(DataSource dataSource)
Parameters:
dataSource - The dataSource to set.

getPollingFrequency

public long getPollingFrequency()
Returns:
Returns the pollingFrequency.

setPollingFrequency

public void setPollingFrequency(long pollingFrequency)
Parameters:
pollingFrequency - The pollingFrequency to set.

getQueries

public Map getQueries()
Returns:
Returns the queries.

setQueries

public void setQueries(Map queries)
Parameters:
queries - The queries to set.

getDataSourceJndiName

public String getDataSourceJndiName()
Returns:
Returns the dataSourceJndiName.

setDataSourceJndiName

public void setDataSourceJndiName(String dataSourceJndiName)
Parameters:
dataSourceJndiName - The dataSourceJndiName to set.

getJndiContext

public Context getJndiContext()
Returns:
Returns the jndiContext.

setJndiContext

public void setJndiContext(Context jndiContext)
Parameters:
jndiContext - The jndiContext to set.

getJndiInitialFactory

public String getJndiInitialFactory()
Returns:
Returns the jndiInitialFactory.

setJndiInitialFactory

public void setJndiInitialFactory(String jndiInitialFactory)
Parameters:
jndiInitialFactory - The jndiInitialFactory to set.

getJndiProviderUrl

public String getJndiProviderUrl()
Returns:
Returns the jndiProviderUrl.

setJndiProviderUrl

public void setJndiProviderUrl(String jndiProviderUrl)
Parameters:
jndiProviderUrl - The jndiProviderUrl to set.

getProviderProperties

public Map getProviderProperties()
Returns:
Returns the providerProperties.

setProviderProperties

public void setProviderProperties(Map providerProperties)
Parameters:
providerProperties - The providerProperties to set.

getConnection

public Connection getConnection()
                         throws Exception
Throws:
Exception

getResultSetHandler

public String getResultSetHandler()
Returns:
Returns the resultSetHandler.

setResultSetHandler

public void setResultSetHandler(String resultSetHandler)
Parameters:
resultSetHandler - The resultSetHandler class name to set.

createResultSetHandler

protected org.apache.commons.dbutils.ResultSetHandler createResultSetHandler()
Returns:
a new instance of the ResultSetHandler class as defined in the JdbcConnector

getQueryValueExtractors

public Set getQueryValueExtractors()

setQueryValueExtractors

public void setQueryValueExtractors(Set queryValueExtractors)

getQueryRunner

public String getQueryRunner()
Returns:
Returns the queryRunner.

setQueryRunner

public void setQueryRunner(String queryRunner)
Parameters:
queryRunner - The QueryRunner class name to set.

createQueryRunner

protected org.apache.commons.dbutils.QueryRunner createQueryRunner()
Returns:
a new instance of the QueryRunner class as defined in the JdbcConnector

parseStatement

public String parseStatement(String stmt,
                             List params)
Parse the given statement filling the parameter list and return the ready to use statement.

Parameters:
stmt -
params -
Returns:

getParams

public Object[] getParams(UMOImmutableEndpoint endpoint,
                          List paramNames,
                          Object message)
                   throws Exception
Throws:
Exception


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.