org.jahia.services.content.decorator

Class JCRSiteNode

java.lang.Object

org.jahia.services.content.decorator.JCRNodeDecorator

org.jahia.services.content.decorator.JCRSiteNode

All Implemented Interfaces:

javax.jcr.Item, javax.jcr.Node, JCRItemWrapper, JCRNodeWrapper, JahiaSite

public class JCRSiteNode
extends JCRNodeDecorator
implements JahiaSite

JCR node representing the Jahia virtual site. User: toto Date: Mar 30, 2010 Time: 12:37:45 PM

Nested Class Summary

Nested classes/interfaces inherited from interface org.jahia.services.content.JCRNodeWrapper

JCRNodeWrapper.NodeNamingConflictResolutionStrategy

Field Summary

Fields inherited from class org.jahia.services.content.decorator.JCRNodeDecorator

node

Fields inherited from interface org.jahia.services.content.JCRNodeWrapper

EMPTY

Fields inherited from interface javax.jcr.Node

JCR_CHILD_NODE_DEFINITION, JCR_CONTENT, JCR_FROZEN_NODE, JCR_PROPERTY_DEFINITION, JCR_ROOT_VERSION, JCR_VERSION_LABELS

Constructor Summary

Constructors

Constructor and Description
JCRSiteNode(JCRNodeWrapper node)

Method Summary

Modifier and Type	Method and Description
Set<String>	getActiveLanguages() Deprecated. use getActiveLiveLanguages() method instead
List<Locale>	getActiveLanguagesAsLocales() Deprecated. use either getActiveLiveLanguagesAsLocales() or getActiveLiveLanguages() methods instead
Set<String>	getActiveLiveLanguages() Returns a set of active site languages
List<Locale>	getActiveLiveLanguagesAsLocales() Returns an List of active site language ( as Locale ).
List<String>	getAllInstalledModules() Get installed modules with their dependencies
List<String>	getAllServerNames() Return the list of accepted server names.
String	getDefaultLanguage()
String	getDescr()
String	getDescription() Returns the description, provided for this site.
JCRNodeWrapper	getHome()
String	getHtmlMarkupFilteringTags()
Set<String>	getInactiveLanguages() Returns a set of languages, which are deactivated completely for browsing and editing.
List<Locale>	getInactiveLanguagesAsLocales() Returns an List of inactive site language ( as Locale ).
Set<String>	getInactiveLiveLanguages() Returns a set of languages, which are not considered in live mode browsing, i.e.
List<String>	getInstalledModules()
Set<String>	getInstalledModulesWithAllDependencies() Returns a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree).
String	getJCRLocalPath()
Set<String>	getLanguages() Returns a List of site language settings.
List<Locale>	getLanguagesAsLocales() Returns an List of site language ( as Locale ).
Set<String>	getMandatoryLanguages()
JCRSiteNode	getResolveSite()
String	getServerName() Return the Full Qualified Domain Name ( www.jahia.org )
List<String>	getServerNameAliases() Returns a list of additional server names (aliases).
String	getSiteKey() Return the unique String identifier key ( ex: jahia )
String	getTemplateFolder()
JahiaTemplatesPackage	getTemplatePackage() Returns the corresponding template set of this virtual site.
String	getTemplatePackageName() Returns the corresponding template set name of this virtual site.
String	getTitle()
boolean	isAllowsUnlistedLanguages()
boolean	isDefault() Returns true if this site is the default one on the server.
boolean	isHtmlMarkupFilteringEnabled()
boolean	isMixLanguagesActive()
boolean	isWCAGComplianceCheckEnabled()
void	setAllowsUnlistedLanguages(boolean allowsUnlistedLanguages)
void	setAllowsUnlistedLanguages(Boolean allowsUnlistedLanguages)
void	setDefaultLanguage(String defaultLanguage)
void	setDescr(String descr)
void	setDescription(String description)
void	setInactiveLanguages(Set<String> inactiveLanguages) Sets languages, which are completely deactivated for browsing and editing.
void	setInactiveLiveLanguages(Set<String> inactiveLiveLanguages) Sets languages, which are not considered in live mode browsing, i.e.
void	setInstalledModules(List<String> installedModules)
void	setLanguages(Set<String> languages) Sets the language settings for this site.
void	setMandatoryLanguages(Set<String> mandatoryLanguages)
void	setMixLanguagesActive(boolean mixLanguagesActive) Sets the value of the site property that controls
JCRPropertyWrapper	setProperty(String s, boolean value)
JCRPropertyWrapper	setProperty(String s, String value)
JCRPropertyWrapper	setProperty(String s, String[] values)
void	setServerName(String name) Set the Full Qualified Domain Name ( www.jahia.org )
void	setServerNameAliases(List<String> names) Sets a list of additional server names (aliases).
void	setTitle(String value)

Methods inherited from class org.jahia.services.content.decorator.JCRNodeDecorator

accept, addMixin, addNode, addNode, addNode, canAddMixin, cancelMerge, canMarkForDeletion, changeRoles, checkI18nAndMandatoryPropertiesForLocale, checkin, checkLanguageValidity, checkLock, checkout, checkpoint, checkValidity, clearAllLocks, clone, copy, copy, copy, copy, copy, copy, copy, copy, copy, copyProperties, createCollection, decorateProperty, denyRoles, doneMerge, equals, followLifecycleTransition, getAbsoluteUrl, getAbsoluteWebdavUrl, getAccessControlManager, getAclEntries, getAclInheritanceBreak, getActualAclEntries, getAllowedLifecycleTransistions, getAncestor, getAncestors, getApplicableChildNodeDefinition, getApplicablePropertyDefinition, getApplicablePropertyDefinition, getAvailableRoles, getBaseVersion, getCanonicalPath, getContentLastModifiedAsDate, getContentLastPublishedAsDate, getCorrespondingNodePath, getCreationDateAsDate, getCreationUser, getDecoratedNode, getDefinition, getDepth, getDisplayableName, getExistingLocales, getFileContent, getI18N, getI18N, getI18Ns, getIdentifier, getIndex, getJCRProvider, getLanguage, getLastModifiedAsDate, getLastPublishedAsDate, getLinearVersionInfos, getLock, getLockedLocales, getLockInfos, getLockOwner, getMixinNodeTypes, getModificationUser, getName, getNode, getNodes, getNodes, getNodes, getNodeTypes, getOrCreateI18N, getOrCreateI18N, getParent, getPath, getPermissions, getPermissionsAsBitSet, getPlaceholder, getPrimaryItem, getPrimaryNodeType, getPrimaryNodeTypeName, getProperties, getProperties, getProperties, getPropertiesAsString, getProperty, getPropertyAsString, getProvider, getPublicationUser, getRealNode, getReferenceProperties, getReferences, getReferences, getSession, getSharedSet, getThumbnails, getThumbnailUrl, getThumbnailUrls, getUnescapedName, getUrl, getUser, getUUID, getVersionHistory, getVersionInfos, getVersions, getVersionsAsVersion, getWeakReferences, getWeakReferences, getWebdavUrl, grantRoles, hashCode, hasI18N, hasI18N, hasNode, hasNodes, hasPermission, hasProperties, hasProperty, hasTranslations, holdsLock, internalCopy, isCheckedOut, isCollection, isFile, isLockable, isLocked, isMarkedForDeletion, isModified, isNew, isNode, isNodeType, isPortlet, isSame, isVersioned, lock, lockAndStoreToken, lockAndStoreToken, markForDeletion, merge, orderBefore, refresh, remove, removeMixin, removeShare, removeSharedSet, rename, restore, restore, restore, restoreByLabel, revokeAllRoles, revokeRolesForPrincipal, save, saveSession, setAclInheritanceBreak, setPrimaryType, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString, unlock, unlock, unlock, unmarkForDeletion, update, uploadFile, versionFile

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JCRSiteNode

public JCRSiteNode(JCRNodeWrapper node)

Method Detail

getInactiveLiveLanguages

public Set<String> getInactiveLiveLanguages()

Description copied from interface: JahiaSite

Returns a set of languages, which are not considered in live mode browsing, i.e. are currently inactive in navigation.

Specified by:

getInactiveLiveLanguages in interface JahiaSite

Returns:

list of inactive live languages

getInactiveLanguages

public Set<String> getInactiveLanguages()

Description copied from interface: JahiaSite

Returns a set of languages, which are deactivated completely for browsing and editing.

Specified by:

getInactiveLanguages in interface JahiaSite

Returns:

list of inactive languages

getActiveLanguagesAsLocales

@Deprecated
public List<Locale> getActiveLanguagesAsLocales()

Deprecated. use either getActiveLiveLanguagesAsLocales() or getActiveLiveLanguages() methods instead

getActiveLanguages

@Deprecated
public Set<String> getActiveLanguages()

Deprecated. use getActiveLiveLanguages() method instead

getActiveLiveLanguages

public Set<String> getActiveLiveLanguages()

Returns a set of active site languages

Returns:

a set of active site languages

getActiveLiveLanguagesAsLocales

public List<Locale> getActiveLiveLanguagesAsLocales()

Returns an List of active site language ( as Locale ).

Returns:

a List of Locale elements

getInactiveLanguagesAsLocales

public List<Locale> getInactiveLanguagesAsLocales()

Returns an List of inactive site language ( as Locale ).

Returns:

a List of Locale elements

getDefaultLanguage

public String getDefaultLanguage()

Specified by:

getDefaultLanguage in interface JahiaSite

getDescr

public String getDescr()

getHome

public JCRNodeWrapper getHome()
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getHtmlMarkupFilteringTags

public String getHtmlMarkupFilteringTags()

getLanguages

public Set<String> getLanguages()

Description copied from interface: JahiaSite

Returns a List of site language settings. The order of this List corresponds to the ranking of the languages.

Specified by:

getLanguages in interface JahiaSite

Returns:

a List containing String elements.

getLanguagesAsLocales

public List<Locale> getLanguagesAsLocales()

Returns an List of site language ( as Locale ).

Specified by:

getLanguagesAsLocales in interface JahiaSite

Returns:

an List of Locale elements.

getMandatoryLanguages

public Set<String> getMandatoryLanguages()

Specified by:

getMandatoryLanguages in interface JahiaSite

getResolveSite

public JCRSiteNode getResolveSite()
                           throws javax.jcr.RepositoryException

Specified by:

getResolveSite in interface JCRNodeWrapper

Overrides:

getResolveSite in class JCRNodeDecorator

Throws:

javax.jcr.RepositoryException

getServerName

public String getServerName()

Description copied from interface: JahiaSite

Return the Full Qualified Domain Name ( www.jahia.org )

Specified by:

getServerName in interface JahiaSite

getServerNameAliases

public List<String> getServerNameAliases()

Description copied from interface: JahiaSite

Returns a list of additional server names (aliases).

Specified by:

getServerNameAliases in interface JahiaSite

Returns:

list of additional server names (aliases)

getAllServerNames

public List<String> getAllServerNames()

Description copied from interface: JahiaSite

Return the list of accepted server names.

Specified by:

getAllServerNames in interface JahiaSite

getSiteKey

public String getSiteKey()

Description copied from interface: JahiaSite

Return the unique String identifier key ( ex: jahia )

Specified by:

getSiteKey in interface JahiaSite

getTemplateFolder

public String getTemplateFolder()

Specified by:

getTemplateFolder in interface JahiaSite

getInstalledModules

public List<String> getInstalledModules()

Specified by:

getInstalledModules in interface JahiaSite

getInstalledModulesWithAllDependencies

public Set<String> getInstalledModulesWithAllDependencies()

Returns a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree).

Returns:

a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree)

getAllInstalledModules

public List<String> getAllInstalledModules()

Get installed modules with their dependencies

Returns:

getTemplatePackageName

public String getTemplatePackageName()

Returns the corresponding template set name of this virtual site.

Specified by:

getTemplatePackageName in interface JahiaSite

Returns:

the corresponding template set name of this virtual site

getTemplatePackage

public JahiaTemplatesPackage getTemplatePackage()

Returns the corresponding template set of this virtual site.

Returns:

the corresponding template set of this virtual site

getTitle

public String getTitle()

Specified by:

getTitle in interface JahiaSite

isHtmlMarkupFilteringEnabled

public boolean isHtmlMarkupFilteringEnabled()

isMixLanguagesActive

public boolean isMixLanguagesActive()

Specified by:

isMixLanguagesActive in interface JahiaSite

isAllowsUnlistedLanguages

public boolean isAllowsUnlistedLanguages()

Specified by:

isAllowsUnlistedLanguages in interface JahiaSite

isWCAGComplianceCheckEnabled

public boolean isWCAGComplianceCheckEnabled()

setDefaultLanguage

public void setDefaultLanguage(String defaultLanguage)

Specified by:

setDefaultLanguage in interface JahiaSite

setLanguages

public void setLanguages(Set<String> languages)

Sets the language settings for this site. This directly interfaces with the persistent storage to store the modifications if there were any.

Specified by:

setLanguages in interface JahiaSite

Throws:

JahiaException - when an error occured while storing the modified site language settings values.

setMandatoryLanguages

public void setMandatoryLanguages(Set<String> mandatoryLanguages)

Specified by:

setMandatoryLanguages in interface JahiaSite

setMixLanguagesActive

public void setMixLanguagesActive(boolean mixLanguagesActive)

Sets the value of the site property that controls

Specified by:

setMixLanguagesActive in interface JahiaSite

Parameters:

mixLanguagesActive -

setAllowsUnlistedLanguages

public void setAllowsUnlistedLanguages(Boolean allowsUnlistedLanguages)

getDescription

public String getDescription()

Description copied from interface: JahiaSite

Returns the description, provided for this site.

Specified by:

getDescription in interface JahiaSite

Returns:

the description, provided for this site

isDefault

public boolean isDefault()

Returns true if this site is the default one on the server.

Specified by:

isDefault in interface JahiaSite

Returns:

true if this site is the default one on the server

setDescr

public void setDescr(String descr)

Specified by:

setDescr in interface JahiaSite

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface JahiaSite

setInactiveLanguages

public void setInactiveLanguages(Set<String> inactiveLanguages)

Sets languages, which are completely deactivated for browsing and editing.

Specified by:

setInactiveLanguages in interface JahiaSite

Parameters:

inactiveLanguages - the set of inactive languages

setInactiveLiveLanguages

public void setInactiveLiveLanguages(Set<String> inactiveLiveLanguages)

Sets languages, which are not considered in live mode browsing, i.e. are currently inactive in navigation.

Specified by:

setInactiveLiveLanguages in interface JahiaSite

Parameters:

inactiveLiveLanguages - the set of inactive languages

setInstalledModules

public void setInstalledModules(List<String> installedModules)

Specified by:

setInstalledModules in interface JahiaSite

setAllowsUnlistedLanguages

public void setAllowsUnlistedLanguages(boolean allowsUnlistedLanguages)

Specified by:

setAllowsUnlistedLanguages in interface JahiaSite

setServerName

public void setServerName(String name)

Set the Full Qualified Domain Name ( www.jahia.org )

Specified by:

setServerName in interface JahiaSite

setServerNameAliases

public void setServerNameAliases(List<String> names)

Description copied from interface: JahiaSite

Sets a list of additional server names (aliases).

Specified by:

setServerNameAliases in interface JahiaSite

Parameters:

names - a list of additional server names (aliases)

setTitle

public void setTitle(String value)

Specified by:

setTitle in interface JahiaSite

getJCRLocalPath

public String getJCRLocalPath()

Specified by:

getJCRLocalPath in interface JahiaSite

setProperty

public JCRPropertyWrapper setProperty(String s,
                                      String value)
                               throws javax.jcr.ValueFormatException,
                                      javax.jcr.version.VersionException,
                                      javax.jcr.lock.LockException,
                                      javax.jcr.nodetype.ConstraintViolationException,
                                      javax.jcr.RepositoryException

Description copied from interface: JCRNodeWrapper

Specified by:

setProperty in interface javax.jcr.Node

Specified by:

setProperty in interface JCRNodeWrapper

Overrides:

setProperty in class JCRNodeDecorator

Returns:

The updated Property object wrapped in JCRPropertywWrapper

Throws:

javax.jcr.ValueFormatException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException

setProperty

public JCRPropertyWrapper setProperty(String s,
                                      boolean value)
                               throws javax.jcr.ValueFormatException,
                                      javax.jcr.version.VersionException,
                                      javax.jcr.lock.LockException,
                                      javax.jcr.nodetype.ConstraintViolationException,
                                      javax.jcr.RepositoryException

Description copied from interface: JCRNodeWrapper

Specified by:

setProperty in interface javax.jcr.Node

Specified by:

setProperty in interface JCRNodeWrapper

Overrides:

setProperty in class JCRNodeDecorator

Returns:

The updated Property object wrapped in JCRPropertywWrapper

Throws:

javax.jcr.ValueFormatException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException

setProperty

public JCRPropertyWrapper setProperty(String s,
                                      String[] values)
                               throws javax.jcr.ValueFormatException,
                                      javax.jcr.version.VersionException,
                                      javax.jcr.lock.LockException,
                                      javax.jcr.nodetype.ConstraintViolationException,
                                      javax.jcr.RepositoryException

Description copied from interface: JCRNodeWrapper

Specified by:

setProperty in interface javax.jcr.Node

Specified by:

setProperty in interface JCRNodeWrapper

Overrides:

setProperty in class JCRNodeDecorator

Returns:

The updated Property object wrapped in JCRPropertywWrapper

Throws:

javax.jcr.ValueFormatException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.nodetype.ConstraintViolationException

javax.jcr.RepositoryException