Package org.craftercms.studio.impl.v2.service.content.internal

Class ContentTypeServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.content.internal.ContentTypeServiceInternalImpl

All Implemented Interfaces:

ContentTypeServiceInternal

public class ContentTypeServiceInternalImpl
extends Object
implements ContentTypeServiceInternal

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationService	configurationService
protected ContentService	contentService
protected final String	contentTypeBasePathPattern
protected final String	contentTypeConfigFilename
protected final String	contentTypeDefinitionFilename
protected final ContentTypeService	contentTypeService
protected final String	contentTypesRootPath
protected final String	controllerFormat
protected final String	controllerPattern
protected final String	defaultPreviewImagePath
protected final ItemDAO	itemDao
protected final String	previewImageXPath
protected final SecurityService	securityService
protected final String	templateXPath

Constructor Summary

Constructors

Constructor

Description

ContentTypeServiceInternalImpl(ContentTypeService contentTypeService, SecurityService securityService, ConfigurationService configurationService, ItemDAO itemDao, String contentTypeBasePathPattern, String contentTypeDefinitionFilename, String contentTypeConfigFilename, String contentTypesRootPath, String templateXPath, String controllerPattern, String controllerFormat, String previewImageXPath, String defaultPreviewImagePath, GitRepositoryHelper gitRepositoryHelper)

Method Summary

Modifier and Type	Method	Description
void	deleteContentType(String siteId, String contentType, boolean deleteDependencies)	Deletes all files related to a given content-type
Collection<String>	getAllModelDefinitions(String site)	Get all content types for the given site.
String	getContentTypeControllerPath(String contentTypeId)	Builds the path of the Groovy controller for a given content type id
protected String	getContentTypePath(String contentType)
org.apache.commons.lang3.tuple.ImmutablePair<String,org.springframework.core.io.Resource>	getContentTypePreviewImage(String siteId, String contentTypeId)	Finds the preview image for a given content-type
protected String	getContentTypePreviewImageFilename(String siteId, String contentTypeId)	Get preview image filename extract from form-definition.xml
String	getContentTypeTemplatePath(String siteId, String contentTypeId)	Extracts the path of the Freemarker template for a given content type id
ContentTypeUsage	getContentTypeUsage(String siteId, String contentType)	Finds all items related to a given content-type
protected org.dom4j.Document	getFormDefinitionDocument(String siteId, String contentTypeId)	Get form-definition.xml as Document of a content type
List<QuickCreateItem>	getQuickCreatableContentTypes(String siteId)	Get list of content types marked as quick creatable for given site
void	setContentService(ContentService contentService)

Methods inherited from class java.lang.Object

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

Field Details

contentTypeService

protected final ContentTypeService contentTypeService

securityService

protected final SecurityService securityService

configurationService

protected final ConfigurationService configurationService

itemDao

protected final ItemDAO itemDao

contentService

protected ContentService contentService

contentTypeBasePathPattern

protected final String contentTypeBasePathPattern

contentTypesRootPath

protected final String contentTypesRootPath

contentTypeDefinitionFilename

protected final String contentTypeDefinitionFilename

contentTypeConfigFilename

protected final String contentTypeConfigFilename

templateXPath

protected final String templateXPath

controllerPattern

protected final String controllerPattern

controllerFormat

protected final String controllerFormat

previewImageXPath

protected final String previewImageXPath

defaultPreviewImagePath

protected final String defaultPreviewImagePath

Constructor Details

ContentTypeServiceInternalImpl

@ConstructorProperties({"contentTypeService","securityService","configurationService","itemDao","contentTypeBasePathPattern","contentTypeDefinitionFilename","contentTypeConfigFilename","contentTypesRootPath","templateXPath","controllerPattern","controllerFormat","previewImageXPath","defaultPreviewImagePath","gitRepositoryHelper"})
public ContentTypeServiceInternalImpl(ContentTypeService contentTypeService,
 SecurityService securityService,
 ConfigurationService configurationService,
 ItemDAO itemDao,
 String contentTypeBasePathPattern,
 String contentTypeDefinitionFilename,
 String contentTypeConfigFilename,
 String contentTypesRootPath,
 String templateXPath,
 String controllerPattern,
 String controllerFormat,
 String previewImageXPath,
 String defaultPreviewImagePath,
 GitRepositoryHelper gitRepositoryHelper)

Method Details

setContentService

public void setContentService(ContentService contentService)

getQuickCreatableContentTypes

public List<QuickCreateItem> getQuickCreatableContentTypes(String siteId)

Description copied from interface: ContentTypeServiceInternal

Get list of content types marked as quick creatable for given site

Specified by:

getQuickCreatableContentTypes in interface ContentTypeServiceInternal

Parameters:

siteId - site identifier

Returns:

List of quick creatable content types

getContentTypeUsage

public ContentTypeUsage getContentTypeUsage(String siteId,
 String contentType)
                                     throws ServiceLayerException

Description copied from interface: ContentTypeServiceInternal

Finds all items related to a given content-type

Specified by:

getContentTypeUsage in interface ContentTypeServiceInternal

Parameters:

siteId - the id of the site

contentType - the id of the content-type

Returns:

the usage

Throws:

ServiceLayerException - if there is any error finding the items

getContentTypePreviewImage

public org.apache.commons.lang3.tuple.ImmutablePair<String,org.springframework.core.io.Resource> getContentTypePreviewImage(String siteId,
 String contentTypeId)
                                                                                                                     throws ServiceLayerException

Description copied from interface: ContentTypeServiceInternal

Finds the preview image for a given content-type

Specified by:

getContentTypePreviewImage in interface ContentTypeServiceInternal

Parameters:

siteId - the id of the site

contentTypeId - the id of the content-type

Returns:

the preview image file as a pair of path and resource

Throws:

ServiceLayerException - if there is any error finding the items

deleteContentType

public void deleteContentType(String siteId,
 String contentType,
 boolean deleteDependencies)
                       throws ServiceLayerException,
AuthenticationException,
DeploymentException,
UserNotFoundException

Description copied from interface: ContentTypeServiceInternal

Deletes all files related to a given content-type

Specified by:

deleteContentType in interface ContentTypeServiceInternal

Parameters:

siteId - the id of the site

contentType - the id of the content-type

deleteDependencies - indicates if all dependencies should be deleted

Throws:

ServiceLayerException - if there is any error deleting the files

AuthenticationException - if there is any error authenticating the user

DeploymentException - if there is any error publishing the changes

UserNotFoundException

getContentTypeControllerPath

public String getContentTypeControllerPath(String contentTypeId)

Description copied from interface: ContentTypeServiceInternal

Builds the path of the Groovy controller for a given content type id

Specified by:

getContentTypeControllerPath in interface ContentTypeServiceInternal

Parameters:

contentTypeId - the id of the content type

Returns:

the path of the controller or null

getContentTypeTemplatePath

public String getContentTypeTemplatePath(String siteId,
 String contentTypeId)
                                  throws ServiceLayerException

Description copied from interface: ContentTypeServiceInternal

Extracts the path of the Freemarker template for a given content type id

Specified by:

getContentTypeTemplatePath in interface ContentTypeServiceInternal

Parameters:

siteId - the id of the site

contentTypeId - the id of the content type

Returns:

the path of the template or null

Throws:

ServiceLayerException - if there is any error reading the content type definition

getAllModelDefinitions

public Collection<String> getAllModelDefinitions(String site)
                                          throws ServiceLayerException

Description copied from interface: ContentTypeServiceInternal

Get all content types for the given site.

Specified by:

getAllModelDefinitions in interface ContentTypeServiceInternal

Parameters:

site - the id of the site

Returns:

a collection of content types including their config files (config.xml, form-definition.xml)

Throws:

ServiceLayerException - if there is any error getting the content types

getContentTypePath

protected String getContentTypePath(String contentType)

getContentTypePreviewImageFilename

protected String getContentTypePreviewImageFilename(String siteId,
 String contentTypeId)
                                             throws ServiceLayerException

Get preview image filename extract from form-definition.xml

Parameters:

siteId -

contentTypeId -

Returns:

preview image filename

Throws:

ServiceLayerException

getFormDefinitionDocument

protected org.dom4j.Document getFormDefinitionDocument(String siteId,
 String contentTypeId)
                                                throws ServiceLayerException

Get form-definition.xml as Document of a content type

Parameters:

siteId -

contentTypeId -

Returns:

Document of form-definition.xml

Throws:

ServiceLayerException