Package org.frankframework.jdbc

Class AbstractJdbcMessageBrowser<M>

java.lang.Object

org.frankframework.jndi.JndiBase

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.AbstractJdbcMessageBrowser<M>

All Implemented Interfaces:

HasApplicationContext, HasPhysicalDestination, IConfigurable, IMessageBrowser<M>, IScopeProvider, IXAEnabled, NameAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

JdbcTableMessageBrowser

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

JDBC implementation of IMessageBrowser.

Author:

Gerrit van Brakel

Nested Class Summary

Nested classes/interfaces inherited from interface org.frankframework.core.IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields

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

Fields inherited from class org.frankframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor	Description
AbstractJdbcMessageBrowser()

Method Summary

Modifier and Type	Method	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()	Configure this component.
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.
String	getCommentField()
IMessageBrowsingIteratorItem	getContext(String storageKey)	Retrieves the message context as an iteratorItem.
String	getCorrelationIdField()
protected DataSource	getDatasource()
String	getDateField()
String	getExpiryDateField()
IMessageBrowser.HideMethod	getHideMethod()
String	getHideRegex()
String	getHostField()
String	getIdField()
IMessageBrowsingIterator	getIterator()	Gets an enumeration of messages.
IMessageBrowsingIterator	getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order)
String	getKeyField()
String	getLabelField()
protected String	getLogPrefix()
int	getMessageCount()
String	getMessageField()
IMessageBrowser.SortOrder	getOrder()
String	getPrefix()
protected abstract String	getSelectListQuery(IDbmsSupport dbmsSupport, Date startTime, Date endTime, IMessageBrowser.SortOrder order)
String	getSlotId()
String	getSlotIdField()
String	getType()
String	getTypeField()
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
void	setHideMethod(IMessageBrowser.HideMethod hideMethod)	(Only used when hideRegex is not empty) Specifies the way to hide
void	setHideRegex(String hideRegex)	Regular expression to mask strings in the errorStore/logStore.
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. to access a different Oracle schema
protected void	setSlotId(String string)
protected void	setSlotIdField(String string)
protected void	setType(String type)
protected void	setTypeField(String typeField)

Methods inherited from class org.frankframework.jdbc.JdbcFacade

getAuthAlias, getConnection, getConnectionWithTimeout, getDataSourceFactory, getDatasourceName, getDbmsSupport, getDomain, getPassword, getPhysicalDestinationName, getUsername, isConnectionsArePooled, isRunning, isTransacted, setAuthAlias, setConnectionsArePooled, setDataSourceFactory, setDatasourceName, setDbmsSupportFactory, setJmsRealm, setPassword, setTransacted, setUsername, start, stop

Methods inherited from class org.frankframework.jndi.JndiBase

getApplicationContext, getAuthentication, getConfigurationClassLoader, getContext, getCredentials, getInitialContextFactoryName, getJmsRealmName, getJndiAuthAlias, getJndiContextPrefix, getJndiEnv, getJndiProperties, getName, getPrincipal, getProviderURL, getSecurityProtocol, getUrlPkgPrefixes, setApplicationContext, 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 org.frankframework.core.IXAEnabled

isTransacted

Field Details

deleteQuery

protected String deleteQuery

selectContextQuery

protected String selectContextQuery

selectDataQuery

protected String selectDataQuery

checkMessageIdQuery

protected String checkMessageIdQuery

checkCorrelationIdQuery

protected String checkCorrelationIdQuery

getMessageCountQuery

protected String getMessageCountQuery

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 Details

AbstractJdbcMessageBrowser

public AbstractJdbcMessageBrowser()

Method Details

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

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class JdbcFacade

Throws:

ConfigurationException - in case it was not able to configure the component.

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)

getKeyField

public String getKeyField()

getIdField

public String getIdField()

getCorrelationIdField

public String getCorrelationIdField()

getDateField

public String getDateField()

getCommentField

public String getCommentField()

getMessageField

public String getMessageField()

getSlotIdField

public String getSlotIdField()

getExpiryDateField

public String getExpiryDateField()

getLabelField

public String getLabelField()

getPrefix

public String getPrefix()

getSlotId

public String getSlotId()

getType

public String getType()

getTypeField

public String getTypeField()

getHostField

public String getHostField()

getHideRegex

public String getHideRegex()

Specified by:

getHideRegex in interface IMessageBrowser<M>

setHideRegex

public void setHideRegex(String hideRegex)

Description copied from interface: IMessageBrowser

Regular expression to mask strings in the errorStore/logStore. Every character between to the strings in this expression will be replaced by a '*'.
For example, the regular expression (?<=<party>).*?(?=</party>) will replace every character between keys <party> and </party>
When no hideRegex is configured on the errorStore / logStore but is configured on the Receiver.setHideRegex(String), then the Receiver's hideRegex is used for the errorStore / logStore.

Specified by:

setHideRegex in interface IMessageBrowser<M>

getHideMethod

public IMessageBrowser.HideMethod getHideMethod()

Specified by:

getHideMethod in interface IMessageBrowser<M>

setHideMethod

public void setHideMethod(IMessageBrowser.HideMethod hideMethod)

Description copied from interface: IMessageBrowser

(Only used when hideRegex is not empty) Specifies the way to hide

Specified by:

setHideMethod in interface IMessageBrowser<M>

getOrder

public IMessageBrowser.SortOrder getOrder()