nl.nn.adapterframework.jdbc

Class JdbcMessageBrowser<M>

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

nl.nn.adapterframework.jdbc.JdbcMessageBrowser<M>

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IMessageBrowser<M>, INamedObject, IScopeProvider, IXAEnabled, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

JdbcTableMessageBrowser

public abstract class JdbcMessageBrowser<M>
extends JdbcFacade
implements IMessageBrowser<M>

JDBC implementation of IMessageBrowser.

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.core.IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected String	checkCorrelationIdQuery
protected String	checkMessageIdQuery
protected static String	CONTROL_PROPERTY_PREFIX
protected String	deleteQuery
protected String	getMessageCountQuery
protected static String	PROPERTY_ASSUME_PRIMARY_KEY_UNIQUE
protected static String	PROPERTY_USE_PARAMETERS
protected String	selectContextQuery
protected String	selectDataQuery
protected boolean	selectKeyQueryIsDbmsSupported

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
JdbcMessageBrowser()

Method Summary

Modifier and Type	Method and Description
protected int	applyStandardParameters(PreparedStatement stmt, boolean moreParametersFollow, boolean primaryKeyIsPartOfClause)
protected int	applyStandardParameters(PreparedStatement stmt, String paramValue, boolean primaryKeyIsPartOfClause)
RawMessageWrapper<M>	browseMessage(String storageKey) Retrieves the message, but does not delete.
void	configure()
boolean	containsCorrelationId(String correlationId)
boolean	containsMessageId(String originalMessageId) Check if the storage contains message with the given original messageId (as passed to storeMessage).
void	copyFacadeSettings(JdbcFacade facade)
protected String	createSelector()
void	deleteMessage(String storageKey) Deletes the message.
IMessageBrowsingIteratorItem	getContext(String storageKey) Retrieves the message context as an iteratorItem.
protected DataSource	getDatasource()
IMessageBrowsingIterator	getIterator() Gets an enumeration of messages.
IMessageBrowsingIterator	getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order)
protected String	getLogPrefix()
int	getMessageCount()
protected abstract String	getSelectListQuery(IDbmsSupport dbmsSupport, Date startTime, Date endTime, IMessageBrowser.SortOrder order)
protected String	getWhereClause(String clause, boolean primaryKeyIsPartOfClause)
protected abstract RawMessageWrapper<M>	retrieveObject(String storageKey, ResultSet rs, int columnIndex)
void	setCommentField(String string) The name of the column comments are stored in
void	setCorrelationIdField(String string) The name of the column correlation-ids are stored in
void	setDateField(String string) The name of the column the timestamp is stored in
void	setExpiryDateField(String string) The name of the column the timestamp for expiry is stored in
protected void	setHostField(String hostField)
void	setIdField(String idField) The name of the column messageIds are stored in
void	setKeyField(String string) The name of the column that contains the primary key of the table
void	setLabelField(String string) The name of the column labels are stored in
void	setMessageField(String messageField) The name of the column message themselves are stored in
protected void	setOperationControls()
void	setOrder(IMessageBrowser.SortOrder value)
void	setPrefix(String string) Prefix to be prefixed on all database objects (tables, indices, sequences), e.g.
protected void	setSlotId(String string)
protected void	setSlotIdField(String string)
protected void	setType(String type)
protected void	setTypeField(String typeField)

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcFacade

getAuthAlias, getConnection, getConnectionWithTimeout, getDatasourceInfo, getDatasourceName, getDbmsSupport, getPassword, getPhysicalDestinationName, getUsername, isConnectionsArePooled, isTransacted, iterateOverStatistics, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setJmsRealm, setPassword, setTransacted, setUsername

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

close, getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.IMessageBrowser

getHideMethod, getHideRegex, setHideMethod, setHideRegex

Methods inherited from interface nl.nn.adapterframework.core.IXAEnabled

isTransacted

Methods inherited from interface nl.nn.adapterframework.core.HasPhysicalDestination

getDomain

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

deleteQuery

protected String deleteQuery

selectContextQuery

protected String selectContextQuery

selectDataQuery

protected String selectDataQuery

checkMessageIdQuery

protected String checkMessageIdQuery

checkCorrelationIdQuery

protected String checkCorrelationIdQuery

getMessageCountQuery

protected String getMessageCountQuery

selectKeyQueryIsDbmsSupported

protected boolean selectKeyQueryIsDbmsSupported

CONTROL_PROPERTY_PREFIX

protected static final String CONTROL_PROPERTY_PREFIX

See Also:

Constant Field Values

PROPERTY_USE_PARAMETERS

protected static final String PROPERTY_USE_PARAMETERS

See Also:

Constant Field Values

PROPERTY_ASSUME_PRIMARY_KEY_UNIQUE

protected static final String PROPERTY_ASSUME_PRIMARY_KEY_UNIQUE

See Also:

Constant Field Values

Constructor Detail

JdbcMessageBrowser

public JdbcMessageBrowser()

Method Detail

getLogPrefix

protected String getLogPrefix()

Overrides:

getLogPrefix in class JdbcFacade

setOperationControls

protected void setOperationControls()

copyFacadeSettings

public void copyFacadeSettings(JdbcFacade facade)
                        throws JdbcException

Throws:

JdbcException

getDatasource

protected DataSource getDatasource()
                            throws JdbcException

Overrides:

getDatasource in class JdbcFacade

Throws:

JdbcException

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JdbcFacade

Throws:

ConfigurationException

getSelectListQuery

protected abstract String getSelectListQuery(IDbmsSupport dbmsSupport,
                                             Date startTime,
                                             Date endTime,
                                             IMessageBrowser.SortOrder order)

getWhereClause

protected String getWhereClause(String clause,
                                boolean primaryKeyIsPartOfClause)

createSelector

protected String createSelector()

applyStandardParameters

protected int applyStandardParameters(PreparedStatement stmt,
                                      boolean moreParametersFollow,
                                      boolean primaryKeyIsPartOfClause)
                               throws SQLException

Throws:

SQLException

applyStandardParameters

protected int applyStandardParameters(PreparedStatement stmt,
                                      String paramValue,
                                      boolean primaryKeyIsPartOfClause)
                               throws SQLException

Throws:

SQLException

getIterator

public IMessageBrowsingIterator getIterator()
                                     throws ListenerException

Description copied from interface: IMessageBrowser

Gets an enumeration of messages. This includes setting up connections, sessions etc.

Specified by:

getIterator in interface IMessageBrowser<M>

Throws:

ListenerException

getIterator

public IMessageBrowsingIterator getIterator(Date startTime,
                                            Date endTime,
                                            IMessageBrowser.SortOrder order)
                                     throws ListenerException

Specified by:

getIterator in interface IMessageBrowser<M>

Throws:

ListenerException

deleteMessage

public void deleteMessage(String storageKey)
                   throws ListenerException

Description copied from interface: IMessageBrowser

Deletes the message.

Specified by:

deleteMessage in interface IMessageBrowser<M>

Throws:

ListenerException

retrieveObject

protected abstract RawMessageWrapper<M> retrieveObject(String storageKey,
                                                       ResultSet rs,
                                                       int columnIndex)
                                                throws SQLException,
                                                       JdbcException

Throws:

SQLException

JdbcException

getMessageCount

public int getMessageCount()
                    throws ListenerException

Specified by:

getMessageCount in interface IMessageBrowser<M>

Throws:

ListenerException

containsMessageId

public boolean containsMessageId(String originalMessageId)
                          throws ListenerException

Description copied from interface: IMessageBrowser

Check if the storage contains message with the given original messageId (as passed to storeMessage).

Specified by:

containsMessageId in interface IMessageBrowser<M>

Throws:

ListenerException

containsCorrelationId

public boolean containsCorrelationId(String correlationId)
                              throws ListenerException

Specified by:

containsCorrelationId in interface IMessageBrowser<M>

Throws:

ListenerException

getContext

public IMessageBrowsingIteratorItem getContext(String storageKey)
                                        throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message context as an iteratorItem. The result can be used in the methods above that use an iteratorItem. Use this method as try-with-resources to close the connections.

Specified by:

getContext in interface IMessageBrowser<M>

Throws:

ListenerException

browseMessage

public RawMessageWrapper<M> browseMessage(String storageKey)
                                   throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message, but does not delete.

Specified by:

browseMessage in interface IMessageBrowser<M>

Throws:

ListenerException

setKeyField

public void setKeyField(String string)

The name of the column that contains the primary key of the table

Default value

MESSAGEKEY

setIdField

public void setIdField(String idField)

The name of the column messageIds are stored in

Default value

MESSAGEID

setCorrelationIdField

public void setCorrelationIdField(String string)

The name of the column correlation-ids are stored in

Default value

CORRELATIONID

setMessageField

public void setMessageField(String messageField)

The name of the column message themselves are stored in

Default value

MESSAGE

setDateField

public void setDateField(String string)

The name of the column the timestamp is stored in

Default value

MESSAGEDATE

setCommentField

public void setCommentField(String string)

The name of the column comments are stored in

Default value

COMMENTS

setExpiryDateField

public void setExpiryDateField(String string)

The name of the column the timestamp for expiry is stored in

Default value

EXPIRYDATE

setLabelField

public void setLabelField(String string)

The name of the column labels are stored in

Default value

LABEL

setSlotIdField

protected void setSlotIdField(String string)

setTypeField

protected void setTypeField(String typeField)

setHostField

protected void setHostField(String hostField)

setPrefix

public void setPrefix(String string)

Prefix to be prefixed on all database objects (tables, indices, sequences), e.g. to access a different Oracle schema

setSlotId

protected void setSlotId(String string)

setType

protected void setType(String type)

setOrder

public void setOrder(IMessageBrowser.SortOrder value)