org.mule.module.db.internal.processor

Class AbstractDbMessageProcessor

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.processor.AbstractInterceptingMessageProcessorBase

org.mule.processor.AbstractInterceptingMessageProcessor

org.mule.module.db.internal.processor.AbstractDbMessageProcessor

All Implemented Interfaces:

AnnotatedObject, MuleContextAware, DebugInfoProvider, Initialisable, InterceptingMessageProcessor, MessageProcessor, MessageProcessorContainer, MessageSource, org.mule.common.Capability, org.mule.common.metadata.MetaDataDescriptor, org.mule.common.metadata.OperationMetaDataEnabled

Direct Known Subclasses:

AbstractBulkUpdateMessageProcessor, AbstractSingleQueryDbMessageProcessor, BulkExecuteMessageProcessor

public abstract class AbstractDbMessageProcessor
extends AbstractInterceptingMessageProcessor
implements Initialisable, InterceptingMessageProcessor, org.mule.common.metadata.OperationMetaDataEnabled, DebugInfoProvider

Base class for database message processors.

Field Summary

Fields

Modifier and Type	Field and Description
protected DbConfigResolver	dbConfigResolver

Fields inherited from class org.mule.processor.AbstractInterceptingMessageProcessorBase

logger, muleContext, next, notificationHandler

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractDbMessageProcessor(DbConfigResolver dbConfigResolver, TransactionalAction transactionalAction)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Object	executeQuery(DbConnection connection, MuleEvent muleEvent)
List<FieldDebugInfo<?>>	getDebugInfo(MuleEvent muleEvent) Returns debug information about the fields of this object.
org.mule.common.Result<org.mule.common.metadata.MetaData>	getInputMetaData()
protected abstract List<FieldDebugInfo<?>>	getMessageProcessorDebugInfo(DbConnection connection, MuleEvent muleEvent)
org.mule.common.Result<org.mule.common.metadata.MetaData>	getOutputMetaData(org.mule.common.metadata.MetaData metaData)
QueryMetadataProvider	getQueryMetadataProvider()
String	getSource()
String	getTarget()
protected abstract List<QueryType>	getValidQueryTypes()
void	initialise() Method used to perform any initialisation work.
protected boolean	mustCloseConnection()
MuleEvent	process(MuleEvent muleEvent) Invokes the MessageProcessor.
protected MuleEvent	resolveSource(MuleEvent muleEvent)
void	setQueryMetadataProvider(QueryMetadataProvider queryMetadataProvider)
void	setSource(String source)
void	setStatementStreamingResultSetCloser(StatementStreamingResultSetCloser streamingResultSetCloser)
void	setTarget(String target)
protected void	validateQueryType(QueryTemplate queryTemplate)

Methods inherited from class org.mule.processor.AbstractInterceptingMessageProcessorBase

addMessageProcessorPathElements, getListener, getMuleContext, isEventValid, processNext, setListener, setMuleContext, toString

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.source.MessageSource

setListener

Field Detail

dbConfigResolver

protected final DbConfigResolver dbConfigResolver

Constructor Detail

AbstractDbMessageProcessor

public AbstractDbMessageProcessor(DbConfigResolver dbConfigResolver,
                          TransactionalAction transactionalAction)

Method Detail

process

public MuleEvent process(MuleEvent muleEvent)
                  throws MuleException

Description copied from interface: MessageProcessor

Invokes the MessageProcessor.

Specified by:

process in interface MessageProcessor

Parameters:

muleEvent - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

MuleException

mustCloseConnection

protected boolean mustCloseConnection()

resolveSource

protected MuleEvent resolveSource(MuleEvent muleEvent)

executeQuery

protected abstract Object executeQuery(DbConnection connection,
                  MuleEvent muleEvent)
                                throws SQLException

Throws:

SQLException

initialise

public void initialise()
                throws InitialisationException

Description copied from interface: Initialisable

Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown, causing the Mule instance to shutdown. If the error is recoverable, say by retrying to connect, a RecoverableException should be thrown. There is no guarantee that by throwing a Recoverable exception that the Mule instance will not shut down.

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

RecoverableException - if an error occurs that can be recovered from

setQueryMetadataProvider

public void setQueryMetadataProvider(QueryMetadataProvider queryMetadataProvider)

getQueryMetadataProvider

public QueryMetadataProvider getQueryMetadataProvider()

getOutputMetaData

public org.mule.common.Result<org.mule.common.metadata.MetaData> getOutputMetaData(org.mule.common.metadata.MetaData metaData)

Specified by:

getOutputMetaData in interface org.mule.common.metadata.MetaDataDescriptor

getInputMetaData

public org.mule.common.Result<org.mule.common.metadata.MetaData> getInputMetaData()

Specified by:

getInputMetaData in interface org.mule.common.metadata.MetaDataDescriptor

getSource

public String getSource()

setSource

public void setSource(String source)

getTarget

public String getTarget()

setTarget

public void setTarget(String target)

setStatementStreamingResultSetCloser

public void setStatementStreamingResultSetCloser(StatementStreamingResultSetCloser streamingResultSetCloser)

validateQueryType

protected void validateQueryType(QueryTemplate queryTemplate)

getDebugInfo

public List<FieldDebugInfo<?>> getDebugInfo(MuleEvent muleEvent)

Description copied from interface: DebugInfoProvider

Returns debug information about the fields of this object.

Specified by:

getDebugInfo in interface DebugInfoProvider

Parameters:

muleEvent - event used while debugging. Non null

Returns:

a non null List

getMessageProcessorDebugInfo

protected abstract List<FieldDebugInfo<?>> getMessageProcessorDebugInfo(DbConnection connection,
                                                   MuleEvent muleEvent)

getValidQueryTypes

protected abstract List<QueryType> getValidQueryTypes()