/*
   Copyright 2013, 2016 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.errormessageformatters;

import java.net.URL;

import nl.nn.adapterframework.core.INamedObject;
import nl.nn.adapterframework.util.ClassUtils;
import nl.nn.adapterframework.util.Misc;
import nl.nn.adapterframework.util.XmlUtils;

import javax.xml.transform.Transformer;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.SystemUtils;

/**
 * ErrorMessageFormatter that returns a fixed message with replacements.
 * 
 * <p><b>Configuration:</b>
 * <table border="1">
 * <tr><th>attributes</th><th>description</th><th>default</th></tr>
 * <tr><td>{@link #setFileName(String) fileName}</td><td>name of the file containing the resultmessage</td><td> </td></tr>
 * <tr><td>{@link #setReturnString(String) returnString}</td><td>returned message</td><td> </td></tr>
 * <tr><td>{@link #setReplaceFrom(String) replaceFrom}</td><td>string to search for in the returned message</td><td> </td></tr>
 * <tr><td>{@link #setReplaceTo(String) replaceTo}</td><td>string that will replace each of the strings found in the returned message</td><td> </td></tr>
 * <tr><td>{@link #setStyleSheetName(String) styleSheetName}</td><td>stylesheet to apply to the output message</td><td> </td></tr>
 * </table>
 * 
 * @author  Peter Leeuwenburgh
 * @since   4.3
 */
public class FixedErrorMessage extends ErrorMessageFormatter {
	private ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
	private String fileName = null;
	private String returnString = null;
	private String replaceFrom = null;
	private String replaceTo = null;
	private String styleSheetName = null;

	public String format(
		String message,
		Throwable t,
		INamedObject location,
		String originalMessage,
		String messageId,
		long receivedTime) {

		String stringToReturn = getReturnString();
		if (stringToReturn==null) {
			stringToReturn="";
		}
		if (StringUtils.isNotEmpty(getFileName())) {
			try {
				stringToReturn += Misc.resourceToString(ClassUtils.getResourceURL(classLoader, getFileName()), SystemUtils.LINE_SEPARATOR);
			} catch (Throwable e) {
				log.error("got exception loading error message file [" + getFileName() + "]", e);
			}
		}  
		if (StringUtils.isEmpty(stringToReturn)) {
			stringToReturn = super.format(message, t, location, originalMessage, messageId, receivedTime);
		}

		if (StringUtils.isNotEmpty(getReplaceFrom())) {
			stringToReturn = Misc.replace(stringToReturn, getReplaceFrom(), getReplaceTo() );
		}

		if (StringUtils.isNotEmpty(styleSheetName)) {
			URL xsltSource = ClassUtils.getResourceURL(classLoader, styleSheetName);
			if (xsltSource!=null) {
				try{
					String xsltResult = null;
					Transformer transformer = XmlUtils.createTransformer(xsltSource);
					xsltResult = XmlUtils.transformXml(transformer, stringToReturn);
					stringToReturn = xsltResult;
				} catch (Throwable e) {
					log.error("got error transforming resource [" + xsltSource.toString() + "] from [" + styleSheetName + "]", e);
				}
			}
		}
	
		return stringToReturn;
	}


	public void setReturnString(String string) {
		returnString = string;
	}
	public String getReturnString() {
		return returnString;
	}


	public void setFileName(String fileName) {
		this.fileName = fileName;
	}
	public String getFileName() {
		return fileName;
	}


	public void setReplaceFrom (String replaceFrom){
		this.replaceFrom=replaceFrom;
	}
	public String getReplaceFrom() {
		return replaceFrom;
	}


	public void setReplaceTo (String replaceTo){
		this.replaceTo=replaceTo;
	}
	public String getReplaceTo() {
		return replaceTo;
	}

	public String getStyleSheetName() {
		return styleSheetName;
	}
	public void setStyleSheetName (String styleSheetName){
		this.styleSheetName=styleSheetName;
	}
}