Package org.craftercms.studio.api.v1.service.content

Interface ContentService

All Known Implementing Classes:

ContentServiceImpl

public interface ContentService

Content Services that other services may use

Author:

russdanner

Method Summary

Modifier and Type	Method	Description
void	checkContentExists(String site, String path)	Checks if a content exists at a given path and throw an exception if it does not.
void	checkWriteAssetPath(String path)	Check if path is a correct location to write asset content
boolean	contentExists(String site, String path)	Check if content exists
String	copyContent(String site, String fromPath, String toPath)	copy content fromPath to toPath
ContentItemTO	createDummyDmContentItemForDeletedNode(String site, String relativePath)
boolean	createFolder(String site, String path, String name)	create a folder
boolean	deleteContent(String site, String path, boolean generateActivity, String approver)
boolean	deleteContent(String site, String path, String approver)	delete content at the path
InputStream	getContent(String site, String path)	get document from wcm content
org.dom4j.Document	getContentAsDocument(String site, String path)	get document from wcm content
org.springframework.core.io.Resource	getContentAsResource(String site, String path)	Returns content wrapped as a Resource instance
String	getContentAsString(String site, String path)	get content as string from repository
String	getContentAsString(String site, String path, String encoding)	get content as string from repository
ContentItemTO	getContentItem(String site, String path)	get the content item (metadata) at a specific path
ContentItemTO	getContentItem(String site, String path, int depth)	get the content item (metadata) at a specific path
ContentItemTO	getContentItemTree(String site, String path, int depth)	get the tree of content items (metadata) beginning at a root
VersionTO[]	getContentItemVersionHistory(String site, String path)	get the version history for an item
long	getContentSize(String site, String path)	get file size
String	getContentTypeClass(String site, String uri)
Optional<org.springframework.core.io.Resource>	getContentVersion(String site, String path, String version)	return the content for a given version
String	getContentVersionAsString(String site, String path, String version)	return the content for a given version
GoLiveDeleteCandidates	getDeleteCandidates(String site, String uri)
String	getItemContentType(String site, String path)	Retrieves the content type for a given path
List<DmOrderTO>	getItemOrders(String site, String path)
String	getNextAvailableName(String site, String path)	get the next available of the given content name at the given path (used for paste/duplicate)
void	lockContent(String site, String path)
String	moveContent(String site, String fromPath, String toPath)	move content fromPath to toPath
void	notifyContentEvent(String site, String path)	Notify when there is a content update
boolean	pullFromRemote(String siteId, String remoteName, String remoteBranch)	Pull from remote repository
boolean	pushToRemote(String siteId, String remoteName, String remoteBranch)	Push content to remote repository
boolean	renameContent(String site, String path, String name)	rename a content item
double	reorderItems(String site, String relativePath, String before, String after, String orderName)
boolean	revertContentItem(String site, String path, String version, boolean major, String comment)	revert a version (create a new version based on an old version)
boolean	shallowContentExists(String site, String path)	This is a faster, but less accurate, version of contentExists.
String	shallowGetContentAsString(String siteId, String path)	Get content from the repository.
boolean	validateAndCreateFolder(String site, String path, String name)	Validate the input and create a folder
String	writeContent(String site, String path, InputStream content)	write content
void	writeContent(String site, String path, String fileName, String contentType, InputStream input, String createFolders, String edit, String unlock)	write content
void	writeContent(String site, String path, String fileName, String contentType, InputStream input, String createFolders, String edit, String unlock, boolean skipAuditLogInsert)	write content
boolean	writeContentAndNotify(String site, String path, InputStream content)	write content from an input stream and notify the subscribers.
void	writeContentAndRename(String site, String path, String targetPath, String fileName, String contentType, InputStream input, String createFolders, String edit, String unlock, boolean createFolder)
Map<String,Object>	writeContentAsset(String site, String path, String assetName, InputStream in, String isImage, String allowedWidth, String allowedHeight, String allowLessSize, String draft, String unlock, String systemAsset)

Method Details

contentExists

boolean contentExists(String site,
 String path)

Check if content exists

Parameters:

site - site identifier

path - path of the content

Returns:

true if site has content object at path

checkContentExists

void checkContentExists(String site,
 String path)
                 throws ServiceLayerException

Checks if a content exists at a given path and throw an exception if it does not.

Parameters:

site - id of the site

path - the content path

Throws:

ServiceLayerException - if no content is found at the given path

shallowContentExists

boolean shallowContentExists(String site,
 String path)

This is a faster, but less accurate, version of contentExists. This prioritizes performance over checking the actual underlying repository if the content is actually in the store or we simply hold a reference to the object in the actual store.

Returns:

true if site has content object at path

getContent

InputStream getContent(String site,
 String path)
                throws ContentNotFoundException

get document from wcm content

Parameters:

site - site identifier

path - path of the content

Returns:

document

Throws:

ContentNotFoundException

getContentSize

long getContentSize(String site,
 String path)

get file size

Parameters:

site - site id where the operation will be executed

path - path to content

Returns:

Size in bytes

getContentAsString

String getContentAsString(String site,
 String path)

get content as string from repository

Parameters:

site - site identifier

path - path of the content

Returns:

document

checkWriteAssetPath

void checkWriteAssetPath(String path)
                  throws ServiceLayerException

Check if path is a correct location to write asset content

Parameters:

path - to write asset

Throws:

ServiceLayerException - if path is not permitted

getContentAsString

String getContentAsString(String site,
 String path,
 String encoding)

get content as string from repository

Parameters:

site - site identifier

path - path of the content

encoding - file encoding

Returns:

document

shallowGetContentAsString

String shallowGetContentAsString(String siteId,
 String path)

Get content from the repository. This "shallow" version of the method will retrieve the content from disk instead of the git repository.

Parameters:

siteId - the site id

path - the path of the content

Returns:

the content as a string

getContentAsDocument

org.dom4j.Document getContentAsDocument(String site,
 String path)
                                 throws org.dom4j.DocumentException

get document from wcm content

Parameters:

site - site identifier

path - content path

Returns:

document

Throws:

org.dom4j.DocumentException - XML document error

getContentAsResource

org.springframework.core.io.Resource getContentAsResource(String site,
 String path)
                                                   throws ContentNotFoundException

Returns content wrapped as a Resource instance

Parameters:

site - the site id

path - the path of the content

Returns:

the resource object

Throws:

ContentNotFoundException - if there is no content at the given path

Since:

3.1.1

writeContent

String writeContent(String site,
 String path,
 InputStream content)
             throws ServiceLayerException

write content

Parameters:

site - - the project ID

path - path to content

content - stream of content to write

Returns:

return new commit id

Throws:

ServiceLayerException - general service error

writeContentAndNotify

boolean writeContentAndNotify(String site,
 String path,
 InputStream content)
                       throws ServiceLayerException

write content from an input stream and notify the subscribers.

Parameters:

site - - the project ID

path - path to content

content - stream of content to write

Returns:

return true if successful

Throws:

ServiceLayerException - general service error

notifyContentEvent

void notifyContentEvent(String site,
 String path)

Notify when there is a content update

Parameters:

site - site name

path - path name

validateAndCreateFolder

boolean validateAndCreateFolder(String site,
 String path,
 String name)
                         throws ServiceLayerException,
UserNotFoundException,
org.craftercms.commons.validation.ValidationException

Validate the input and create a folder

Parameters:

site - - the project ID

path - path to create a folder in

name - a folder name to create

Returns:

return the reference to the folder created

Throws:

ServiceLayerException

UserNotFoundException

org.craftercms.commons.validation.ValidationException

createFolder

boolean createFolder(String site,
 String path,
 String name)
              throws ServiceLayerException,
UserNotFoundException

create a folder

Parameters:

site - - the project ID

path - path to create a folder in

name - a folder name to create

Returns:

return the reference to the folder created

Throws:

SiteNotFoundException - site not found

ServiceLayerException

UserNotFoundException

deleteContent

boolean deleteContent(String site,
 String path,
 String approver)
               throws ServiceLayerException,
UserNotFoundException

delete content at the path

Parameters:

site - - the project ID

path - path to content

Returns:

return true if successful

Throws:

SiteNotFoundException - site not found

ServiceLayerException

UserNotFoundException

deleteContent

boolean deleteContent(String site,
 String path,
 boolean generateActivity,
 String approver)
               throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

copyContent

String copyContent(String site,
 String fromPath,
 String toPath)
            throws ServiceLayerException,
UserNotFoundException

copy content fromPath to toPath

Parameters:

site - - the project ID

fromPath - the source path

toPath - the target path to copy content to

Returns:

final path if successful, null otherwise

Throws:

ServiceLayerException

UserNotFoundException

moveContent

String moveContent(String site,
 String fromPath,
 String toPath)

move content fromPath to toPath

Parameters:

site - - the project ID

fromPath - the source path

toPath - the target path to copy content to

Returns:

final path if successful, null otherwise

getContentItemTree

ContentItemTO getContentItemTree(String site,
 String path,
 int depth)

get the tree of content items (metadata) beginning at a root

Parameters:

site - - the project ID

path - - the path to root at

Returns:

content item with children tree

getContentItem

ContentItemTO getContentItem(String site,
 String path)

get the content item (metadata) at a specific path

Parameters:

site - - the project ID

path - - the path of the content item

Returns:

content item representation

getContentItem

ContentItemTO getContentItem(String site,
 String path,
 int depth)

get the content item (metadata) at a specific path

Parameters:

site - - the project ID

path - - the path of the content item

depth - - depth to get desendents

Returns:

content item representation

getItemContentType

String getItemContentType(String site,
 String path)
                   throws org.dom4j.DocumentException,
SiteNotFoundException

Retrieves the content type for a given path

Parameters:

site - the site id

path - the content path

Returns:

content type

Throws:

org.dom4j.DocumentException - on failure to retrieve the content type from xml (when applicable)

SiteNotFoundException

getContentItemVersionHistory

VersionTO[] getContentItemVersionHistory(String site,
 String path)

get the version history for an item

Parameters:

site - - the project ID

path - - the path of the item

Returns:

version history

revertContentItem

boolean revertContentItem(String site,
 String path,
 String version,
 boolean major,
 String comment)
                   throws ServiceLayerException,
UserNotFoundException

revert a version (create a new version based on an old version)

Parameters:

site - - the project ID

path - - the path of the item to "revert"

version - - old version ID to base to version on

major - major version

comment - comment for revert action

Returns:

true if success otherwise false

Throws:

SiteNotFoundException - site not found

ServiceLayerException

UserNotFoundException

getContentVersion

Optional<org.springframework.core.io.Resource> getContentVersion(String site,
 String path,
 String version)
                                                          throws ContentNotFoundException

return the content for a given version

Parameters:

site - - the project ID

path - - the path item

version - - version

Returns:

content

Throws:

ContentNotFoundException - content not found

getContentVersionAsString

String getContentVersionAsString(String site,
 String path,
 String version)
                          throws ContentNotFoundException

return the content for a given version

Parameters:

site - - the project ID

path - - the path item

version - - version

Returns:

version number

Throws:

ContentNotFoundException - content not found

writeContent

void writeContent(String site,
 String path,
 String fileName,
 String contentType,
 InputStream input,
 String createFolders,
 String edit,
 String unlock)
           throws ServiceLayerException,
UserNotFoundException,
org.craftercms.commons.validation.ValidationException

write content

Parameters:

site - site identifier

path - path

fileName - file name

contentType - content type

input - content

createFolders - create missing folders in path?

edit - edit

unlock - unlock the content upon edit?

Throws:

ServiceLayerException - general service error

UserNotFoundException

org.craftercms.commons.validation.ValidationException

writeContent

void writeContent(String site,
 String path,
 String fileName,
 String contentType,
 InputStream input,
 String createFolders,
 String edit,
 String unlock,
 boolean skipAuditLogInsert)
           throws ServiceLayerException,
UserNotFoundException

write content

Parameters:

site - site identifier

path - path

fileName - file name

contentType - content type

input - content

createFolders - create missing folders in path?

edit - edit

unlock - unlock the content upon edit?

skipAuditLogInsert - if true do not insert audit log row, otherwise false

Throws:

ServiceLayerException - general service error

UserNotFoundException

writeContentAndRename

void writeContentAndRename(String site,
 String path,
 String targetPath,
 String fileName,
 String contentType,
 InputStream input,
 String createFolders,
 String edit,
 String unlock,
 boolean createFolder)
                    throws ServiceLayerException,
org.craftercms.commons.validation.ValidationException

Throws:

ServiceLayerException

org.craftercms.commons.validation.ValidationException

writeContentAsset

Map<String,Object> writeContentAsset(String site,
 String path,
 String assetName,
 InputStream in,
 String isImage,
 String allowedWidth,
 String allowedHeight,
 String allowLessSize,
 String draft,
 String unlock,
 String systemAsset)
                              throws ServiceLayerException

Throws:

ServiceLayerException

getNextAvailableName

String getNextAvailableName(String site,
 String path)

get the next available of the given content name at the given path (used for paste/duplicate)

Parameters:

site - site identifier

path - path of the item

Returns:

next available name that avoids a name conflict

createDummyDmContentItemForDeletedNode

ContentItemTO createDummyDmContentItemForDeletedNode(String site,
 String relativePath)

getContentTypeClass

String getContentTypeClass(String site,
 String uri)

getDeleteCandidates

GoLiveDeleteCandidates getDeleteCandidates(String site,
 String uri)
                                    throws ServiceLayerException

Throws:

ServiceLayerException

lockContent

void lockContent(String site,
 String path)
          throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getItemOrders

List<DmOrderTO> getItemOrders(String site,
 String path)
                       throws ContentNotFoundException

Throws:

ContentNotFoundException

reorderItems

double reorderItems(String site,
 String relativePath,
 String before,
 String after,
 String orderName)
             throws ServiceLayerException

Throws:

ServiceLayerException

renameContent

boolean renameContent(String site,
 String path,
 String name)
               throws ServiceLayerException,
UserNotFoundException,
org.craftercms.commons.validation.ValidationException

rename a content item

Parameters:

site - - the project ID

path - path to a folder to rename

name - a new folder name

Returns:

return the reference to the folder renamed

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

org.craftercms.commons.validation.ValidationException - validation exception

pushToRemote

boolean pushToRemote(String siteId,
 String remoteName,
 String remoteBranch)
              throws ServiceLayerException,
InvalidRemoteUrlException,
AuthenticationException,
org.craftercms.commons.crypto.CryptoException

Push content to remote repository

Parameters:

siteId - site identifier

remoteName - remote name

remoteBranch - remote branch

Returns:

true if operation was successful

Throws:

ServiceLayerException - general service error

InvalidRemoteUrlException - invalid remote url

AuthenticationException - authentication error

org.craftercms.commons.crypto.CryptoException - git repository helper error

pullFromRemote

boolean pullFromRemote(String siteId,
 String remoteName,
 String remoteBranch)
                throws ServiceLayerException,
InvalidRemoteUrlException,
AuthenticationException,
org.craftercms.commons.crypto.CryptoException

Pull from remote repository

Parameters:

siteId - site identifier

remoteName - remote name

remoteBranch - remote branch

Returns:

true if operation was successful

Throws:

ServiceLayerException - general service error

InvalidRemoteUrlException - invalid remote url

AuthenticationException - authentication error

org.craftercms.commons.crypto.CryptoException - git repository helper error