/*
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.batch;
import java.io.File;
import java.io.FileWriter;
import java.io.Writer;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import nl.nn.adapterframework.core.IPipeLineSession;
import nl.nn.adapterframework.parameters.ParameterResolutionContext;
import nl.nn.adapterframework.util.FileUtils;
import org.apache.commons.lang.StringUtils;
/**
* Resulthandler that writes the transformed record to a file.
*
* <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.batch.Result2Filewriter</td><td> </td></tr>
* <tr><td>{@link #setName(String) name}</td><td>Name of the resulthandler</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. <br/>N.B. If a suffix is set without a prefix, it is only used at the end of processing (i.e. at the end of the file) as a final close</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 #setOnOpenDocument(String) onOpenDocument}</td><td>String that is written before any data of results is written</td><td> </td></tr>
* <tr><td>{@link #setOnCloseDocument(String) onCloseDocument}</td><td>String that is written after all data of results is written</td><td> </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>
* <tr><td>{@link #setBlockByRecordType(boolean) blockByRecordType}</td><td>when set <code>true</code>(default), every group of records, as indicated by {@link IRecordHandler#isNewRecordType(IPipeLineSession, boolean, List, List) RecordHandler#newRecordType} is handled as a block.</td><td>true</td></tr>
* <tr><td>{@link #setOutputDirectory(String) outputDirectory}</td><td>Directory in which the resultfile must be stored</td><td> </td></tr>
* <tr><td>{@link #setFilenamePattern(String) filenamePattern}</td><td>Name of the file is created using the MessageFormat. Params: 1=inputfilename, 2=extension of file, 3=current date</td><td> </td></tr>
* <tr><td>{@link #setMove2dirAfterFinalize(String) move2dirAfterFinalize}</td><td>Directory to which the created file must be moved after finalization (is optional)</td><td> </td></tr>
* </table>
* </p>
*
* @author John Dekker
*/
public class Result2Filewriter extends ResultWriter {
private String outputDirectory;
private String move2dirAfterFinalize;
private String filenamePattern;
private Map openFiles = Collections.synchronizedMap(new HashMap());
public Result2Filewriter() {
super();
setOnOpenDocument("");
setOnCloseDocument("");
}
protected Writer createWriter(IPipeLineSession session, String streamId, ParameterResolutionContext prc) throws Exception {
log.debug("create writer ["+streamId+"]");
String outputFilename = FileUtils.getFilename(null, session, new File(streamId), getFilenamePattern());
File outputFile = new File(outputDirectory, outputFilename);
if (outputFile.exists() && outputFile.isFile()) {
log.warn("Outputfile " + outputFilename + " exists in " + outputDirectory);
}
openFiles.put(streamId,outputFile);
return new FileWriter(outputFile, false);
}
public void closeDocument(IPipeLineSession session, String streamId, ParameterResolutionContext prc) {
File outputFile = (File)openFiles.remove(streamId);
}
public Object finalizeResult(IPipeLineSession session, String streamId, boolean error, ParameterResolutionContext prc) throws Exception {
log.debug("finalizeResult ["+streamId+"]");
super.finalizeResult(session,streamId, error, prc);
super.closeDocument(session,streamId, prc);
File file = (File)openFiles.get(streamId);
if (file==null) {
return null;
}
if (error) {
file.delete();
return null;
}
else {
if (!StringUtils.isEmpty(getMove2dirAfterFinalize())) {
File movedFile = new File(getMove2dirAfterFinalize(), file.getName());
if (movedFile.exists()) {
log.warn("File [" + movedFile.getAbsolutePath() + "] exists, file gets overwritten");
movedFile.delete();
}
file.renameTo(movedFile);
return movedFile.getAbsolutePath();
}
return file.getAbsolutePath();
}
}
public void setMove2dirAfterFinalize(String string) {
move2dirAfterFinalize = string;
}
public String getMove2dirAfterFinalize() {
return move2dirAfterFinalize;
}
public void setFilenamePattern(String string) {
filenamePattern = string;
}
public String getFilenamePattern() {
return filenamePattern;
}
public void setOutputDirectory(String string) {
outputDirectory = string;
}
public String getOutputDirectory() {
return outputDirectory;
}
}