Class BaseContentProcessor
- java.lang.Object
-
- org.craftercms.studio.impl.v1.content.pipeline.BaseContentProcessor
-
- All Implemented Interfaces:
ContentProcessor
- Direct Known Subclasses:
CleanPreviewContentProcessor
,CleanWorkContentProcessor
,DmWorkflowProcessor
,ExtractParamsProcessor
,FileFolderPathProcessor
,FormNavOrderProcessor
,InvalidateCacheProcessor
,PathMatchProcessor
,PostActivityProcessor
public class BaseContentProcessor extends Object implements ContentProcessor
A base class of content processor- Author:
- hyanghee
-
-
Constructor Summary
Constructors Constructor Description BaseContentProcessor()
default constructorBaseContentProcessor(String name)
constructor that sets the process name
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
checkForMandatoryParam(String key, String value)
check if the mandatory value provided is not emptyString
getName()
get the name of this processorboolean
isProcessable(PipelineContent content)
determines if the content is processable by the given parametersvoid
process(PipelineContent content, ResultTO result)
process the content at the given path.void
setName(String name)
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
_name
protected String _name
the default process name if not set
-
-
Constructor Detail
-
BaseContentProcessor
public BaseContentProcessor()
default constructor
-
BaseContentProcessor
public BaseContentProcessor(String name)
constructor that sets the process name- Parameters:
name
-
-
-
Method Detail
-
setName
public void setName(String name)
- Parameters:
name
- the name to set
-
getName
public String getName()
Description copied from interface:ContentProcessor
get the name of this processor- Specified by:
getName
in interfaceContentProcessor
- Returns:
- processor name
-
isProcessable
public boolean isProcessable(PipelineContent content)
Description copied from interface:ContentProcessor
determines if the content is processable by the given parameters- Specified by:
isProcessable
in interfaceContentProcessor
-
process
public void process(PipelineContent content, ResultTO result) throws ServiceLayerException, UserNotFoundException
Description copied from interface:ContentProcessor
process the content at the given path.- Specified by:
process
in interfaceContentProcessor
- Parameters:
content
- content to processresult
- result to return- Throws:
ContentProcessException
ServiceLayerException
UserNotFoundException
-
checkForMandatoryParam
public void checkForMandatoryParam(String key, String value) throws ContentProcessException
check if the mandatory value provided is not empty- Parameters:
key
- keyvalue
- value- Throws:
ContentProcessException
- mandatory value is empty
-
-