Package org.craftercms.studio.impl.v1.content.pipeline

Class FormDmContentProcessor

java.lang.Object

org.craftercms.studio.impl.v1.content.pipeline.BaseContentProcessor

org.craftercms.studio.impl.v1.content.pipeline.PathMatchProcessor

org.craftercms.studio.impl.v1.content.pipeline.FormDmContentProcessor

All Implemented Interfaces:

ContentProcessor, DmContentProcessor

Direct Known Subclasses:

AssetDmContentProcessor

public class FormDmContentProcessor
extends PathMatchProcessor
implements DmContentProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentRepository	contentRepository
protected ContentRepository	contentRepositoryV1
protected ContentService	contentService
protected ContentService	contentServiceV2
protected ItemServiceInternal	itemServiceInternal
static String	NAME
protected ServicesConfig	servicesConfig
protected WorkflowService	workflowService

Fields inherited from class org.craftercms.studio.impl.v1.content.pipeline.PathMatchProcessor

_matchPaths, _unmatchPaths

Fields inherited from class org.craftercms.studio.impl.v1.content.pipeline.BaseContentProcessor

_name

Constructor Summary

Constructors

Constructor	Description
FormDmContentProcessor()	default constructor
FormDmContentProcessor(String name)	constructor that sets the process name

Method Summary

Modifier and Type	Method	Description
protected boolean	cancelWorkflow(String site, String path)	cancel the pending workflow upon editing the content at the given path?
ContentItemTO	createMissingFoldersInPath(String site, String path, boolean isPreview)	create missing folders in the given path
protected ContentItemTO	createNewFile(String site, ContentItemTO parentItem, String fileName, InputStream input, String user, boolean unlock, ResultTO result)	create new file to the given path.
String	fileToFolder(String site, String path)	change file to folder content.
void	process(PipelineContent content, ResultTO result)	process the content at the given path.
void	setContentRepository(ContentRepository contentRepository)
void	setContentRepositoryV1(ContentRepository contentRepositoryV1)
void	setContentService(ContentService contentService)
void	setContentServiceV2(ContentService contentServiceV2)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setWorkflowService(WorkflowService workflowService)
protected void	unlock(String siteId, String path)
protected void	updateFile(String site, String path, InputStream input, String user, boolean isPreview, boolean unlock, ResultTO result)	update the file at the given content node
protected boolean	updateWorkFlow(String site, String path)
protected void	writeContent(PipelineContent content, ResultTO result)

Methods inherited from class org.craftercms.studio.impl.v1.content.pipeline.PathMatchProcessor

isProcessable, setMatchPaths, setUnmatchPaths

Methods inherited from class org.craftercms.studio.impl.v1.content.pipeline.BaseContentProcessor

checkForMandatoryParam, getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

contentService

protected ContentService contentService

workflowService

protected WorkflowService workflowService

servicesConfig

protected ServicesConfig servicesConfig

contentRepository

protected ContentRepository contentRepository

itemServiceInternal

protected ItemServiceInternal itemServiceInternal

contentRepositoryV1

protected ContentRepository contentRepositoryV1

contentServiceV2

protected ContentService contentServiceV2

Constructor Detail

FormDmContentProcessor

public FormDmContentProcessor()

default constructor

FormDmContentProcessor

public FormDmContentProcessor(String name)

constructor that sets the process name

Parameters:

name -

Method Detail

process

public void process(PipelineContent content,
                    ResultTO result)
             throws ContentProcessException

Description copied from interface: ContentProcessor

process the content at the given path.

Specified by:

process in interface ContentProcessor

Overrides:

process in class BaseContentProcessor

Parameters:

content - content to process

result - result to return

Throws:

ContentProcessException

writeContent

protected void writeContent(PipelineContent content,
                            ResultTO result)
                     throws ServiceLayerException

Throws:

ServiceLayerException

unlock

protected void unlock(String siteId,
                      String path)
               throws ContentNotFoundException,
                      SiteNotFoundException

Throws:

ContentNotFoundException

SiteNotFoundException

createNewFile

protected ContentItemTO createNewFile(String site,
                                      ContentItemTO parentItem,
                                      String fileName,
                                      InputStream input,
                                      String user,
                                      boolean unlock,
                                      ResultTO result)
                               throws ServiceLayerException

create new file to the given path. If the path is a file name, it will create a new folder with the same name as the file name (without the prefix) and move the existing file to the folder created. Then it creates new file to the folder

Parameters:

site - Site name

fileName - new file name

input - file content

user - current user

Throws:

ContentNotFoundException

ServiceLayerException

updateFile

protected void updateFile(String site,
                          String path,
                          InputStream input,
                          String user,
                          boolean isPreview,
                          boolean unlock,
                          ResultTO result)
                   throws ServiceLayerException,
                          UserNotFoundException

update the file at the given content node

Parameters:

input -

user -

isPreview -

unlock - unlock the content upon update?

Throws:

ServiceLayerException

UserNotFoundException

cancelWorkflow

protected boolean cancelWorkflow(String site,
                                 String path)

cancel the pending workflow upon editing the content at the given path?

Parameters:

site -

path -

Returns:

true if workflow needs to be canceled

updateWorkFlow

protected boolean updateWorkFlow(String site,
                                 String path)

createMissingFoldersInPath

public ContentItemTO createMissingFoldersInPath(String site,
                                                String path,
                                                boolean isPreview)
                                         throws ServiceLayerException,
                                                UserNotFoundException

Description copied from interface: DmContentProcessor

create missing folders in the given path

Specified by:

createMissingFoldersInPath in interface DmContentProcessor

Returns:

last child folder in the path

Throws:

ServiceLayerException

UserNotFoundException

fileToFolder

public String fileToFolder(String site,
                           String path)
                    throws ServiceLayerException,
                           UserNotFoundException

Description copied from interface: DmContentProcessor

change file to folder content. See WcmClipboardServiceImpl when updating this logic. Duplicate exists due to prevent circular dependency

Specified by:

fileToFolder in interface DmContentProcessor

Parameters:

site - site id

path - content path

Returns:

new content path

Throws:

ServiceLayerException

UserNotFoundException

setContentService

@Lazy
public void setContentService(ContentService contentService)

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setContentRepository

public void setContentRepository(ContentRepository contentRepository)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setContentRepositoryV1

public void setContentRepositoryV1(ContentRepository contentRepositoryV1)

setContentServiceV2

public void setContentServiceV2(ContentService contentServiceV2)