org.infoglue.cms.applications.workflowtool.function
Class FilePopulator

java.lang.Object
  org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase
      org.infoglue.cms.applications.workflowtool.function.InfoglueFunction
          org.infoglue.cms.applications.workflowtool.function.FilePopulator

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

public class FilePopulator
extends InfoglueFunction

This function is used for populating the propertyset with the contents of a file (stored relative the contextRootPath).

The variables (that is ${...}) in the content of the file will be translated.

Context in

Name	Type	Class	Required	Default	Comments
path	argument	String	true	-	The path of the file (relative the contextRootPath).
key	argument	String	true	-	The key to use when storing the result in the propertyset.

Context out

Name	Type	Class	Comments
<key>	propertyset	DataString	The translated file contents.

Field Summary

Fields inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

LOCALE_PARAMETER, PRINCIPAL_PARAMETER

Fields inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

ERROR_PROPERTYSET_PREFIX, FUNCTION_STATUS_PROPERTYSET_KEY, UTF8_ENCODING, WORKFLOW_PROPERTYSET_PREFIX

Constructor Summary

FilePopulator()
Default constructor.

Method Summary

protected void	execute() Loads the file, translates the content and stores the result in the propertyset.
protected void	initialize() Method used for initializing the function; will be called before execute is called.

Methods inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

execute, getLocale, getPrincipal, getRequestParameter, setFunctionStatus

Methods inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

argumentExists, getArgument, getArgument, getDatabase, getLogger, getParameter, getParameter, getParameter, getParameters, getPropertySet, getPropertySetDataString, getPropertySetString, getVariableFromMaps, parameterExists, propertySetContains, removeFromPropertySet, removeFromPropertySet, setParameter, setPropertySetDataString, setPropertySetString, storeContext, throwException, throwException, translate, translateVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePopulator

public FilePopulator()

Default constructor.

Method Detail

execute

protected void execute()
                throws com.opensymphony.workflow.WorkflowException

Loads the file, translates the content and stores the result in the propertyset.

Specified by:

execute in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the execution.

initialize

protected void initialize()
                   throws com.opensymphony.workflow.WorkflowException

Method used for initializing the function; will be called before execute is called.

Note! You must call super.initialize() first.

Overrides:

initialize in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the initialization.