/*
Copyright 2013 Nationale-Nederlanden
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package nl.nn.adapterframework.jdbc;
import java.io.Writer;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import nl.nn.adapterframework.batch.ResultWriter;
import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.configuration.IbisContext;
import nl.nn.adapterframework.core.IPipeLineSession;
import nl.nn.adapterframework.core.SenderException;
import nl.nn.adapterframework.jdbc.dbms.IDbmsSupport;
import nl.nn.adapterframework.parameters.ParameterResolutionContext;
import nl.nn.adapterframework.util.JdbcUtil;
/**
* Baseclass for batch {@link nl.nn.adapterframework.batch.IResultHandler resultHandler} that writes the transformed record to a LOB.
*
* <p><b>Configuration:</b>
* <table border="1">
* <tr><th>attributes</th><th>description</th><th>default</th></tr>
* <tr><td>classname</td><td>nl.nn.adapterframework.jdbc.Result2LobWriterBase</td><td> </td></tr>
* <tr><td>{@link #setName(String) name}</td><td>Name of the resulthandler</td><td> </td></tr>
* <tr><td>{@link #setQuery(String) query}</td><td>the SQL query text</td><td> </td></tr>
* <tr><td>{@link #setDatasourceName(String) datasourceName}</td><td>can be configured from JmsRealm, too</td><td> </td></tr>
* <tr><td>{@link #setDefault(boolean) default}</td><td>If true, this resulthandler is the default for all RecordHandlingFlow that do not have a handler specified</td><td> </td></tr>
* <tr><td>{@link #setPrefix(String) prefix}</td><td><i>Deprecated</i> Prefix that has to be written before record, if the record is in another block than the previous record</td><td> </td></tr>
* <tr><td>{@link #setSuffix(String) suffix}</td><td><i>Deprecated</i> Suffix that has to be written after the record, if the record is in another block than the next record</td><td> </td></tr>
* <tr><td>{@link #setOnOpenDocument(String) onOpenDocument}</td><td>String that is written before any data of results is written</td><td><document name="#name#"></td></tr>
* <tr><td>{@link #setOnCloseDocument(String) onCloseDocument}</td><td>String that is written after all data of results is written</td><td></document></td></tr>
* <tr><td>{@link #setOnOpenBlock(String) onOpenBlock}</td><td>String that is written before the start of each logical block, as defined in the flow</td><td><#name#></td></tr>
* <tr><td>{@link #setOnCloseBlock(String) onCloseBlock}</td><td>String that is written after the end of each logical block, as defined in the flow</td><td></#name#></td></tr>
* <tr><td>{@link #setBlockNamePattern(String) blockNamePattern}</td><td>String that is replaced by name of block or name of stream in above strings</td><td>#name#</td></tr>
* </table>
* <p/>
* <table border="1">
* <tr><th>nested elements</th><th>description</th></tr>
* <tr><td>{@link nl.nn.adapterframework.parameters.Parameter param}</td><td>any parameters defined on the resultHandler will be applied to the SQL statement</td></tr>
* </table>
* <p/>
*
* @author Gerrit van Brakel
* @since 4.7
*/
public abstract class Result2LobWriterBase extends ResultWriter {
protected Map openStreams = Collections.synchronizedMap(new HashMap());
protected Map openConnections = Collections.synchronizedMap(new HashMap());
protected Map openResultSets = Collections.synchronizedMap(new HashMap());
protected Map openLobHandles = Collections.synchronizedMap(new HashMap());
protected FixedQuerySender querySender;
public void configure() throws ConfigurationException {
super.configure();
IbisContext ibisContext = getPipe().getAdapter().getConfiguration().getIbisManager().getIbisContext();
querySender = (FixedQuerySender)ibisContext.createBeanAutowireByName(FixedQuerySender.class);
querySender.setName("querySender of "+getName());
querySender.configure();
}
public void open() throws SenderException {
super.open();
querySender.open();
}
public void close() throws SenderException {
try {
super.close();
} finally {
querySender.close();
}
}
protected abstract Object getLobHandle(IDbmsSupport dbmsSupport, ResultSet rs) throws SenderException;
protected abstract Writer getWriter (IDbmsSupport dbmsSupport, Object lobHandle, ResultSet rs) throws SenderException;
protected abstract void updateLob (IDbmsSupport dbmsSupport, Object lobHandle, ResultSet rs) throws SenderException;
protected Writer createWriter(IPipeLineSession session, String streamId, ParameterResolutionContext prc) throws Exception {
querySender.sendMessage(streamId, streamId);
Connection conn=querySender.getConnection();
openConnections.put(streamId, conn);
PreparedStatement stmt = querySender.getStatement(conn,session.getMessageId(),streamId, true);
ResultSet rs =stmt.executeQuery();
openResultSets.put(streamId,rs);
IDbmsSupport dbmsSupport=querySender.getDbmsSupport();
Object lobHandle=getLobHandle(dbmsSupport, rs);
openLobHandles.put(streamId, lobHandle);
return getWriter(dbmsSupport, lobHandle, rs);
}
public Object finalizeResult(IPipeLineSession session, String streamId, boolean error, ParameterResolutionContext prc) throws Exception {
try {
return super.finalizeResult(session,streamId, error, prc);
} finally {
Object lobHandle = openLobHandles.get(streamId);
Connection conn = (Connection)openResultSets.get(streamId);
ResultSet rs = (ResultSet)openResultSets.get(streamId);
if (rs!=null) {
updateLob(querySender.getDbmsSupport(), lobHandle, rs);
JdbcUtil.fullClose(conn, rs);
}
}
}
public void setQuery(String query) {
querySender.setQuery(query);
}
public void setDatasourceName(String datasourceName) {
querySender.setDatasourceName(datasourceName);
}
public String getPhysicalDestinationName() {
return querySender.getPhysicalDestinationName();
}
public void setJmsRealm(String jmsRealmName) {
querySender.setJmsRealm(jmsRealmName);
}
}