org.jahia.services.sites

Class JahiaSitesService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.sites.JahiaSitesService

public class JahiaSitesService
extends JahiaService

Jahia Multi Sites Management Service

Author:

Khue ng

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JahiaSitesService.SiteDefaultLanguageBySiteKeyCacheEntryFactory
class	JahiaSitesService.SiteKeyByServerNameCacheEntryFactory Factory to fill the site key by server name cache.

Field Summary

Fields

Modifier and Type	Field and Description
protected EhCacheProvider	ehCacheProvider
protected JahiaGroupManagerService	groupService
protected JCRSessionFactory	sessionFactory
static String	SITES_JCR_PATH
static String	SYSTEM_SITE_KEY

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Method Summary

Modifier and Type	Method and Description
JahiaSite	addSite(JahiaUser currentUser, String title, String serverName, String siteKey, String descr, Locale selectedLocale, String selectTmplSet, String[] modulesToDeploy, String firstImport, org.springframework.core.io.Resource fileImport, String fileImportName, Boolean asAJob, Boolean doImportServerPermissions, String originatingJahiaRelease) Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead
JahiaSite	addSite(JahiaUser currentUser, String title, String serverName, String siteKey, String descr, Locale selectedLocale, String selectTmplSet, String[] modulesToDeploy, String firstImport, org.springframework.core.io.Resource fileImport, String fileImportName, Boolean asAJob, Boolean doImportServerPermissions, String originatingJahiaRelease, org.springframework.core.io.Resource legacyMappingFilePath, org.springframework.core.io.Resource legacyDefinitionsFilePath) Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead
JahiaSite	addSite(JahiaUser currentUser, String title, String serverName, String siteKey, String descr, Locale selectedLocale, String selectTmplSet, String[] modulesToDeploy, String firstImport, org.springframework.core.io.Resource fileImport, String fileImportName, Boolean asAJob, Boolean doImportServerPermissions, String originatingJahiaRelease, org.springframework.core.io.Resource legacyMappingFilePath, org.springframework.core.io.Resource legacyDefinitionsFilePath, JCRSessionWrapper session) Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo, JCRSessionWrapper) instead
JahiaSite	addSite(JahiaUser currentUser, String title, String serverName, String siteKey, String descr, Locale selectedLocale, String selectTmplSet, String firstImport, org.springframework.core.io.Resource fileImport, String fileImportName, Boolean asAJob, Boolean doImportServerPermissions, String originatingJahiaRelease) Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead
JahiaSite	addSite(SiteCreationInfo info) Creates the site using the specified data.
JahiaSite	addSite(SiteCreationInfo info, JCRSessionWrapper session) Creates the site using the specified data.
void	deployModules(JahiaSite site, String[] modulesToDeploy, JCRSessionWrapper session)
static void	flushSitesInternalCaches() Flush the sites internal caches ( site key by server name & default language by site key).
JahiaSite	getDefaultSite()
JahiaSite	getDefaultSite(JCRSessionWrapper session)
JCRSiteNode	getFirstSiteFound(JCRSessionWrapper session, String... skippedSites) Returns first found site node under /sites considering the list of sites to be skipped.
static JahiaSitesService	getInstance() Retrieves the unique instance of this singleton class.
int	getNbSites() Deprecated. since Jahia 8.0.0.0 use getSiteCount(boolean) instead
JahiaSite	getSite(String name) return a site looking at it's name
JahiaSite	getSiteByKey(String siteKey) return a site bean looking at it key
JCRSiteNode	getSiteByKey(String siteKey, JCRSessionWrapper session)
JahiaSite	getSiteByServerName(String serverName) Find a site by it's server name value
JCRSiteNode	getSiteByServerName(String serverName, JCRSessionWrapper session)
long	getSiteCount(boolean includeSystemSite) This method count the sites with or without the systemsite
String	getSiteDefaultLanguage(String siteKey)
String	getSitenameByServerName(String serverName)
List<String>	getSitesNames() return the list of all sites names
List<JCRSiteNode>	getSitesNodeList() return the list of all sites
List<JCRSiteNode>	getSitesNodeList(JCRSessionWrapper session)
String	getValidSiteKeyCharacters()
void	invalidateCache(JahiaSite site) Invalidates the cache for the specified site.
void	invalidateCache(String siteKey, List<String> serverNames) Invalidates the cache for the specified site.
void	invalidateCache(String siteKey, String serverName)
boolean	isServerNameValid(String serverName)
boolean	isSiteKeyValid(String siteKey)
void	removeSite(JahiaSite siteToRemove) Remove a site; if the removed site is the default one: - the first other site found will become the default - if no other site found, no default site anymore
void	setDefaultSite(JahiaSite site)
void	setDefaultSite(JahiaSite site, JCRSessionWrapper session)
void	setEhCacheProvider(EhCacheProvider ehCacheProvider)
void	setGroupService(JahiaGroupManagerService groupService)
void	setSessionFactory(JCRSessionFactory sessionFactory)
void	setValidServerNameRegex(String validServerNameRegex)
void	setValidSiteKeyCharacters(String validSiteKeyCharacters)
boolean	siteExists(String siteKey, JCRSessionWrapper session)
void	start()
void	stop()
void	updateModules(JahiaSite site, List<String> newModuleIds, JCRSessionWrapper session)
boolean	updateSystemSiteLanguages(JahiaSite site, JCRSessionWrapper session)
void	updateSystemSitePermissions(JahiaSite site) Update a JahiaSite definition
void	updateSystemSitePermissions(JahiaSite site, JCRSessionWrapper session)

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_SITE_KEY

public static final String SYSTEM_SITE_KEY

See Also:

Constant Field Values

SITES_JCR_PATH

public static final String SITES_JCR_PATH

See Also:

Constant Field Values

groupService

protected JahiaGroupManagerService groupService

sessionFactory

protected JCRSessionFactory sessionFactory

ehCacheProvider

protected EhCacheProvider ehCacheProvider

Method Detail

setGroupService

public void setGroupService(JahiaGroupManagerService groupService)

setSessionFactory

public void setSessionFactory(JCRSessionFactory sessionFactory)

getInstance

public static JahiaSitesService getInstance()

Retrieves the unique instance of this singleton class.

Returns:

the unique instance of this class

getSitesNames

public List<String> getSitesNames()

return the list of all sites names

Returns:

List List of site names

getSitesNodeList

public List<JCRSiteNode> getSitesNodeList()
                                   throws javax.jcr.RepositoryException

return the list of all sites

Returns:

List List of JCRSiteNode

Throws:

javax.jcr.RepositoryException

getSitesNodeList

public List<JCRSiteNode> getSitesNodeList(JCRSessionWrapper session)
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getFirstSiteFound

public JCRSiteNode getFirstSiteFound(JCRSessionWrapper session,
                                     String... skippedSites)
                              throws javax.jcr.RepositoryException

Returns first found site node under /sites considering the list of sites to be skipped.

Parameters:

session - current JCR session

skippedSites - an array of site keys for sites to be skipped

Returns:

first found node under /sites considering the list of sites to be skipped

Throws:

javax.jcr.RepositoryException - in case of an error

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()

Specified by:

stop in class JahiaService

getSiteByKey

public JahiaSite getSiteByKey(String siteKey)
                       throws JahiaException

return a site bean looking at it key

Parameters:

siteKey - the site key

Returns:

JahiaSite the JahiaSite bean

Throws:

JahiaException

getSiteByKey

public JCRSiteNode getSiteByKey(String siteKey,
                                JCRSessionWrapper session)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

siteExists

public boolean siteExists(String siteKey,
                          JCRSessionWrapper session)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSiteByServerName

public JahiaSite getSiteByServerName(String serverName)
                              throws JahiaException

Find a site by it's server name value

Parameters:

serverName - the server name to look for

Returns:

if found, returns the site with the corresponding serverName, or the first one if there are multiple, or null if there are none.

Throws:

JahiaException - thrown if there was a problem communicating with the database.

getSiteByServerName

public JCRSiteNode getSiteByServerName(String serverName,
                                       JCRSessionWrapper session)
                                throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSitenameByServerName

public String getSitenameByServerName(String serverName)
                               throws JahiaException

Throws:

JahiaException

getSite

public JahiaSite getSite(String name)
                  throws JahiaException

return a site looking at it's name

Parameters:

name - the site name

Returns:

JahiaSite the JahiaSite bean or null

Throws:

JahiaException

addSite

@Deprecated
public JahiaSite addSite(JahiaUser currentUser,
                                     String title,
                                     String serverName,
                                     String siteKey,
                                     String descr,
                                     Locale selectedLocale,
                                     String selectTmplSet,
                                     String firstImport,
                                     org.springframework.core.io.Resource fileImport,
                                     String fileImportName,
                                     Boolean asAJob,
                                     Boolean doImportServerPermissions,
                                     String originatingJahiaRelease)
                              throws JahiaException,
                                     IOException

Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead

Throws:

JahiaException

IOException

addSite

@Deprecated
public JahiaSite addSite(JahiaUser currentUser,
                                     String title,
                                     String serverName,
                                     String siteKey,
                                     String descr,
                                     Locale selectedLocale,
                                     String selectTmplSet,
                                     String[] modulesToDeploy,
                                     String firstImport,
                                     org.springframework.core.io.Resource fileImport,
                                     String fileImportName,
                                     Boolean asAJob,
                                     Boolean doImportServerPermissions,
                                     String originatingJahiaRelease)
                              throws JahiaException,
                                     IOException

Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead

Throws:

JahiaException

IOException

addSite

@Deprecated
public JahiaSite addSite(JahiaUser currentUser,
                                     String title,
                                     String serverName,
                                     String siteKey,
                                     String descr,
                                     Locale selectedLocale,
                                     String selectTmplSet,
                                     String[] modulesToDeploy,
                                     String firstImport,
                                     org.springframework.core.io.Resource fileImport,
                                     String fileImportName,
                                     Boolean asAJob,
                                     Boolean doImportServerPermissions,
                                     String originatingJahiaRelease,
                                     org.springframework.core.io.Resource legacyMappingFilePath,
                                     org.springframework.core.io.Resource legacyDefinitionsFilePath)
                              throws JahiaException,
                                     IOException

Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo) instead

Throws:

JahiaException

IOException

addSite

@Deprecated
public JahiaSite addSite(JahiaUser currentUser,
                                     String title,
                                     String serverName,
                                     String siteKey,
                                     String descr,
                                     Locale selectedLocale,
                                     String selectTmplSet,
                                     String[] modulesToDeploy,
                                     String firstImport,
                                     org.springframework.core.io.Resource fileImport,
                                     String fileImportName,
                                     Boolean asAJob,
                                     Boolean doImportServerPermissions,
                                     String originatingJahiaRelease,
                                     org.springframework.core.io.Resource legacyMappingFilePath,
                                     org.springframework.core.io.Resource legacyDefinitionsFilePath,
                                     JCRSessionWrapper session)
                              throws JahiaException,
                                     IOException

Deprecated. since 7.2.2.0. Use the addSite(SiteCreationInfo, JCRSessionWrapper) instead

Throws:

JahiaException

IOException

addSite

public JahiaSite addSite(SiteCreationInfo info)
                  throws JahiaException,
                         IOException

Creates the site using the specified data.

Parameters:

info - the site creation information

Returns:

the created site object

Throws:

JahiaException - in case of site creation issues

IOException - in case of I/O errors

addSite

public JahiaSite addSite(SiteCreationInfo info,
                         JCRSessionWrapper session)
                  throws JahiaException,
                         IOException

Creates the site using the specified data.

Parameters:

info - the site creation information

session - the current JCR session to use for site creation

Returns:

the created site object

Throws:

JahiaException - in case of site creation issues

IOException - in case of I/O errors

deployModules

public void deployModules(JahiaSite site,
                          String[] modulesToDeploy,
                          JCRSessionWrapper session)

updateModules

public void updateModules(JahiaSite site,
                          List<String> newModuleIds,
                          JCRSessionWrapper session)

removeSite

public void removeSite(JahiaSite siteToRemove)
                throws JahiaException

Remove a site; if the removed site is the default one: - the first other site found will become the default - if no other site found, no default site anymore

Parameters:

siteToRemove - the JahiaSite bean to be removed

Throws:

JahiaException

updateSystemSitePermissions

public void updateSystemSitePermissions(JahiaSite site)
                                 throws JahiaException

Update a JahiaSite definition

Parameters:

site - the site bean object

Throws:

JahiaException

updateSystemSitePermissions

public void updateSystemSitePermissions(JahiaSite site,
                                        JCRSessionWrapper session)
                                 throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getNbSites

@Deprecated
public int getNbSites()
                           throws JahiaException

Deprecated. since Jahia 8.0.0.0 use getSiteCount(boolean) instead

Throws:

JahiaException

getSiteCount

public long getSiteCount(boolean includeSystemSite)

This method count the sites with or without the systemsite

Parameters:

includeSystemSite - true if you want to include the systemsite in the result

Returns:

The number of sites

getDefaultSite

public JahiaSite getDefaultSite()

getDefaultSite

public JahiaSite getDefaultSite(JCRSessionWrapper session)
                         throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setDefaultSite

public void setDefaultSite(JahiaSite site)

setDefaultSite

public void setDefaultSite(JahiaSite site,
                           JCRSessionWrapper session)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

invalidateCache

public void invalidateCache(JahiaSite site)
                     throws JahiaException

Invalidates the cache for the specified site.

Parameters:

site - the site bean object

Throws:

JahiaException

invalidateCache

public void invalidateCache(String siteKey,
                            String serverName)

invalidateCache

public void invalidateCache(String siteKey,
                            List<String> serverNames)

Invalidates the cache for the specified site.

Parameters:

siteKey - the key of the site

serverNames - the server names of the site

isSiteKeyValid

public boolean isSiteKeyValid(String siteKey)

isServerNameValid

public boolean isServerNameValid(String serverName)

updateSystemSiteLanguages

public boolean updateSystemSiteLanguages(JahiaSite site,
                                         JCRSessionWrapper session)

getSiteDefaultLanguage

public String getSiteDefaultLanguage(String siteKey)
                              throws JahiaException

Throws:

JahiaException

flushSitesInternalCaches

public static void flushSitesInternalCaches()

Flush the sites internal caches ( site key by server name & default language by site key).

setEhCacheProvider

public void setEhCacheProvider(EhCacheProvider ehCacheProvider)

setValidServerNameRegex

public void setValidServerNameRegex(String validServerNameRegex)

getValidSiteKeyCharacters

public String getValidSiteKeyCharacters()

setValidSiteKeyCharacters

public void setValidSiteKeyCharacters(String validSiteKeyCharacters)