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

Class SiteServiceImpl

java.lang.Object

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

All Implemented Interfaces:

SiteService

public class SiteServiceImpl
extends Object
implements SiteService

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 and Description
protected SiteServiceDAL	_siteServiceDAL
protected AuditServiceInternal	auditServiceInternal
protected ClusterDAO	clusterDao
protected ConfigurationService	configurationService
protected ContentRepository	contentRepository
protected ContentRepository	contentRepositoryV2
protected ContentService	contentService
protected ContentTypeService	contentTypeService
protected DependencyService	dependencyService
protected DependencyServiceInternal	dependencyServiceInternal
protected Deployer	deployer
protected DeploymentService	deploymentService
protected DmPageNavigationOrderService	dmPageNavigationOrderService
protected org.craftercms.commons.entitlements.validator.EntitlementValidator	entitlementValidator
protected EventService	eventService
protected GeneralLockService	generalLockService
protected GroupServiceInternal	groupServiceInternal
protected ImportService	importService
protected NotificationService	notificationService
protected ObjectMetadataManager	objectMetadataManager
protected ObjectStateService	objectStateService
protected RebuildRepositoryMetadata	rebuildRepositoryMetadata
protected RetryingOperationFacade	retryingOperationFacade
protected SecurityService	securityService
protected ServicesConfig	servicesConfig
protected SiteFeedMapper	siteFeedMapper
protected SitesServiceInternal	sitesServiceInternal
protected StudioClusterUtils	studioClusterUtils
protected StudioConfiguration	studioConfiguration
protected StudioDBScriptRunnerFactory	studioDBScriptRunnerFactory
protected SyncDatabaseWithRepository	syncDatabaseWithRepository
protected UpgradeManager	upgradeManager
protected UserServiceInternal	userServiceInternal

Constructor Summary

Constructors

Constructor and Description
SiteServiceImpl(StudioClusterUtils studioClusterUtils)

Method Summary

Modifier and Type	Method and 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
int	countSites()
void	createSiteFromBlueprint(String blueprintId, String siteName, String siteId, 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 siteName, String siteId, String sandboxBranch, String desc, Map<String,String> params, String creator)
void	createSiteWithRemoteOption(String siteId, 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)
boolean	deleteSite(String siteId) remove a site from the system
boolean	enablePublishing(String siteId, boolean enabled) Enable/Disable publishing for given site
boolean	exists(String site) Check if site already exists
boolean	existsById(String siteId) Check if site already exists
boolean	existsByName(String siteName) Check if site already exists
Set<String>	getAllAvailableSites()
List<String>	getAllCreatedSites() Get list of all sites with state = CREATED
AuditServiceInternal	getAuditServiceInternal()
SiteBlueprintTO[]	getAvailableBlueprints() get a list of available blueprints
ClusterDAO	getClusterDao()
Map<String,Object>	getConfiguration(String path) get configuraiton content as XML string at the given path
Map<String,Object>	getConfiguration(String site, String path, boolean applyEnv) get configuraiton content as XML string at the given path
ConfigurationService	getConfigurationService()
ContentRepository	getContenetRepository()
ContentRepository	getContentRepositoryV2()
ContentService	getContentService()
ContentTypeService	getContentTypeService()
List<String>	getDefaultGroups()
List<SiteFeed>	getDeletedSites() Get deleted sites
DependencyService	getDependencyService()
DependencyServiceInternal	getDependencyServiceInternal()
Deployer	getDeployer()
DeploymentService	getDeploymentService()
DmPageNavigationOrderService	getDmPageNavigationOrderService()
String	getEnvironment()
EventService	getEventService()
GeneralLockService	getGeneralLockService()
String	getGlobalConfigRoot()
GroupServiceInternal	getGroupServiceInternal()
ImportService	getImportService()
String	getLastCommitId(String siteId) get last commit id for site
String	getLastSyncedGitlogCommitId(String siteId) get last audited git log commit id for site
String	getLastVerifiedGitlogCommitId(String siteId) get last verified git log commit id for site
ObjectMetadataManager	getObjectMetadataManager()
ObjectStateService	getObjectStateService()
RebuildRepositoryMetadata	getRebuildRepositoryMetadata()
RetryingOperationFacade	getRetryingOperationFacade()
SecurityService	getSecurityService()
ServicesConfig	getServicesConfig()
SiteFeed	getSite(String siteId) Get site details
org.dom4j.Document	getSiteConfiguration(String site) given a site ID return the configuration as a document This method allows extensions to add additional properties to the configuration that are not made available through the site configuration object
String	getSitesConfigPath()
SiteServiceDAL	getSiteService() getter site service dal
List<SiteFeed>	getSitesPerUser(int start, int number) Get sites that user is allowed access to for current user
List<SiteFeed>	getSitesPerUser(String username, int start, int number) Get sites that user is allowed access to for given username
int	getSitesPerUserTotal() Get total number of sites that user is allowed access to for current user
int	getSitesPerUserTotal(String username) Get total number of sites that user is allowed access to for given username
SitesServiceInternal	getSitesServiceInternal()
String	getSiteState(String siteId)
StudioConfiguration	getStudioConfiguration()
StudioDBScriptRunnerFactory	getStudioDBScriptRunner()
SyncDatabaseWithRepository	getSyncDatabaseWithRepository()
UserServiceInternal	getUserServiceInternal()
boolean	isPublishedRepoCreated(String siteId)
boolean	isPublishingEnabled(String siteId) Check if publishing is enabled for given site
List<RemoteRepositoryInfoTO>	listRemote(String siteId) List remote repositories for given site
void	rebuildDatabase(String site) Rebuild database for site
void	reloadGlobalConfiguration()
void	reloadSiteConfiguration(String site)
void	reloadSiteConfiguration(String site, boolean triggerEvent)
void	reloadSiteConfigurations()
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	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setClusterDao(ClusterDAO clusterDao)
void	setConfigurationService(ConfigurationService configurationService)
void	setContentRepository(ContentRepository repo)
void	setContentRepositoryV2(ContentRepository contentRepositoryV2)
void	setContentService(ContentService contentService)
void	setContentTypeService(ContentTypeService contentTypeService)
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	setEventService(EventService eventService)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setGroupServiceInternal(GroupServiceInternal groupServiceInternal)
void	setImportService(ImportService importService)
void	setNotificationService(NotificationService notificationService)
void	setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)
void	setObjectStateService(ObjectStateService objectStateService)
void	setPublishedRepoCreated(String siteId)
void	setRebuildRepositoryMetadata(RebuildRepositoryMetadata rebuildRepositoryMetadata)
void	setRetryingOperationFacade(RetryingOperationFacade retryingOperationFacade)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteServiceDAL(SiteServiceDAL service) setter site service dal
void	setSitesServiceInternal(SitesServiceInternal sitesServiceInternal)
void	setSiteState(String siteId, String state)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setStudioDBScriptRunner(StudioDBScriptRunnerFactory studioDBScriptRunnerFactory)
void	setSyncDatabaseWithRepository(SyncDatabaseWithRepository syncDatabaseWithRepository)
void	setUpgradeManager(UpgradeManager upgradeManager)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
boolean	syncDatabaseWithRepo(String site, String fromCommitId) Synchronize our internal database with the underlying repository.
boolean	syncDatabaseWithRepo(String site, String fromCommitId, boolean generateAuditLog) Synchronize our internal database with the underlying repository.
void	syncRepository(String site) Synchronize Database with repository
boolean	tryLockPublishingForSite(String siteId, String lockOwnerId, int ttl) Lock publishing for site
boolean	unlockPublishingForSite(String siteId, String lockOwnerId) Unlock publishing for site
void	updateLastCommitId(String site, String commitId)
void	updateLastSyncedGitlogCommitId(String site, String commitId) Update last audited gitlog commit id
void	updateLastVerifiedGitlogCommitId(String site, String commitId)
void	updatePublishingLockHeartbeatForSite(String siteId) update publishing lock heartbeat for site
boolean	updatePublishingStatusMessage(String siteId, String status, String message) Update publishing status message for given site
boolean	writeConfiguration(String path, InputStream content) write configuraiton content at the given path (can be any kind of content)
boolean	writeConfiguration(String site, String path, InputStream content) write configuraiton content at the given path (can be any kind of content)

Methods inherited from class java.lang.Object

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

Field Detail

deployer

protected Deployer deployer

_siteServiceDAL

protected SiteServiceDAL _siteServiceDAL

servicesConfig

protected ServicesConfig servicesConfig

contentService

protected ContentService contentService

contentRepository

protected ContentRepository contentRepository

contentRepositoryV2

protected ContentRepository contentRepositoryV2

objectStateService

protected ObjectStateService objectStateService

dependencyService

protected DependencyService dependencyService

securityService

protected SecurityService securityService

deploymentService

protected DeploymentService deploymentService

objectMetadataManager

protected ObjectMetadataManager objectMetadataManager

dmPageNavigationOrderService

protected DmPageNavigationOrderService dmPageNavigationOrderService

contentTypeService

protected ContentTypeService contentTypeService

importService

protected ImportService importService

notificationService

protected NotificationService notificationService

generalLockService

protected GeneralLockService generalLockService

rebuildRepositoryMetadata

protected RebuildRepositoryMetadata rebuildRepositoryMetadata

syncDatabaseWithRepository

protected SyncDatabaseWithRepository syncDatabaseWithRepository

eventService

protected EventService eventService

groupServiceInternal

protected GroupServiceInternal groupServiceInternal

userServiceInternal

protected UserServiceInternal userServiceInternal

upgradeManager

protected UpgradeManager upgradeManager

studioConfiguration

protected StudioConfiguration studioConfiguration

sitesServiceInternal

protected SitesServiceInternal sitesServiceInternal

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

configurationService

protected ConfigurationService configurationService

studioClusterUtils

protected StudioClusterUtils studioClusterUtils

clusterDao

protected ClusterDAO clusterDao

siteFeedMapper

@Autowired
protected SiteFeedMapper siteFeedMapper

entitlementValidator

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

studioDBScriptRunnerFactory

protected StudioDBScriptRunnerFactory studioDBScriptRunnerFactory

dependencyServiceInternal

protected DependencyServiceInternal dependencyServiceInternal

retryingOperationFacade

protected RetryingOperationFacade retryingOperationFacade

Constructor Detail

SiteServiceImpl

public SiteServiceImpl(StudioClusterUtils studioClusterUtils)

Method Detail

writeConfiguration

public boolean writeConfiguration(String site,
                                  String path,
                                  InputStream content)
                           throws ServiceLayerException

Description copied from interface: SiteService

write configuraiton content at the given path (can be any kind of content)

Specified by:

writeConfiguration in interface SiteService

Throws:

ServiceLayerException

writeConfiguration

public boolean writeConfiguration(String path,
                                  InputStream content)
                           throws ServiceLayerException

Description copied from interface: SiteService

write configuraiton content at the given path (can be any kind of content)

Specified by:

writeConfiguration in interface SiteService

Throws:

ServiceLayerException

getConfiguration

public Map<String,Object> getConfiguration(String path)

Description copied from interface: SiteService

get configuraiton content as XML string at the given path

Specified by:

getConfiguration in interface SiteService

Parameters:

path - find from the environment overrides location?

Returns:

configuration as XML string

getSiteConfiguration

public org.dom4j.Document getSiteConfiguration(String site)
                                        throws SiteConfigNotFoundException

given a site ID return the configuration as a document This method allows extensions to add additional properties to the configuration that are not made available through the site configuration object

Specified by:

getSiteConfiguration in interface SiteService

Parameters:

site - the name of the site

Returns:

a Document containing the entire site configuration

Throws:

SiteConfigNotFoundException

getConfiguration

public Map<String,Object> getConfiguration(String site,
                                           String path,
                                           boolean applyEnv)

Description copied from interface: SiteService

get configuraiton content as XML string at the given path

Specified by:

getConfiguration in interface SiteService

applyEnv - find from the environment overrides location?

Returns:

configuration as XML string

getAllAvailableSites

public Set<String> getAllAvailableSites()

Specified by:

getAllAvailableSites in interface SiteService

countSites

public int countSites()

Specified by:

countSites in interface SiteService

createSiteFromBlueprint

public void createSiteFromBlueprint(String blueprintId,
                                    String siteName,
                                    String siteId,
                                    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

siteName - site name

siteId - site identifier

desc - description

params - site parameters

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

Throws:

SiteAlreadyExistsException

SiteCreationException

DeployerTargetException

BlueprintNotFoundException

MissingPluginParameterException

createSiteFromBlueprintGit

protected boolean createSiteFromBlueprintGit(String blueprintLocation,
                                             String siteName,
                                             String siteId,
                                             String sandboxBranch,
                                             String desc,
                                             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

public void createSiteWithRemoteOption(String siteId,
                                       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,
                                       RemoteRepositoryNotBareException,
                                       InvalidRemoteUrlException

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

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

InvalidRemoteRepositoryException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

RemoteRepositoryNotBareException

InvalidRemoteUrlException

deleteSite

public boolean deleteSite(String siteId)

Description copied from interface: SiteService

remove a site from the system

Specified by:

deleteSite in interface SiteService

getAvailableBlueprints

public SiteBlueprintTO[] getAvailableBlueprints()

Description copied from interface: SiteService

get a list of available blueprints

Specified by:

getAvailableBlueprints in interface SiteService

reloadSiteConfigurations

public void reloadSiteConfigurations()

Specified by:

reloadSiteConfigurations in interface SiteService

reloadSiteConfiguration

public void reloadSiteConfiguration(String site)

Specified by:

reloadSiteConfiguration in interface SiteService

reloadSiteConfiguration

public void reloadSiteConfiguration(String site,
                                    boolean triggerEvent)

Specified by:

reloadSiteConfiguration in interface SiteService

reloadGlobalConfiguration

public void reloadGlobalConfiguration()

Specified by:

reloadGlobalConfiguration in interface SiteService

syncRepository

public void syncRepository(String site)
                    throws SiteNotFoundException

Description copied from interface: SiteService

Synchronize Database with repository

Specified by:

syncRepository in interface SiteService

Parameters:

site - site id

Throws:

SiteNotFoundException

rebuildDatabase

public void rebuildDatabase(String site)

Description copied from interface: SiteService

Rebuild database for site

Specified by:

rebuildDatabase in interface SiteService

Parameters:

site - site id

updateLastCommitId

public void updateLastCommitId(String site,
                               String commitId)

Specified by:

updateLastCommitId in interface SiteService

updateLastVerifiedGitlogCommitId

public void updateLastVerifiedGitlogCommitId(String site,
                                             String commitId)

Specified by:

updateLastVerifiedGitlogCommitId in interface SiteService

updateLastSyncedGitlogCommitId

public void updateLastSyncedGitlogCommitId(String site,
                                           String commitId)

Description copied from interface: SiteService

Update last audited gitlog commit id

Specified by:

updateLastSyncedGitlogCommitId in interface SiteService

Parameters:

site - site identifier

commitId - commit ID

syncDatabaseWithRepo

public boolean syncDatabaseWithRepo(String site,
                                    String fromCommitId)
                             throws SiteNotFoundException

Description copied from interface: SiteService

Synchronize our internal database with the underlying repository. This is required when a user bypasses the UI and manipulates the underlying repository directly.

Specified by:

syncDatabaseWithRepo in interface SiteService

Parameters:

site - site to sync

fromCommitId - commit ID to start at and sync up until current commit

Returns:

true if successful, false otherwise

Throws:

SiteNotFoundException

syncDatabaseWithRepo

public boolean syncDatabaseWithRepo(String site,
                                    String fromCommitId,
                                    boolean generateAuditLog)
                             throws SiteNotFoundException

Description copied from interface: SiteService

Synchronize our internal database with the underlying repository. This is required when a user bypasses the UI and manipulates the underlying repository directly.

Specified by:

syncDatabaseWithRepo in interface SiteService

Parameters:

site - site to sync

fromCommitId - commit ID to start at and sync up until current commit

generateAuditLog - if true add operations to audit log

Returns:

true if successful, false otherwise

Throws:

SiteNotFoundException

exists

public 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

existsById

public 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

public 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

public 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

public 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

ServiceLayerException

getSitesPerUser

public 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

public 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

ServiceLayerException

getSite

public SiteFeed getSite(String siteId)
                 throws SiteNotFoundException

Description copied from interface: SiteService

Get site details

Specified by:

getSite in interface SiteService

Parameters:

siteId - site id

Returns:

site details

Throws:

SiteNotFoundException

isPublishingEnabled

public 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

public 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

Throws:

SiteNotFoundException

updatePublishingStatusMessage

public boolean updatePublishingStatusMessage(String siteId,
                                             String status,
                                             String message)
                                      throws SiteNotFoundException

Description copied from interface: SiteService

Update publishing status message for given site

Specified by:

updatePublishingStatusMessage in interface SiteService

Parameters:

siteId - site id

status - status

message - new publishing status message

Returns:

true if publishing status message is successfully updated

Throws:

SiteNotFoundException

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

ServiceLayerException

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

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:

SiteNotFoundException

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

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

tryLockPublishingForSite

public boolean tryLockPublishingForSite(String siteId,
                                        String lockOwnerId,
                                        int ttl)

Description copied from interface: SiteService

Lock publishing for site

Specified by:

tryLockPublishingForSite in interface SiteService

Parameters:

siteId - site identifier

lockOwnerId - lock owner identifier

ttl - TTL for lock

Returns:

true if locking was successful

unlockPublishingForSite

public boolean unlockPublishingForSite(String siteId,
                                       String lockOwnerId)

Description copied from interface: SiteService

Unlock publishing for site

Specified by:

unlockPublishingForSite in interface SiteService

Parameters:

siteId - site identifier

Returns:

true if unlocking was successful

updatePublishingLockHeartbeatForSite

public void updatePublishingLockHeartbeatForSite(String siteId)

Description copied from interface: SiteService

update publishing lock heartbeat for site

Specified by:

updatePublishingLockHeartbeatForSite in interface SiteService

Parameters:

siteId - site identifier

getLastCommitId

public String getLastCommitId(String siteId)

Description copied from interface: SiteService

get last commit id for site

Specified by:

getLastCommitId in interface SiteService

Parameters:

siteId - site identifier

Returns:

last commit id for local studio node

getLastVerifiedGitlogCommitId

public String getLastVerifiedGitlogCommitId(String siteId)

Description copied from interface: SiteService

get last verified git log commit id for site

Specified by:

getLastVerifiedGitlogCommitId in interface SiteService

Parameters:

siteId - site identifier

Returns:

last verified git log commit id for local studio node

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

getLastSyncedGitlogCommitId

public String getLastSyncedGitlogCommitId(String siteId)

Description copied from interface: SiteService

get last audited git log commit id for site

Specified by:

getLastSyncedGitlogCommitId in interface SiteService

Parameters:

siteId - site identifier

Returns:

last audited git log commit id for local studio node

getGlobalConfigRoot

public String getGlobalConfigRoot()

getSitesConfigPath

public String getSitesConfigPath()

getEnvironment

public String getEnvironment()

getDefaultGroups

public List<String> getDefaultGroups()

getSiteService

public SiteServiceDAL getSiteService()

getter site service dal

setSiteServiceDAL

public void setSiteServiceDAL(SiteServiceDAL service)

setter site service dal

getServicesConfig

public ServicesConfig getServicesConfig()

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

getContentService

public ContentService getContentService()

setContentService

public void setContentService(ContentService contentService)

getContenetRepository

public ContentRepository getContenetRepository()

setContentRepository

public void setContentRepository(ContentRepository repo)

getObjectStateService

public ObjectStateService getObjectStateService()

setObjectStateService

public void setObjectStateService(ObjectStateService objectStateService)

getDependencyService

public DependencyService getDependencyService()

setDependencyService

public void setDependencyService(DependencyService dependencyService)

getSecurityService

public SecurityService getSecurityService()

setSecurityService

public void setSecurityService(SecurityService securityService)

getDeploymentService

public DeploymentService getDeploymentService()

setDeploymentService

public void setDeploymentService(DeploymentService deploymentService)

getObjectMetadataManager

public ObjectMetadataManager getObjectMetadataManager()

setObjectMetadataManager

public void setObjectMetadataManager(ObjectMetadataManager objectMetadataManager)

getDmPageNavigationOrderService

public DmPageNavigationOrderService getDmPageNavigationOrderService()

setDmPageNavigationOrderService

public void setDmPageNavigationOrderService(DmPageNavigationOrderService dmPageNavigationOrderService)

getContentTypeService

public ContentTypeService getContentTypeService()

setContentTypeService

public void setContentTypeService(ContentTypeService contentTypeService)

getImportService

public ImportService getImportService()

setImportService

public void setImportService(ImportService importService)

setNotificationService

public void setNotificationService(NotificationService notificationService)

getGeneralLockService

public GeneralLockService getGeneralLockService()

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

getRebuildRepositoryMetadata

public RebuildRepositoryMetadata getRebuildRepositoryMetadata()

setRebuildRepositoryMetadata

public void setRebuildRepositoryMetadata(RebuildRepositoryMetadata rebuildRepositoryMetadata)

getSyncDatabaseWithRepository

public SyncDatabaseWithRepository getSyncDatabaseWithRepository()

setSyncDatabaseWithRepository

public void setSyncDatabaseWithRepository(SyncDatabaseWithRepository syncDatabaseWithRepository)

getStudioConfiguration

public StudioConfiguration getStudioConfiguration()

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

getEventService

public EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getDeployer

public Deployer getDeployer()

setDeployer

public void setDeployer(Deployer deployer)

setEntitlementValidator

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

getGroupServiceInternal

public GroupServiceInternal getGroupServiceInternal()

setGroupServiceInternal

public void setGroupServiceInternal(GroupServiceInternal groupServiceInternal)

getUserServiceInternal

public UserServiceInternal getUserServiceInternal()

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setUpgradeManager

public void setUpgradeManager(UpgradeManager upgradeManager)

getSitesServiceInternal

public SitesServiceInternal getSitesServiceInternal()

setSitesServiceInternal

public void setSitesServiceInternal(SitesServiceInternal sitesServiceInternal)

getAuditServiceInternal

public AuditServiceInternal getAuditServiceInternal()

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

getConfigurationService

public ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getContentRepositoryV2

public ContentRepository getContentRepositoryV2()

setContentRepositoryV2

public void setContentRepositoryV2(ContentRepository contentRepositoryV2)

getClusterDao

public ClusterDAO getClusterDao()

setClusterDao

public void setClusterDao(ClusterDAO clusterDao)

getStudioDBScriptRunner

public StudioDBScriptRunnerFactory getStudioDBScriptRunner()

setStudioDBScriptRunner

public void setStudioDBScriptRunner(StudioDBScriptRunnerFactory studioDBScriptRunnerFactory)

getDependencyServiceInternal

public DependencyServiceInternal getDependencyServiceInternal()

setDependencyServiceInternal

public void setDependencyServiceInternal(DependencyServiceInternal dependencyServiceInternal)

getRetryingOperationFacade

public RetryingOperationFacade getRetryingOperationFacade()

setRetryingOperationFacade

public void setRetryingOperationFacade(RetryingOperationFacade retryingOperationFacade)