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

Class SitesServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.site.internal.SitesServiceInternalImpl

All Implemented Interfaces:

SitesService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SitesServiceInternalImpl
extends Object
implements SitesService, org.springframework.context.ApplicationContextAware

Constructor Summary

Constructors

Constructor

Description

SitesServiceInternalImpl(org.craftercms.commons.plugin.PluginDescriptorReader descriptorReader, ContentRepository contentRepository, StudioBlobAwareContentRepository blobAwareRepository, StudioConfiguration studioConfiguration, SiteFeedMapper siteFeedMapper, SiteDAO siteDao, RetryingDatabaseOperationFacade retryingDatabaseOperationFacade, SiteService siteServiceV1, Deployer deployer, ConfigurationService configurationService, SecurityService securityService, AuditServiceInternal auditServiceInternal, ItemServiceInternal itemServiceInternal)

Method Summary

Modifier and Type	Method	Description
protected void	addSiteUuidFile(String site, String siteUuid)	Add a file containing the site uuid in the site folder
protected void	auditSiteDuplicate(String sourceSiteId, String siteId, String siteName)	Creates an audit log entry for the site duplication operation, including the source site as audit params
void	checkSiteState(String siteId, String requiredState)
boolean	checkSiteUuid(String siteId, String siteUuid)	Checks if the currently existent site with the given ID also has the same siteUuid.
void	deleteSite(String siteId)	Delete a site from the system
protected void	destroySitePreviewContext(String siteId)	Call the engine API to destroy the site preview context
protected void	doDuplicate(String sourceSiteId, String siteId, String siteName, String description, String sandboxBranch, boolean readOnlyBlobStores)
void	duplicate(String sourceSiteId, String siteId, String siteName, String description, String sandboxBranch, boolean readOnlyBlobStores)	Duplicate a site
void	enablePublishing(String siteId, boolean enabled)	Enables/disables publishing for the given site
boolean	exists(String siteId)	Check if site already exists
List<org.craftercms.commons.plugin.model.PluginDescriptor>	getAvailableBlueprints()	Get list of available blueprints
org.craftercms.commons.plugin.model.PluginDescriptor	getBlueprintDescriptor(String id)	Get the blueprint descriptor from the global repo
String	getBlueprintLocation(String blueprintId)	Get blueprint location
protected Path	getBlueprintPath(RepositoryItem folder)
protected RepositoryItem[]	getBlueprintsFolders()
String	getLastCommitId(String siteId)	Get the last commit id for the given site
PublishStatus	getPublishingStatus(String siteId)	Get publishing status for site
Site	getSite(String siteId)	Get a site object from DB
org.craftercms.commons.plugin.model.PluginDescriptor	getSiteBlueprintDescriptor(String id)	Get the blueprint descriptor from a site repo
List<Site>	getSitesByState(String state)	Get the sites matching a given state
protected org.craftercms.commons.plugin.model.PluginDescriptor	loadDescriptor(InputStream is)
protected org.craftercms.commons.plugin.model.PluginDescriptor	loadDescriptor(RepositoryItem folder)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	unlockSite(String siteId)	Unlock a site which is locked with state `LOCKED`
void	updateLastCommitId(String siteId, String commitId)	Update a site's last commit id
void	updateSite(String siteId, String name, String description)	Updates the name and description for the given site

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.studio.api.v2.service.site.SitesService

checkSiteExists

Constructor Details

SitesServiceInternalImpl

@ConstructorProperties({"descriptorReader","contentRepository","blobAwareRepository","studioConfiguration","siteFeedMapper","siteDao","retryingDatabaseOperationFacade","siteServiceV1","deployer","configurationService","securityService","auditServiceInternal","itemServiceInternal"})
public SitesServiceInternalImpl(org.craftercms.commons.plugin.PluginDescriptorReader descriptorReader,
 ContentRepository contentRepository,
 StudioBlobAwareContentRepository blobAwareRepository,
 StudioConfiguration studioConfiguration,
 SiteFeedMapper siteFeedMapper,
 SiteDAO siteDao,
 RetryingDatabaseOperationFacade retryingDatabaseOperationFacade,
 SiteService siteServiceV1,
 Deployer deployer,
 ConfigurationService configurationService,
 SecurityService securityService,
 AuditServiceInternal auditServiceInternal,
 ItemServiceInternal itemServiceInternal)

Method Details

getAvailableBlueprints

public List<org.craftercms.commons.plugin.model.PluginDescriptor> getAvailableBlueprints()

Description copied from interface: SitesService

Get list of available blueprints

Specified by:

getAvailableBlueprints in interface SitesService

Returns:

list of blueprints

getBlueprintDescriptor

public org.craftercms.commons.plugin.model.PluginDescriptor getBlueprintDescriptor(String id)

Description copied from interface: SitesService

Get the blueprint descriptor from the global repo

Specified by:

getBlueprintDescriptor in interface SitesService

Parameters:

id - the id of the blueprint

Returns:

the descriptor object or null if not found

getBlueprintLocation

public String getBlueprintLocation(String blueprintId)

Description copied from interface: SitesService

Get blueprint location

Specified by:

getBlueprintLocation in interface SitesService

Parameters:

blueprintId - blueprint id

Returns:

blueprint location

getSiteBlueprintDescriptor

public org.craftercms.commons.plugin.model.PluginDescriptor getSiteBlueprintDescriptor(String id)

Description copied from interface: SitesService

Get the blueprint descriptor from a site repo

Specified by:

getSiteBlueprintDescriptor in interface SitesService

Parameters:

id - the id of the site

Returns:

the blueprint object or null if not found

getBlueprintsFolders

protected RepositoryItem[] getBlueprintsFolders()

getBlueprintPath

protected Path getBlueprintPath(RepositoryItem folder)

loadDescriptor

protected org.craftercms.commons.plugin.model.PluginDescriptor loadDescriptor(InputStream is)

loadDescriptor

protected org.craftercms.commons.plugin.model.PluginDescriptor loadDescriptor(RepositoryItem folder)

updateSite

public void updateSite(String siteId,
 String name,
 String description)
                throws SiteNotFoundException,
SiteAlreadyExistsException

Description copied from interface: SitesService

Updates the name and description for the given site

Specified by:

updateSite in interface SitesService

Parameters:

siteId - the id of the site

name - the name of the site

description - the description of the site

Throws:

SiteNotFoundException - if the site doesn't exist

SiteAlreadyExistsException

unlockSite

public void unlockSite(String siteId)

Description copied from interface: SitesService

Unlock a site which is locked with state `LOCKED`

Specified by:

unlockSite in interface SitesService

Parameters:

siteId - the id of the site

exists

public boolean exists(String siteId)

Description copied from interface: SitesService

Check if site already exists

Specified by:

exists in interface SitesService

Parameters:

siteId - site ID

Returns:

true if site exists, false otherwise

deleteSite

public void deleteSite(String siteId)
                throws ServiceLayerException

Description copied from interface: SitesService

Delete a site from the system

Specified by:

deleteSite in interface SitesService

Parameters:

siteId - the site id

Throws:

ServiceLayerException

checkSiteState

public void checkSiteState(String siteId,
 String requiredState)
                    throws InvalidSiteStateException,
SiteNotFoundException

Specified by:

checkSiteState in interface SitesService

Throws:

InvalidSiteStateException

SiteNotFoundException

getSite

public Site getSite(String siteId)

Description copied from interface: SitesService

Get a site object from DB

Specified by:

getSite in interface SitesService

Parameters:

siteId - site id

Returns:

site object

updateLastCommitId

public void updateLastCommitId(String siteId,
 String commitId)

Description copied from interface: SitesService

Update a site's last commit id

Specified by:

updateLastCommitId in interface SitesService

Parameters:

siteId - site id

commitId - commit id

getLastCommitId

public String getLastCommitId(String siteId)

Description copied from interface: SitesService

Get the last commit id for the given site

Specified by:

getLastCommitId in interface SitesService

Parameters:

siteId - site id

Returns:

the last commit id

checkSiteUuid

public boolean checkSiteUuid(String siteId,
 String siteUuid)

Description copied from interface: SitesService

Checks if the currently existent site with the given ID also has the same siteUuid.

Specified by:

checkSiteUuid in interface SitesService

Parameters:

siteId - ID of the site to test

siteUuid - site UUID

Returns:

true if the site UUID file exists and contains the same siteUUID value, false otherwise

destroySitePreviewContext

protected void destroySitePreviewContext(String siteId)
                                  throws ServiceLayerException

Call the engine API to destroy the site preview context

Parameters:

siteId - site id

Throws:

ServiceLayerException - if the request fails or response status code is not 200

enablePublishing

public void enablePublishing(String siteId,
 boolean enabled)

Description copied from interface: SitesService

Enables/disables publishing for the given site

Specified by:

enablePublishing in interface SitesService

Parameters:

siteId - the site id

enabled - true to enable publishing, false to disable

getPublishingStatus

public PublishStatus getPublishingStatus(String siteId)

Description copied from interface: SitesService

Get publishing status for site

Specified by:

getPublishingStatus in interface SitesService

Parameters:

siteId - site identifier

Returns:

publishing status

duplicate

public void duplicate(String sourceSiteId,
 String siteId,
 String siteName,
 String description,
 String sandboxBranch,
 boolean readOnlyBlobStores)
               throws ServiceLayerException

Description copied from interface: SitesService

Duplicate a site

Specified by:

duplicate in interface SitesService

Parameters:

sourceSiteId - the id of the site to duplicate

siteId - the id of the new site

siteName - the name of the new site

description - the description of the new site

sandboxBranch - the sandbox branch to use

readOnlyBlobStores - whether the blob stores should be read only. Notice that this value is overridden (forced to false) if serverless delivery is enabled

Throws:

ServiceLayerException - if there is an error duplicating the site

doDuplicate

protected void doDuplicate(String sourceSiteId,
 String siteId,
 String siteName,
 String description,
 String sandboxBranch,
 boolean readOnlyBlobStores)
                    throws ServiceLayerException

Throws:

ServiceLayerException

getSitesByState

public List<Site> getSitesByState(String state)

Description copied from interface: SitesService

Get the sites matching a given state

Specified by:

getSitesByState in interface SitesService

Parameters:

state - the state to match. See Site.State

Returns:

the list of sites matching the given state

auditSiteDuplicate

protected void auditSiteDuplicate(String sourceSiteId,
 String siteId,
 String siteName)

Creates an audit log entry for the site duplication operation, including the source site as audit params

Parameters:

sourceSiteId - the source site id

siteId - the new site id

siteName - the new site name

addSiteUuidFile

protected void addSiteUuidFile(String site,
 String siteUuid)
                        throws IOException

Add a file containing the site uuid in the site folder

Parameters:

site - site id

siteUuid - site uuid

Throws:

IOException - if the file cannot be written

setApplicationContext

public void setApplicationContext(@NonNull
 org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException