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

Class AssetDmContentProcessor

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

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

All Implemented Interfaces:

ContentProcessor, DmContentProcessor

public class AssetDmContentProcessor
extends FormDmContentProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_SIZE_KB
static String	FILE_SIZE_MB
static String	NAME
protected StudioConfiguration	studioConfiguration

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

contentRepository, contentRepositoryV1, contentService, itemServiceInternal, servicesConfig, siteService, userServiceInternal, 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
AssetDmContentProcessor()	default constructor
AssetDmContentProcessor(String name)	constructor that sets the process name

Method Summary

Modifier and Type	Method	Description
StudioConfiguration	getStudioConfiguration()
void	process(PipelineContent content, ResultTO result)	process the content at the given path.
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
protected void	updateFile(String site, ContentItemTO contentItem, String relativePath, InputStream input, String user, boolean isPreview, boolean unlock, ResultTO result)	update the file at the given content node
protected ContentAssetInfoTO	writeContentAsset(PipelineContent content, String site, String user, String path, String assetName, InputStream in, int width, int height, boolean createFolders, boolean isPreview, boolean unlock, boolean isSystemAsset, ResultTO result)	upload content asset to the given path

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

cancelWorkflow, createMissingFoldersInPath, createNewFile, fileToFolder, getContentRepository, getContentRepositoryV1, getContentService, getItemServiceInternal, getServicesConfig, getSiteService, getUserServiceInternal, getWorkflowService, setContentRepository, setContentRepositoryV1, setContentService, setItemServiceInternal, setServicesConfig, setSiteService, setUserServiceInternal, setWorkflowService, updateWorkFlow, writeContent

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

FILE_SIZE_MB

public static final String FILE_SIZE_MB

See Also:

Constant Field Values

FILE_SIZE_KB

public static final String FILE_SIZE_KB

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

studioConfiguration

protected StudioConfiguration studioConfiguration

Constructor Detail

AssetDmContentProcessor

public AssetDmContentProcessor()

default constructor

AssetDmContentProcessor

public AssetDmContentProcessor(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 FormDmContentProcessor

Parameters:

content - content to process

result - result to return

Throws:

ContentProcessException

writeContentAsset

protected ContentAssetInfoTO writeContentAsset(PipelineContent content,
                                               String site,
                                               String user,
                                               String path,
                                               String assetName,
                                               InputStream in,
                                               int width,
                                               int height,
                                               boolean createFolders,
                                               boolean isPreview,
                                               boolean unlock,
                                               boolean isSystemAsset,
                                               ResultTO result)
                                        throws ServiceLayerException,
                                               UserNotFoundException

upload content asset to the given path

Parameters:

site -

path -

assetName -

in - input stream to read the asset from

width -

height -

createFolders - create missing folders?

isPreview -

unlock - unlock the content upon update?

Returns:

asset information

Throws:

ServiceLayerException

UserNotFoundException

updateFile

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

update the file at the given content node

Overrides:

updateFile in class FormDmContentProcessor

Parameters:

input -

user -

isPreview -

unlock - unlock the content upon update?

Throws:

ServiceLayerException

UserNotFoundException

getStudioConfiguration

public StudioConfiguration getStudioConfiguration()

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)