Package org.frankframework.jdbc

Class JdbcTableMessageBrowser<M>

java.lang.Object

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.AbstractJdbcMessageBrowser<M>

org.frankframework.jdbc.JdbcTableMessageBrowser<M>

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IMessageBrowser<M>, IScopeProvider, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

JdbcTransactionalStorage

public class JdbcTableMessageBrowser<M>
extends AbstractJdbcMessageBrowser<M>

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 boolean	useIndexHint

Fields inherited from class org.frankframework.jdbc.AbstractJdbcMessageBrowser

checkCorrelationIdQuery, checkMessageIdQuery, CONTROL_PROPERTY_PREFIX, deleteQuery, getMessageCountQuery, PROPERTY_ASSUME_PRIMARY_KEY_UNIQUE, PROPERTY_USE_PARAMETERS, selectContextQuery, selectDataQuery

Fields inherited from class org.frankframework.jdbc.JdbcFacade

log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
JdbcTableMessageBrowser(JdbcTableListener<M> tableListener)
JdbcTableMessageBrowser(JdbcTableListener<M> tableListener, String statusValue, IMessageBrowser.StorageType storageType)

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
protected void	createQueryTexts(IDbmsSupport dbmsSupport)
protected String	createSelector()
protected String	getFromClause(boolean noAlias)
String	getPhysicalDestinationName()	Returns the name and location of the database that this objects operates on.
protected String	getSelectListQuery(IDbmsSupport dbmsSupport, Date startTime, Date endTime, IMessageBrowser.SortOrder order)
List<MessageBrowserField>	getStorageFields()	Retrieves the field names of the storage
protected String	provideFirstRowsHintAfterFirstKeyword(IDbmsSupport dbmsSupport)
protected String	provideIndexHintAfterFirstKeyword(IDbmsSupport dbmsSupport)
protected String	provideTrailingFirstRowsHint(IDbmsSupport dbmsSupport)
protected RawMessageWrapper<M>	retrieveObject(String storageKey, ResultSet rs, int columnIndex)
void	setIndexName(String string)	Name of the index, to be used in hints for query optimizer too (only for Oracle).
protected void	setOperationControls()
void	setTableName(String tableName)	Name of the table messages are stored in.

Methods inherited from class org.frankframework.jdbc.AbstractJdbcMessageBrowser

applyStandardParameters, applyStandardParameters, browseMessage, containsCorrelationId, containsMessageId, copyFacadeSettings, deleteMessage, getContext, getDatasource, getIterator, getIterator, getLogPrefix, getMessageCount, getWhereClause, setCommentField, setCorrelationIdField, setDateField, setExpiryDateField, setHostField, setIdField, setKeyField, setLabelField, setMessageField, setOrder, setPrefix, setSlotId, setSlotIdField, setType, setTypeField

Methods inherited from class org.frankframework.jdbc.JdbcFacade

getConnection, getConnectionWithTimeout, getDatasourceName, getDbmsSupport, getPassword, isConnectionsArePooled, isRunning, isTransacted, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setName, setPassword, setTransacted, setUsername, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IMessageBrowser

getHideMethod, getHideRegex, setHideMethod, setHideRegex

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Field Details

useIndexHint

protected boolean useIndexHint

Constructor Details

JdbcTableMessageBrowser

public JdbcTableMessageBrowser(JdbcTableListener<M> tableListener)

JdbcTableMessageBrowser

public JdbcTableMessageBrowser(JdbcTableListener<M> tableListener,
 String statusValue,
 IMessageBrowser.StorageType storageType)

Method Details

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 AbstractJdbcMessageBrowser<M>

Throws:

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

setOperationControls

protected void setOperationControls()

Overrides:

setOperationControls in class AbstractJdbcMessageBrowser<M>

retrieveObject

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

Specified by:

retrieveObject in class AbstractJdbcMessageBrowser<M>

Throws:

JdbcException

SQLException

createQueryTexts

protected void createQueryTexts(IDbmsSupport dbmsSupport)
                         throws ConfigurationException

Throws:

ConfigurationException

getFromClause

protected String getFromClause(boolean noAlias)

getSelectListQuery

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

Specified by:

getSelectListQuery in class AbstractJdbcMessageBrowser<M>

createSelector

protected String createSelector()

Overrides:

createSelector in class AbstractJdbcMessageBrowser<M>

provideIndexHintAfterFirstKeyword

protected String provideIndexHintAfterFirstKeyword(IDbmsSupport dbmsSupport)

provideFirstRowsHintAfterFirstKeyword

protected String provideFirstRowsHintAfterFirstKeyword(IDbmsSupport dbmsSupport)

provideTrailingFirstRowsHint

protected String provideTrailingFirstRowsHint(IDbmsSupport dbmsSupport)

getPhysicalDestinationName

public String getPhysicalDestinationName()

Description copied from class: JdbcFacade

Returns the name and location of the database that this objects operates on. If no previous connection was made or it cannot determine the destination it returns 'unknown'

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

Overrides:

getPhysicalDestinationName in class JdbcFacade

See Also:

• HasPhysicalDestination.getPhysicalDestinationName()

setTableName

public void setTableName(String tableName)

Name of the table messages are stored in.

Default value

IBISSTORE

setIndexName

public void setIndexName(String string)

Name of the index, to be used in hints for query optimizer too (only for Oracle).

Default value

IX_IBISSTORE

getStorageFields

public List<MessageBrowserField> getStorageFields()

Description copied from interface: IMessageBrowser

Retrieves the field names of the storage