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

Class SiteServiceImpl

java.lang.Object

org.craftercms.studio.impl.v1.service.site.SiteServiceImpl

All Implemented Interfaces:

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

public class SiteServiceImpl
extends Object
implements SiteService, org.springframework.context.ApplicationContextAware

Note: consider renaming A site in Crafter Studio is currently the name for a WEM project being managed. This service provides access to site configuration

Author:

russdanner

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected AuditServiceInternal	auditServiceInternal
protected ConfigurationService	configurationService
protected ConfigurationService	configurationServiceInternal
protected ContentRepository	contentRepository
protected ContentRepository	contentRepositoryV2
protected ContentService	contentService
protected DependencyService	dependencyService
protected DependencyServiceInternal	dependencyServiceInternal
protected Deployer	deployer
protected DeploymentService	deploymentService
protected DmPageNavigationOrderService	dmPageNavigationOrderService
protected org.craftercms.commons.entitlements.validator.EntitlementValidator	entitlementValidator
protected GroupServiceInternal	groupServiceInternal
protected ItemServiceInternal	itemServiceInternal
protected RetryingDatabaseOperationFacade	retryingDatabaseOperationFacade
protected SecurityService	securityService
protected SiteFeedMapper	siteFeedMapper
protected SitesService	sitesServiceInternal
protected StudioConfiguration	studioConfiguration
protected StudioDBScriptRunnerFactory	studioDBScriptRunnerFactory
protected StudioUpgradeManager	upgradeManager
protected UserDAO	userDao
protected UserServiceInternal	userServiceInternal
protected WorkflowServiceInternal	workflowServiceInternal

Constructor Summary

Constructors

Constructor	Description
SiteServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	addRemote(String siteId, String remoteName, String remoteUrl, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey)	Add remote repository for site content repository
void	checkSiteExists(String site)	Checks if a site exists.
int	countSites()
void	createSiteFromBlueprint(String blueprintId, @Size(max=50) String siteId, String siteName, String sandboxBranch, String desc, Map<String,String> params, boolean createAsOrphan)	Create a new site based on an existing blueprint
protected boolean	createSiteFromBlueprintGit(String blueprintLocation, String siteId, String sandboxBranch, Map<String,String> params, String creator)
void	createSiteWithRemoteOption(@Size(max=50) String siteId, String siteName, String sandboxBranch, String description, String blueprintName, String remoteName, String remoteUrl, String remoteBranch, boolean singleBranch, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey, String createOption, Map<String,String> params, boolean createAsOrphan)	Create a new site with remote option (clone from remote or push to remote repository)
@jakarta.validation.Valid boolean	deleteSite(String siteId)	remove a site from the system
@jakarta.validation.Valid boolean	enablePublishing(String siteId, boolean enabled)	Enable/Disable publishing for given site
@jakarta.validation.Valid boolean	exists(String site)	Check if site already exists
@jakarta.validation.Valid boolean	existsById(String siteId)	Check if site already exists
@jakarta.validation.Valid boolean	existsByName(String siteName)	Check if site already exists
Set<String>	getAllAvailableSites()
List<String>	getAllCreatedSites()	Get list of all sites with state = CREATED
SiteBlueprintTO[]	getAvailableBlueprints()	get a list of available blueprints
List<String>	getDefaultGroups()
List<SiteFeed>	getDeletedSites()	Get deleted sites
@Valid SiteFeed	getSite(String siteId)	Get site feed for given site
SiteDetails	getSiteDetails(String siteId)	Get site details.
@Valid List<SiteFeed>	getSitesPerUser(int start, int number)	Get sites that user is allowed access to for current user
@Valid List<SiteFeed>	getSitesPerUser(String username, int start, int number)	Get sites that user is allowed access to for given username
@jakarta.validation.Valid int	getSitesPerUserTotal()	Get total number of sites that user is allowed access to for current user
@jakarta.validation.Valid int	getSitesPerUserTotal(String username)	Get total number of sites that user is allowed access to for given username
String	getSiteState(String siteId)
boolean	isPublishedRepoCreated(String siteId)
@jakarta.validation.Valid boolean	isPublishingEnabled(String siteId)	Check if publishing is enabled for given site
List<RemoteRepositoryInfoTO>	listRemote(String siteId)	List remote repositories for given site
boolean	removeRemote(String siteId, String remoteName)	Remove remote with given name for site
protected void	replaceFileContentGit(String site, String path, String find, String replace)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setConfigurationService(ConfigurationService configurationService)
void	setConfigurationServiceInternal(ConfigurationService configurationServiceInternal)
void	setContentRepository(ContentRepository repo)
void	setContentRepositoryV2(ContentRepository contentRepositoryV2)
void	setContentService(ContentService contentService)
void	setDependencyService(DependencyService dependencyService)
void	setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)
void	setDeployer(Deployer deployer)
void	setDeploymentService(DeploymentService deploymentService)
void	setDmPageNavigationOrderService(DmPageNavigationOrderService dmPageNavigationOrderService)
void	setEntitlementValidator(org.craftercms.commons.entitlements.validator.EntitlementValidator entitlementValidator)
void	setGroupServiceInternal(GroupServiceInternal groupServiceInternal)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setPublishedRepoCreated(String siteId)
void	setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)
void	setSecurityService(SecurityService securityService)
void	setSitesServiceInternal(SitesService sitesServiceInternal)
void	setSiteState(String siteId, String state)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setStudioDBScriptRunner(StudioDBScriptRunnerFactory studioDBScriptRunner)
void	setUpgradeManager(StudioUpgradeManager upgradeManager)
void	setUserDao(UserDAO userDao)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
void	setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)
void	updateLastCommitId(String site, String commitId)
@jakarta.validation.Valid boolean	updatePublishingStatus(String siteId, String status)	Update publishing status message for given site

Methods inherited from class java.lang.Object

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

Field Details

deployer

protected Deployer deployer

contentService

protected ContentService contentService

contentRepository

protected ContentRepository contentRepository

contentRepositoryV2

protected ContentRepository contentRepositoryV2

dependencyService

protected DependencyService dependencyService

securityService

protected SecurityService securityService

deploymentService

protected DeploymentService deploymentService

dmPageNavigationOrderService

protected DmPageNavigationOrderService dmPageNavigationOrderService

groupServiceInternal

protected GroupServiceInternal groupServiceInternal

userServiceInternal

protected UserServiceInternal userServiceInternal

upgradeManager

protected StudioUpgradeManager upgradeManager

studioConfiguration

protected StudioConfiguration studioConfiguration

sitesServiceInternal

protected SitesService sitesServiceInternal

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

configurationService

protected ConfigurationService configurationService

configurationServiceInternal

protected ConfigurationService configurationServiceInternal

itemServiceInternal

protected ItemServiceInternal itemServiceInternal

workflowServiceInternal

protected WorkflowServiceInternal workflowServiceInternal

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

siteFeedMapper

@Autowired
protected SiteFeedMapper siteFeedMapper

entitlementValidator

protected org.craftercms.commons.entitlements.validator.EntitlementValidator entitlementValidator

studioDBScriptRunnerFactory

protected StudioDBScriptRunnerFactory studioDBScriptRunnerFactory

dependencyServiceInternal

protected DependencyServiceInternal dependencyServiceInternal

retryingDatabaseOperationFacade

protected RetryingDatabaseOperationFacade retryingDatabaseOperationFacade

userDao

protected UserDAO userDao

Constructor Details

SiteServiceImpl

public SiteServiceImpl()

Method Details

getAllAvailableSites

public Set<String> getAllAvailableSites()

Specified by:

getAllAvailableSites in interface SiteService

countSites

public int countSites()

Specified by:

countSites in interface SiteService

createSiteFromBlueprint

@Valid
public void createSiteFromBlueprint(String blueprintId,
 @Size(max=50)
 @Size(max=50) String siteId,
 String siteName,
 String sandboxBranch,
 String desc,
 Map<String,String> params,
 boolean createAsOrphan)
                             throws SiteAlreadyExistsException,
SiteCreationException,
DeployerTargetException,
BlueprintNotFoundException,
MissingPluginParameterException

Description copied from interface: SiteService

Create a new site based on an existing blueprint

Specified by:

createSiteFromBlueprint in interface SiteService

Parameters:

blueprintId - blueprint name to create site

siteId - site identifier

siteName - site name

sandboxBranch - sandbox branch name

desc - description

params - site parameters

createAsOrphan - create the site from a remote repository as orphan (no git history)

Throws:

SiteAlreadyExistsException - site already exists

SiteCreationException - error during site creation process

DeployerTargetException - error creating deployer targets

BlueprintNotFoundException - blueprint not found

MissingPluginParameterException - missing mandatory blueprint parameters

createSiteFromBlueprintGit

protected boolean createSiteFromBlueprintGit(String blueprintLocation,
 String siteId,
 String sandboxBranch,
 Map<String,String> params,
 String creator)
                                      throws Exception

Throws:

Exception

replaceFileContentGit

protected void replaceFileContentGit(String site,
 String path,
 String find,
 String replace)
                              throws Exception

Throws:

Exception

createSiteWithRemoteOption

@Valid
public void createSiteWithRemoteOption(@Size(max=50)
 @Size(max=50) String siteId,
 String siteName,
 String sandboxBranch,
 String description,
 String blueprintName,
 String remoteName,
 String remoteUrl,
 String remoteBranch,
 boolean singleBranch,
 String authenticationType,
 String remoteUsername,
 String remotePassword,
 String remoteToken,
 String remotePrivateKey,
 String createOption,
 Map<String,String> params,
 boolean createAsOrphan)
                                throws ServiceLayerException,
InvalidRemoteRepositoryException,
InvalidRemoteRepositoryCredentialsException,
RemoteRepositoryNotFoundException

Description copied from interface: SiteService

Create a new site with remote option (clone from remote or push to remote repository)

Specified by:

createSiteWithRemoteOption in interface SiteService

Parameters:

siteId - site identifier

siteName - the name of the site

sandboxBranch - sandbox branch name

description - description

blueprintName - name of the blueprint to create site

remoteName - remote repository name

remoteUrl - remote repository url

remoteBranch - remote repository branch to create site from

singleBranch - clone single branch if true, otherwise clone whole repo

authenticationType - remote repository authentication type

remoteUsername - remote repository username to use for authentication

remotePassword - remote repository username to use for authentication

remoteToken - remote repository username to use for authentication

remotePrivateKey - remote repository username to use for authentication

createOption - remote repository username to use for authentication

params - site parameters

createAsOrphan - create the site from a remote repository as orphan (no git history)

Throws:

ServiceLayerException - general service error

InvalidRemoteRepositoryException - invalid remote repository

InvalidRemoteRepositoryCredentialsException - invalid credentials for remote repository

RemoteRepositoryNotFoundException - remote repository not found

deleteSite

@Valid
public @jakarta.validation.Valid boolean deleteSite(String siteId)

Description copied from interface: SiteService

remove a site from the system

Specified by:

deleteSite in interface SiteService

Parameters:

siteId - site identifier

Returns:

true if successfully deleted, otherwise false

getAvailableBlueprints

public SiteBlueprintTO[] getAvailableBlueprints()

Description copied from interface: SiteService

get a list of available blueprints

Specified by:

getAvailableBlueprints in interface SiteService

Returns:

list of blueprints

updateLastCommitId

@Valid
public void updateLastCommitId(String site,
 String commitId)

Specified by:

updateLastCommitId in interface SiteService

exists

@Valid
public @jakarta.validation.Valid boolean exists(String site)

Description copied from interface: SiteService

Check if site already exists

Specified by:

exists in interface SiteService

Parameters:

site - site ID

Returns:

true if site exists, false otherwise

checkSiteExists

@Valid
public void checkSiteExists(String site)
                     throws SiteNotFoundException

Description copied from interface: SiteService

Checks if a site exists. If it does not, it throws a SiteNotFoundException

Specified by:

checkSiteExists in interface SiteService

Parameters:

site - site ID

Throws:

SiteNotFoundException - if no site is found for the given site ID

existsById

@Valid
public @jakarta.validation.Valid boolean existsById(String siteId)

Description copied from interface: SiteService

Check if site already exists

Specified by:

existsById in interface SiteService

Parameters:

siteId - site ID in DB

Returns:

true if site exists, false otherwise

existsByName

@Valid
public @jakarta.validation.Valid boolean existsByName(String siteName)

Description copied from interface: SiteService

Check if site already exists

Specified by:

existsByName in interface SiteService

Parameters:

siteName - site name in DB

Returns:

true if site exists, false otherwise

getSitesPerUserTotal

@Valid
public @jakarta.validation.Valid int getSitesPerUserTotal()
                                                   throws UserNotFoundException,
ServiceLayerException

Description copied from interface: SiteService

Get total number of sites that user is allowed access to for current user

Specified by:

getSitesPerUserTotal in interface SiteService

Returns:

number of sites

Throws:

UserNotFoundException

ServiceLayerException

getSitesPerUserTotal

@Valid
public @jakarta.validation.Valid int getSitesPerUserTotal(String username)
                                                   throws UserNotFoundException,
ServiceLayerException

Description copied from interface: SiteService

Get total number of sites that user is allowed access to for given username

Specified by:

getSitesPerUserTotal in interface SiteService

Parameters:

username - username

Returns:

number of sites

Throws:

UserNotFoundException - user not found

ServiceLayerException - general service error

getSitesPerUser

@Valid
public @Valid List<SiteFeed> getSitesPerUser(int start,
 int number)
                                      throws UserNotFoundException,
ServiceLayerException

Description copied from interface: SiteService

Get sites that user is allowed access to for current user

Specified by:

getSitesPerUser in interface SiteService

Parameters:

start - start position for pagination

number - number of sites per page

Returns:

number of sites

Throws:

UserNotFoundException

ServiceLayerException

getSitesPerUser

@Valid
public @Valid List<SiteFeed> getSitesPerUser(String username,
 int start,
 int number)
                                      throws UserNotFoundException,
ServiceLayerException

Description copied from interface: SiteService

Get sites that user is allowed access to for given username

Specified by:

getSitesPerUser in interface SiteService

Parameters:

username - username

start - start position for pagination

number - number of sites per page

Returns:

number of sites

Throws:

UserNotFoundException - user not found

ServiceLayerException - general service error

getSite

@Valid
public @Valid SiteFeed getSite(String siteId)
                        throws SiteNotFoundException

Description copied from interface: SiteService

Get site feed for given site

Specified by:

getSite in interface SiteService

Parameters:

siteId - site id

Returns:

SiteFeed object for the requested site

Throws:

SiteNotFoundException - site not found

getSiteDetails

public SiteDetails getSiteDetails(String siteId)
                           throws ServiceLayerException

Description copied from interface: SiteService

Get site details. This will include the site feed info and the blob store configuration details

Specified by:

getSiteDetails in interface SiteService

Parameters:

siteId - site id

Returns:

SiteDetails object for the requested site

Throws:

ServiceLayerException - if an error occurs while retrieving the site details

isPublishingEnabled

@Valid
public @jakarta.validation.Valid boolean isPublishingEnabled(String siteId)

Description copied from interface: SiteService

Check if publishing is enabled for given site

Specified by:

isPublishingEnabled in interface SiteService

Parameters:

siteId - site id

Returns:

true if publishing is enabled for given site, otherwise false

enablePublishing

@Valid
public @jakarta.validation.Valid boolean enablePublishing(String siteId,
 boolean enabled)
                                                   throws SiteNotFoundException

Description copied from interface: SiteService

Enable/Disable publishing for given site

Specified by:

enablePublishing in interface SiteService

Parameters:

siteId - site id

enabled - true to enable publishing, false to disable publishing

Returns:

true if operation was successful, otherwise false

Throws:

SiteNotFoundException - site not found

updatePublishingStatus

@Valid
public @jakarta.validation.Valid boolean updatePublishingStatus(String siteId,
 String status)
                                                         throws SiteNotFoundException

Description copied from interface: SiteService

Update publishing status message for given site

Specified by:

updatePublishingStatus in interface SiteService

Parameters:

siteId - site id

status - status

Returns:

true if publishing status message is successfully updated

Throws:

SiteNotFoundException - site not found

addRemote

public boolean addRemote(String siteId,
 String remoteName,
 String remoteUrl,
 String authenticationType,
 String remoteUsername,
 String remotePassword,
 String remoteToken,
 String remotePrivateKey)
                  throws InvalidRemoteUrlException,
ServiceLayerException

Description copied from interface: SiteService

Add remote repository for site content repository

Specified by:

addRemote in interface SiteService

Parameters:

siteId - site identifier

remoteName - remote name

remoteUrl - remote url

authenticationType - authentication type

remoteUsername - remote username

remotePassword - remote password

remoteToken - remote token

remotePrivateKey - remote private key

Returns:

true if operation was successful

Throws:

InvalidRemoteUrlException - invalid remote url

ServiceLayerException - general service error

removeRemote

public boolean removeRemote(String siteId,
 String remoteName)
                     throws SiteNotFoundException

Description copied from interface: SiteService

Remove remote with given name for site

Specified by:

removeRemote in interface SiteService

Parameters:

siteId - site identifier

remoteName - remote name

Returns:

true if operation was successful

Throws:

SiteNotFoundException - site not found

listRemote

public List<RemoteRepositoryInfoTO> listRemote(String siteId)
                                        throws ServiceLayerException,
org.craftercms.commons.crypto.CryptoException

Description copied from interface: SiteService

List remote repositories for given site

Specified by:

listRemote in interface SiteService

Parameters:

siteId - site identifier

Returns:

list of names of remote repositories

Throws:

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

ServiceLayerException

getDeletedSites

public List<SiteFeed> getDeletedSites()

Description copied from interface: SiteService

Get deleted sites

Specified by:

getDeletedSites in interface SiteService

Returns:

List of deleted sites from DB

getAllCreatedSites

public List<String> getAllCreatedSites()

Description copied from interface: SiteService

Get list of all sites with state = CREATED

Specified by:

getAllCreatedSites in interface SiteService

Returns:

list of sites

setSiteState

public void setSiteState(String siteId,
 String state)

Specified by:

setSiteState in interface SiteService

getSiteState

public String getSiteState(String siteId)

Specified by:

getSiteState in interface SiteService

isPublishedRepoCreated

public boolean isPublishedRepoCreated(String siteId)

Specified by:

isPublishedRepoCreated in interface SiteService

setPublishedRepoCreated

public void setPublishedRepoCreated(String siteId)

Specified by:

setPublishedRepoCreated in interface SiteService

getDefaultGroups

public List<String> getDefaultGroups()

setApplicationContext

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

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setContentService

public void setContentService(ContentService contentService)

setContentRepository

public void setContentRepository(ContentRepository repo)

setDependencyService

public void setDependencyService(DependencyService dependencyService)

setSecurityService

public void setSecurityService(SecurityService securityService)

setDeploymentService

public void setDeploymentService(DeploymentService deploymentService)

setDmPageNavigationOrderService

public void setDmPageNavigationOrderService(DmPageNavigationOrderService dmPageNavigationOrderService)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setDeployer

public void setDeployer(Deployer deployer)

setEntitlementValidator

public void setEntitlementValidator(org.craftercms.commons.entitlements.validator.EntitlementValidator entitlementValidator)

setGroupServiceInternal

public void setGroupServiceInternal(GroupServiceInternal groupServiceInternal)

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setUpgradeManager

public void setUpgradeManager(StudioUpgradeManager upgradeManager)

setSitesServiceInternal

public void setSitesServiceInternal(SitesService sitesServiceInternal)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

setConfigurationServiceInternal

public void setConfigurationServiceInternal(ConfigurationService configurationServiceInternal)

setContentRepositoryV2

public void setContentRepositoryV2(ContentRepository contentRepositoryV2)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setWorkflowServiceInternal

public void setWorkflowServiceInternal(WorkflowServiceInternal workflowServiceInternal)

setStudioDBScriptRunner

public void setStudioDBScriptRunner(StudioDBScriptRunnerFactory studioDBScriptRunner)

setDependencyServiceInternal

public void setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)

setRetryingDatabaseOperationFacade

public void setRetryingDatabaseOperationFacade(RetryingDatabaseOperationFacade retryingDatabaseOperationFacade)

setUserDao

public void setUserDao(UserDAO userDao)