com.aspectran.web.activity.response.view.FreeMarkerViewDispatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspectran Show documentation

Aspectran is a lightweight Java framework for building Enterprise-ready Web applications. Also, It will be able to launch as a Console-based and Embedded application.

There is a newer version: 7.0.5

Show newest version

/**
 * Copyright 2008-2016 Juho Jeong
 *
 * 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 com.aspectran.web.activity.response.view;

import com.aspectran.core.activity.Activity;
import com.aspectran.core.activity.response.dispatch.ViewDispatchException;
import com.aspectran.core.activity.response.dispatch.ViewDispatcher;
import com.aspectran.core.adapter.ResponseAdapter;
import com.aspectran.core.context.rule.DispatchResponseRule;
import com.aspectran.core.context.template.TemplateDataMap;
import com.aspectran.core.util.logging.Log;
import com.aspectran.core.util.logging.LogFactory;

import freemarker.template.Configuration;
import freemarker.template.Template;

/**
 * The Class FreeMarkerViewDispatcher.
 *
 * Created: 2016. 1. 27.
 *
 * @since 2.0.0
 */
public class FreeMarkerViewDispatcher implements ViewDispatcher {

	private static final Log log = LogFactory.getLog(FreeMarkerViewDispatcher.class);

	private static final boolean debugEnabled = log.isDebugEnabled();
	
	private Configuration configuration;

	private String prefix;

	private String suffix;

	public FreeMarkerViewDispatcher(Configuration configuration) {
		this.configuration = configuration;
	}

	/**
	 * Sets the prefix for the template name.
	 *
	 * @param prefix the new prefix for the template name
	 */
	public void setPrefix(String prefix) {
		this.prefix = prefix;
	}

	/**
	 * Sets the suffix for the template name.
	 *
	 * @param suffix the new suffix for the template name
	 */
	public void setSuffix(String suffix) {
		this.suffix = suffix;
	}

	@Override
	public void dispatch(Activity activity, DispatchResponseRule dispatchResponseRule) throws ViewDispatchException {
		String dispatchName = null;

		try {
			dispatchName = dispatchResponseRule.getName(activity);
			if(dispatchName == null)
				throw new IllegalArgumentException("No specified dispatch name.");

			if(prefix != null && suffix != null) {
				dispatchName = prefix + dispatchName + suffix;
			} else if(prefix != null) {
				dispatchName = prefix + dispatchName;
			} else if(suffix != null) {
				dispatchName = dispatchName + suffix;
			}
			
			ResponseAdapter responseAdapter = activity.getResponseAdapter();

			String contentType = dispatchResponseRule.getContentType();
			String characterEncoding = dispatchResponseRule.getCharacterEncoding();

			if(contentType != null)
				responseAdapter.setContentType(contentType);

			if(characterEncoding != null) {
				responseAdapter.setCharacterEncoding(characterEncoding);
			} else {
				characterEncoding = activity.determineResponseCharacterEncoding();
				if(characterEncoding != null)
					responseAdapter.setCharacterEncoding(characterEncoding);
			}
			
			TemplateDataMap model = new TemplateDataMap(activity);

			Template template = configuration.getTemplate(dispatchName);
			template.process(model, responseAdapter.getWriter());

			if(debugEnabled)
				log.debug("Dispatch to a FreeMarker template page [" + dispatchName + "]");

		} catch(Exception e) {
			throw new ViewDispatchException("Failed to dispatch to FreeMarker " + dispatchResponseRule.toString(this, dispatchName), e);
		}
	}

	@Override
	public boolean isSingleton() {
		return true;
	}

}