Package org.springframework.integration.jdbc.store.channel

Class ChannelMessageStorePreparedStatementSetter

java.lang.Object

org.springframework.integration.jdbc.store.channel.ChannelMessageStorePreparedStatementSetter

public class ChannelMessageStorePreparedStatementSetter
extends Object

Callback to be used with the JdbcChannelMessageStore.

Behavior is same as standard PreparedStatementSetter, it takes in additional Message<?> requestMessage, Object groupId, String region and boolean priorityEnabled parameters used for addMessageToGroup method in the JdbcChannelMessageStore.

This class can be extended for any custom data structure or columns types. For this purpose the protected constructor is provided for inheritors. In this case the serializer is null to avoid extra serialization actions if the target custom behavior doesn't imply them.

Since:

5.0

Author:

Meherzad Lahewala, Artem Bilan

See Also:

• PreparedStatementSetter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChannelMessageStorePreparedStatementSetter()	The default constructor for inheritors who are not interested in the message serialization to byte[].
	ChannelMessageStorePreparedStatementSetter(SerializingConverter serializer)	Instantiate a ChannelMessageStorePreparedStatementSetter with the provided serializer and lobHandler, which both must not be null.
	ChannelMessageStorePreparedStatementSetter(SerializingConverter serializer, LobHandler lobHandler)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.4 (for removal) (if favor of ChannelMessageStorePreparedStatementSetter(SerializingConverter)) with a plain JDBC driver support for byte arrays.

Method Summary

Modifier and Type	Method	Description
void	setValues(PreparedStatement preparedStatement, Message<?> requestMessage, Object groupId, String region, boolean priorityEnabled)	Perform a preparedStatement parameters population according provided arguments.

Methods inherited from class java.lang.Object

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

Constructor Details

ChannelMessageStorePreparedStatementSetter

@Deprecated(forRemoval=true,
            since="6.4")
public ChannelMessageStorePreparedStatementSetter(SerializingConverter serializer,
 LobHandler lobHandler)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.4 (for removal) (if favor of ChannelMessageStorePreparedStatementSetter(SerializingConverter)) with a plain JDBC driver support for byte arrays.

Instantiate a ChannelMessageStorePreparedStatementSetter with the provided serializer and lobHandler, which both must not be null.

Parameters:

serializer - the SerializingConverter to build byte[] from the request message

lobHandler - the LobHandler to store byte[] of the request message to prepared statement

ChannelMessageStorePreparedStatementSetter

public ChannelMessageStorePreparedStatementSetter(SerializingConverter serializer)

Instantiate a ChannelMessageStorePreparedStatementSetter with the provided serializer and lobHandler, which both must not be null.

Parameters:

serializer - the SerializingConverter to build byte[] from the request message

Since:

6.4

ChannelMessageStorePreparedStatementSetter

protected ChannelMessageStorePreparedStatementSetter()

The default constructor for inheritors who are not interested in the message serialization to byte[]. The serializer is null from this constructor, therefore any serialization isn't happened in the default setValues(java.sql.PreparedStatement, org.springframework.messaging.Message<?>, java.lang.Object, java.lang.String, boolean) implementation. A target implementor must ensure the proper custom logic for storing message.

Method Details

setValues

public void setValues(PreparedStatement preparedStatement,
 Message<?> requestMessage,
 Object groupId,
 String region,
 boolean priorityEnabled)
               throws SQLException

Perform a preparedStatement parameters population according provided arguments. The default functionality is (parameter - data):

• 1 - messageId
• 2 - groupKey
• 3 - region
• 4 - createdDate
• 5 - priority if enabled, otherwise null
• 6 - serialized message if serializer is provided.

An inheritor may consider to call this method for population common properties and perform custom message serialization logic for the parameter #6. Any custom data structure population can be achieved with full overriding of this method.

Parameters:

preparedStatement - the PreparedStatement to populate columns based on the provided arguments

requestMessage - the Message to store

groupId - the group id for the message to store

region - the region in the target table to distinguish different database clients

priorityEnabled - the flag to indicate if priority has to be stored

Throws:

SQLException - the exception throws during data population