com.neurosys.content.service.publishers

Class VelocityContentPublisher

java.lang.Object

com.neurosys.content.service.publishers.VelocityContentPublisher

All Implemented Interfaces:

Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Component(value="velocityContentPublisher")
 @Scope(value="prototype")
 @DependsOn(value="appSettings")
public class VelocityContentPublisher
extends Object
implements Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>, org.springframework.context.ApplicationContextAware

A Publisher that uses Velocity to publish HTML files.

This class depends on AppSettings. To be safe ensure any Spring Bean definition either sets it explicitly or depends-on appSettings component

Note: This bean must be a prototype (not a singleton) , as template and related settings are context dependent and hence not thread safe as a singleton.

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
VelocityContentPublisher()
VelocityContentPublisher(org.springframework.context.ApplicationContext springAppContext) springAppContext Allows better Resource resolution.
VelocityContentPublisher(org.springframework.context.ApplicationContext springAppContext, org.apache.velocity.app.VelocityEngine velocityEngine)
VelocityContentPublisher(String path, org.apache.velocity.app.VelocityEngine velocityEngine)
VelocityContentPublisher(org.apache.velocity.Template template)
VelocityContentPublisher(org.apache.velocity.app.VelocityEngine velocityEngine)

Method Summary

Modifier and Type	Method and Description
void	addContext(Map objectMap) Add Context to the Publisher. Note: This will replace any existing context map.
void	autoInitEngine()
void	clearContext() Clear DataMap & Data Context added by this#addContext(Map)
org.apache.velocity.VelocityContext	getContext()
org.apache.velocity.Template	getTemplate()
void	publish(String outputPath) Publish to implementation specific Output and also send a copy back via Writer.
void	publish(Writer writer) Publish output to Writer
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContext(org.apache.velocity.VelocityContext context) Supply a Context to the Publisher Note: This will replace any existing context map.
void	setTemplate(String path) Set path according to following rules of relative paths: Path relative to what is set in velocity.xml resourceLoaderPath If path is an absolute resource like file: or classpath: ...
void	setTemplate(org.apache.velocity.Template template)

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityContentPublisher

public VelocityContentPublisher()

VelocityContentPublisher

public VelocityContentPublisher(String path,
                                org.apache.velocity.app.VelocityEngine velocityEngine)
                         throws org.apache.velocity.exception.ResourceNotFoundException,
                                org.apache.velocity.exception.ParseErrorException,
                                org.apache.velocity.exception.MethodInvocationException,
                                IOException

Throws:

org.apache.velocity.exception.ResourceNotFoundException

org.apache.velocity.exception.ParseErrorException

org.apache.velocity.exception.MethodInvocationException

IOException

VelocityContentPublisher

public VelocityContentPublisher(org.apache.velocity.Template template)

VelocityContentPublisher

public VelocityContentPublisher(org.springframework.context.ApplicationContext springAppContext)

springAppContext Allows better Resource resolution.

Parameters:

springAppContext -

VelocityContentPublisher

public VelocityContentPublisher(org.springframework.context.ApplicationContext springAppContext,
                                org.apache.velocity.app.VelocityEngine velocityEngine)

VelocityContentPublisher

public VelocityContentPublisher(org.apache.velocity.app.VelocityEngine velocityEngine)

Method Detail

autoInitEngine

@PostConstruct
public void autoInitEngine()
                                   throws IOException

Throws:

IOException

addContext

public void addContext(Map objectMap)

Description copied from interface: Publisher

Add Context to the Publisher.
Note: This will replace any existing context map.

Specified by:

addContext in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

Parameters:

objectMap - as Map of Name as String, corresponding Object to insert into Context

publish

public void publish(String outputPath)
             throws IOException

Description copied from interface: Publisher

Publish to implementation specific Output and also send a copy back via Writer.
The outputPath is specified will result in a resource created from the merge of the context into the template.

Specified by:

publish in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

Parameters:

outputPath - as String output path

Throws:

IOException

publish

public void publish(Writer writer)
             throws IOException

Description copied from interface: Publisher

Publish output to Writer

Specified by:

publish in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

Parameters:

writer - as Writer

Throws:

IOException

setTemplate

public void setTemplate(org.apache.velocity.Template template)

Specified by:

setTemplate in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

Parameters:

template - as T

setTemplate

public void setTemplate(String path)
                 throws org.apache.velocity.exception.ResourceNotFoundException,
                        org.apache.velocity.exception.ParseErrorException,
                        org.apache.velocity.exception.MethodInvocationException,
                        IOException

Set path according to following rules of relative paths:

1. Path relative to what is set in velocity.xml resourceLoaderPath
2. If path is an absolute resource like file: or classpath: ... then read absolute path
3. Use ResourceLoader.getResource(String) and derive fle path from the Resource using Resource.getFile()

Specified by:

setTemplate in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

Throws:

org.apache.velocity.exception.ResourceNotFoundException

org.apache.velocity.exception.ParseErrorException

org.apache.velocity.exception.MethodInvocationException

IOException

getContext

public org.apache.velocity.VelocityContext getContext()

setContext

public void setContext(org.apache.velocity.VelocityContext context)

Description copied from interface: Publisher

Supply a Context to the Publisher
Note: This will replace any existing context map.

Specified by:

setContext in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>

getTemplate

public org.apache.velocity.Template getTemplate()

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

clearContext

public void clearContext()

Description copied from interface: Publisher

Clear DataMap & Data Context added by this#addContext(Map)

Specified by:

clearContext in interface Publisher<org.apache.velocity.Template,org.apache.velocity.VelocityContext>