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

Class SitesServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.site.SitesServiceImpl

All Implemented Interfaces:

SitesService

public class SitesServiceImpl
extends Object
implements SitesService

Constructor Summary

Constructors

Constructor	Description
SitesServiceImpl(SitesService sitesServiceInternal, PublishingProgressServiceInternal publishingProgressServiceInternal, ContentRepository contentRepository, SiteService siteService)

Method Summary

Modifier and Type	Method	Description
void	checkSiteState(String siteId, String state)	Check if current site state is matches the given state
void	clearPublishingLock(String siteId)	Clear publishing lock for site
void	duplicate(String sourceSiteId, String siteId, String siteName, String description, String sandboxBranch, boolean readOnlyBlobStores)	Duplicate a site
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
PublishStatus	getPublishingStatus(String siteId)	Get publishing status for site
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
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

Constructor Details

SitesServiceImpl

@ConstructorProperties({"sitesServiceInternal","publishingProgressServiceInternal","contentRepository","siteService"})
public SitesServiceImpl(SitesService sitesServiceInternal,
 PublishingProgressServiceInternal publishingProgressServiceInternal,
 ContentRepository contentRepository,
 SiteService siteService)

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

updateSite

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

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

InvalidParametersException

getPublishingStatus

public PublishStatus getPublishingStatus(String siteId)
                                  throws SiteNotFoundException

Description copied from interface: SitesService

Get publishing status for site

Specified by:

getPublishingStatus in interface SitesService

Parameters:

siteId - site identifier

Returns:

publishing status

Throws:

SiteNotFoundException

clearPublishingLock

public void clearPublishingLock(String siteId)
                         throws SiteNotFoundException

Description copied from interface: SitesService

Clear publishing lock for site

Specified by:

clearPublishingLock in interface SitesService

Parameters:

siteId - site identifier

Throws:

SiteNotFoundException

checkSiteState

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

Description copied from interface: SitesService

Check if current site state is matches the given state

Specified by:

checkSiteState in interface SitesService

Parameters:

siteId - site id

state - desired state

Throws:

InvalidSiteStateException - if the site state doesn't match the given state

SiteNotFoundException - if the site doesn't exist

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

Throws:

ServiceLayerException - if there is an error duplicating the site

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