Uses of Class
org.opencms.file.CmsObject

Packages that use CmsObject

Package	Description
org.opencms.ade.configuration	Contains the ade configuration classes.
org.opencms.ade.configuration.formatters	Classes for handling formatter configurations
org.opencms.ade.containerpage	Contains the container page editor service classes.
org.opencms.ade.containerpage.inherited	Contains classes used for reading and caching inheritance groups.
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.ade.detailpage	Contains functions for the detail pages in OpenCms.
org.opencms.ade.galleries	Contains server side classes for the gallery dialogs.
org.opencms.ade.publish	This package contains the server-side classes for the publish module
org.opencms.ade.sitemap	Server side of the sitemap view.
org.opencms.ade.upload
org.opencms.cache	Implementations of specialized caches used in OpenCms.
org.opencms.cmis
org.opencms.configuration	Reads and writes the XML based OpenCms configuration files.
org.opencms.configuration.preferences	Classes to build the user preferences dialog.
org.opencms.db	Low-level database connection and access functionality.
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.collectors	Collectors allow to gather lists of OpenCms resources from the OpenCms VFS using specific rules.
org.opencms.file.history	This package contains the classes to deal with the OpenCms VFS history archive.
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
org.opencms.file.wrapper	This package contains classes and interfaces used to access OpenCms through a wrapped CmsObject.
org.opencms.flex	Provides low-level JSP integration funtionality for OpenCms, also implements the FlexCache, a declarative parameter-based cache.
org.opencms.gwt	Provides core support for GWT.
org.opencms.i18n	Classes to handle internalization (i18n) and locale selection in OpenCms.
org.opencms.i18n.tools	Tools for i18n.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.jlan
org.opencms.jsp	The implementation of the OpenCms JSP tag library, with some additional utility classes to help in JSP scriplet code and navigation building.
org.opencms.jsp.decorator	HTML postprocessor, used to tag single words or phrases in the HTML output.
org.opencms.jsp.parse	API classes for the <cms:parse> tag.
org.opencms.jsp.search.config.parser	API classes for the configuration parsers of the search form support provided for server-side Solr search.
org.opencms.jsp.search.controller	API classes for the controllers of the search form support provided for server-side Solr search.
org.opencms.jsp.search.result	API classes for the result of the search form support provided for server-side Solr search.
org.opencms.jsp.util	Utility classes to be used for JSP pages.
org.opencms.loader	Low-level functions to manage the loading of resources from the OpenCms VFS.
org.opencms.lock	The lock state of the resources in the VFS is handled with these classes.
org.opencms.mail	Provides utility classes to generate email messages using the OpenCms email configuration.
org.opencms.main	Provides the main OpenCms "operating system".
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.monitor	Contains functions to monitor the OpenCms system status.
org.opencms.newsletter	Contains classes to distribute newsletters.
org.opencms.notification	Contains classes for the automatical notification of outdated, expiring or released content.
org.opencms.pdftools
org.opencms.publish	Classes to handle the OpenCms publish process.
org.opencms.relations	Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
org.opencms.report	Classes used to generate the OpenCms reports, which are displayed during publish, import, export etc.
org.opencms.repository	Package contains all classes and interfaces needed to create or use a repository to access the resources in the VFS.
org.opencms.scheduler	The OpenCms scheduler provides a facility to run jobs in a regular schedule, much like the "cron" faciltiy in UNIX systems.
org.opencms.scheduler.jobs	Some predefined implementations for often used scheduled job tasks.
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.fields	These classes control the mapping of the OpenCms content to the Lucene search fields.
org.opencms.search.galleries	Implements the search functions for the OpenCms Gallery search index, which is used by the Advanced Direct Edit (ADE) functions.
org.opencms.search.solr	The package contains the Solr search integration.
org.opencms.search.solr.spellchecking	Contains the SOLR based spellcheck service classes.
org.opencms.security	Access control and security classes for the OpenCms ACL permission system.
org.opencms.site	Provides access to the multi-site configuration of OpenCms.
org.opencms.site.xmlsitemap	Contains classes related to XML sitemap generation.
org.opencms.staticexport	Contains the functionality for the static HTML page export.
org.opencms.synchronize	Classes used to synchronize the OpenCms VFS with the real file system.
org.opencms.ugc
org.opencms.ui	General code for the Vaadin UI
org.opencms.ui.actions	Contains classes for workplace actions.
org.opencms.ui.apps	Contains code for workplace apps
org.opencms.ui.apps.cacheadmin	Contains classes of the cache admin app.
org.opencms.ui.apps.dbmanager	Contains classes of the cache admin app.
org.opencms.ui.apps.filehistory	Contains classes of the file history app.
org.opencms.ui.apps.git	This package contains the app classes for the git check in functionality.
org.opencms.ui.apps.linkvalidation	Contains classes of the link validation app.
org.opencms.ui.apps.lists	This package contains the app classes for the list configurations manager.
org.opencms.ui.apps.lists.daterestrictions	Contains classes for dealing with date restrictions in list configurations.
org.opencms.ui.apps.modules	Contains classes of the module manager app.
org.opencms.ui.apps.modules.edit	Contains classes of the module manager app used to edit modules.
org.opencms.ui.apps.projects	The project manager app classes
org.opencms.ui.apps.publishqueue	Contains classes of the publish queue app.
org.opencms.ui.apps.search	Contains classes of the source search app.
org.opencms.ui.apps.searchindex	Contains classes of the searchindex app.
org.opencms.ui.apps.sessions	Contains classes of the site manager app.
org.opencms.ui.apps.shell
org.opencms.ui.apps.sitemanager	Contains classes of the site manager app.
org.opencms.ui.apps.user	Contains classes of the user manager app.
org.opencms.ui.components	Contains some reusable GUI components for Vaadin UI
org.opencms.ui.components.categoryselect
org.opencms.ui.components.fileselect	Contains components for selecting resources
org.opencms.ui.contextmenu	Contains code for workplace context menu
org.opencms.ui.dialogs	Contains code for workplace dialogs
org.opencms.ui.dialogs.embedded
org.opencms.ui.dialogs.history	Contains code for the file history dialog
org.opencms.ui.dialogs.history.diff	Contains code for the comparison view of the file history dialog
org.opencms.ui.dialogs.permissions	Contains permission dialog classes
org.opencms.ui.editors.messagebundle	The data bindings and logic for the translator editor.
org.opencms.ui.error
org.opencms.ui.favorites
org.opencms.ui.login	Contains the user interface components for the Vaadin-based login dialog
org.opencms.ui.sitemap	Vaadin GUI components and utilities for use in the sitemap editor.
org.opencms.ui.util	Utilities for Vaadin workplace code
org.opencms.util	Utility functions for String manipulation and other often used tasks.
org.opencms.widgets	Contains the widget implementations, these are GUI elements used in editors and dialogs of the OpenCms workplace.
org.opencms.widgets.dataview
org.opencms.workflow	Classes related to publishing and workflow.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
org.opencms.workplace.comparison	Utilities for comparing different versions of resources, used by both the classic workplace and the new Vaadin-based workplace.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.workplace.editors.directedit	Used to control the generation of the HTML for the "direct edit" buttons.
org.opencms.workplace.explorer	Contains the functions that generate the Workplace "Explorer" view, also contains the "New resource" wizard.
org.opencms.workplace.galleries	Contains the various "Galleries" which are available in the editors and widgets of the OpenCms Workplace.
org.opencms.workplace.threads	A collection of thread classes that are used in the OpenCms Workplace, usually in connection with a report.
org.opencms.workplace.tools	Contains the base classes for implementing a tool in the OpenCms Workplace "Administration" view.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.page	Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.
org.opencms.xml.templatemapper
org.opencms.xml.types	Contains the basic XML content type definitions, used for XML content and XML pages.

Uses of CmsObject in org.opencms.ade.configuration

Fields in org.opencms.ade.configuration declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsResourceTypeConfig.m_cms The CMS object used for VFS operations.

Methods in org.opencms.ade.configuration that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsADEConfigCacheState.getCms() Gets the CMS context used for VFS operations.
protected CmsObject	CmsADEConfigData.getCms() Gets the CMS object used for VFS operations.
protected CmsObject	CmsADEConfigData.getCmsObject() Gets the CMS object used for VFS operations.
protected CmsObject	CmsResourceTypeConfig.rootCms(CmsObject cms) Creates a new CMS object based on existing one and changes its site root to the site root.

Methods in org.opencms.ade.configuration with parameters of type CmsObject

Modifier and Type	Method and Description
boolean	CmsResourceTypeConfig.checkCreatable(CmsObject cms, java.lang.String pageFolderRootPath) Checks if this resource type is creatable.
void	CmsResourceTypeConfig.checkOffline(CmsObject cms) Checks whether the cms context is in the offline project and throws an exception otherwise.
boolean	CmsResourceTypeConfig.checkViewable(CmsObject cms, java.lang.String referenceUri) Checks if a resource type is viewable for the current user.
void	CmsResourceTypeConfig.configureCreateNewElement(CmsObject cms, java.lang.String pageFolderRootPath, CmsNewResourceBuilder builder) Similar to createNewElement, but just sets parameters on a resource builder instead of actually creating the resource.
CmsResource	CmsResourceTypeConfig.createNewElement(CmsObject userCms, CmsResource modelResource, java.lang.String pageFolderRootPath) Creates a new element.
CmsResource	CmsResourceTypeConfig.createNewElement(CmsObject userCms, java.lang.String pageFolderRootPath) Creates a new element.
static CmsADEConfigCacheState	CmsADEConfigCacheState.emptyState(CmsObject cms) Creates an empty ADE configuration cache state.
java.lang.String	CmsADEManager.findEntryPoint(CmsObject cms, java.lang.String openPath) Finds the entry point to a sitemap.
java.util.List<CmsDetailPageInfo>	CmsADEManager.getAllDetailPages(CmsObject cms) Gets the complete list of beans for the currently configured detail pages.
java.util.List<CmsResourceTypeConfig>	CmsADEConfigData.getCreatableTypes(CmsObject cms, java.lang.String pageFolderRootPath) Returns a list of the creatable resource types.
java.util.List<CmsADEConfigData.DetailInfo>	CmsADEManager.getDetailInfo(CmsObject cms) Gets the detail page information for everything.
java.util.List<CmsADEConfigData.DetailInfo>	CmsADEConfigData.getDetailInfos(CmsObject cms) Gets the detail information for this sitemap config data object.
java.util.List<CmsADEConfigData.DetailInfo>	CmsADEConfigCacheState.getDetailInfosForSubsites(CmsObject cms) Gets the detail page information for everything.
java.lang.String	CmsADEManager.getDetailPage(CmsObject cms, java.lang.String pageRootPath, java.lang.String originPath) Gets the detail page for a content element.
java.lang.String	CmsADEManager.getDetailPage(CmsObject cms, java.lang.String pageRootPath, java.lang.String originPath, java.lang.String targetDetailPage) Gets the detail page for a content element.
java.util.List<java.lang.String>	CmsADEManager.getDetailPages(CmsObject cms, java.lang.String type) Returns the main detail pages for a type in all of the VFS tree.
java.util.Set<java.lang.String>	CmsADEManager.getDetailPageTypes(CmsObject cms) Gets the set of types for which detail pages are defined.
java.util.List<I_CmsFormatterBean>	CmsADEConfigData.getDisplayFormatters(CmsObject cms) Returns all available display formatters.
java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsADEManager.getElementSettings(CmsObject cms, CmsResource resource) Returns the element settings for a given resource.
java.util.Map<CmsUUID,CmsElementView>	CmsADEManager.getElementViews(CmsObject cms) Returns the available element views.
java.util.List<CmsContainerElementBean>	CmsADEManager.getFavoriteList(CmsObject cms) Returns the favorite list, or creates it if not available.
java.lang.String	CmsContentFolderDescriptor.getFolderPath(CmsObject cms, java.lang.String pageFolderPath) Computes the folder root path.
java.lang.String	CmsResourceTypeConfig.getFolderPath(CmsObject cms, java.lang.String pageFolderRootPath) Computes the folder path for this resource type.
CmsFormatterConfiguration	CmsADEConfigData.getFormatters(CmsObject cms, CmsResource res) Gets the formatter configuration for a resource.
protected CmsFormatterConfiguration	CmsADEConfigData.getFormatters(CmsObject cms, I_CmsResourceType resType, CmsFormatterConfiguration schemaFormatters) Gets the formatter configuration for a resource type.
java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsADEManager.getFormatterSettings(CmsObject cms, I_CmsFormatterBean mainFormatter, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req) Returns the settings configured for the given formatter.
protected CmsFormatterConfiguration	CmsADEConfigData.getFormattersFromSchema(CmsObject cms, CmsResource res) Gets the formatters from the schema.
CmsInheritedContainerState	CmsADEManager.getInheritedContainerState(CmsObject cms, CmsResource resource, java.lang.String name) Returns the inheritance state for the given inheritance name and resource.
CmsInheritedContainerState	CmsADEManager.getInheritedContainerState(CmsObject cms, java.lang.String rootPath, java.lang.String name) Returns the inheritance state for the given inheritance name and root path.
java.util.List<I_CmsFormatterBean>	CmsADEManager.getNestedFormatters(CmsObject cms, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req) Returns the nested formatters of the given resource.
java.util.Map<java.lang.String,java.lang.String>	CmsADEManager.getParameters(CmsObject cms) Gets ADE parameters.
CmsPermissionInfo	CmsADEManager.getPermissionInfo(CmsObject cms, CmsResource resource, java.lang.String contextPath) Returns the permission info for the given resource.
java.util.List<CmsContainerElementBean>	CmsADEManager.getRecentList(CmsObject cms) Returns the favorite list, or creates it if not available.
java.util.Collection<CmsResourceTypeConfig>	CmsADEConfigData.getSearchableTypes(CmsObject cms) Gets the searchable resource type configurations.
static java.lang.String	CmsConfigurationReader.getString(CmsObject cms, I_CmsXmlContentValueLocation location) Gets the string value of an XML content location.
java.util.List<java.lang.String>	CmsADEManager.getSubSitePaths(CmsObject cms, java.lang.String subSiteRoot) Returns all sub sites below the given path.
java.lang.String	CmsADEManager.getSubSiteRoot(CmsObject cms, java.lang.String rootPath) Tries to get the subsite root for a given resource root path.
protected CmsProject	CmsADEManager.getTempfileProject(CmsObject cms) Gets a tempfile project, creating one if it doesn't exist already.
java.lang.String	CmsElementView.getTitle(CmsObject cms, java.util.Locale locale) Returns the element view title.
void	CmsADEManager.handleHtmlRedirect(CmsObject userCms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String htmlRedirect) Processes a HTML redirect content.
boolean	CmsADEConfigData.hasFormatters(CmsObject cms, I_CmsResourceType resType, java.util.Collection<CmsContainer> containers) Checks if there are any matching formatters for the given set of containers.
boolean	CmsElementView.hasPermission(CmsObject cms, CmsResource folder) Checks whether the current user has permissions to use the element view.
void	CmsResourceTypeConfig.initialize(CmsObject cms) Initializes this instance.
protected CmsADEConfigData	CmsADEManager.internalLookupConfiguration(CmsObject cms, java.lang.String rootPath) Internal configuration lookup method.
protected boolean	CmsADEConfigCacheState.isDetailPage(CmsObject cms, CmsResource resource) Checks whether the given resource is configured as a detail page.
boolean	CmsADEManager.isDetailPage(CmsObject cms, CmsResource resource) Checks whether the given resource is configured as a detail page.
boolean	CmsADEManager.isShowEditorHelp(CmsObject cms) Returns the show editor help flag.
CmsADEConfigData	CmsADEManager.lookupConfiguration(CmsObject cms, java.lang.String rootPath) Looks up the configuration data for a given sitemap path.
static CmsPropertyConfig	CmsConfigurationReader.parseProperty(CmsObject cms, I_CmsXmlContentLocation field) Helper method to parse a property.
protected CmsObject	CmsResourceTypeConfig.rootCms(CmsObject cms) Creates a new CMS object based on existing one and changes its site root to the site root.
boolean	CmsADEManager.saveDetailPages(CmsObject cms, java.lang.String rootPath, java.util.List<CmsDetailPageInfo> detailPages, CmsUUID newId) Saves a list of detail pages.
void	CmsADEManager.saveFavoriteList(CmsObject cms, java.util.List<CmsContainerElementBean> favoriteList) Saves the favorite list, user based.
void	CmsADEManager.saveInheritedContainer(CmsObject cms, CmsResource pageResource, java.lang.String name, boolean newOrder, java.util.List<CmsContainerElementBean> elements) Saves the inheritance container information.
void	CmsADEManager.saveInheritedContainer(CmsObject cms, java.lang.String sitePath, java.lang.String name, boolean newOrder, java.util.List<CmsContainerElementBean> elements) Saves the inheritance container information.
void	CmsADEManager.saveRecentList(CmsObject cms, java.util.List<CmsContainerElementBean> recentList) Saves the favorite list, user based.
void	CmsADEManager.setShowEditorHelp(CmsObject cms, boolean showHelp) Sets the show editor help flag.
protected void	CmsResourceTypeConfig.tryToUnlock(CmsObject cms, java.lang.String folderPath) Tries to remove a lock on an ancestor of a given path owned by the current user.

Constructors in org.opencms.ade.configuration with parameters of type CmsObject

Constructor and Description
CmsADEConfigCacheState(CmsObject cms, java.util.Map<CmsUUID,CmsADEConfigDataInternal> siteConfigurations, java.util.List<CmsADEConfigDataInternal> moduleConfigs, java.util.Map<CmsUUID,CmsElementView> elementViews) Creates a new configuration cache state.
CmsADEManager(CmsObject adminCms, CmsMemoryMonitor memoryMonitor, CmsSystemConfiguration systemConfiguration) Creates a new ADE manager.
CmsConfigurationReader(CmsObject cms) Creates a new configuration reader.
CmsDetailNameCache(CmsObject cms) Creates a new instance.
CmsElementView(CmsObject cms, CmsResource resource) Constructor.
CmsGlobalConfigurationCacheEventHandler(CmsObject onlineCms) Creates a new cache event handler.

Uses of CmsObject in org.opencms.ade.configuration.formatters

Constructors in org.opencms.ade.configuration.formatters with parameters of type CmsObject

Constructor and Description
CmsFormatterBeanParser(CmsObject cms, java.util.Map<CmsUUID,java.util.List<CmsXmlContentProperty>> settingConfigs) Creates a new parser instance.
CmsFormatterConfigurationCache(CmsObject cms, java.lang.String name) Creates a new formatter configuration cache instance.

Uses of CmsObject in org.opencms.ade.containerpage

Methods in org.opencms.ade.containerpage with parameters of type CmsObject

Modifier and Type	Method and Description
boolean	I_CmsResourceTypeEnabledCheck.checkEnabled(CmsObject cms, CmsADEConfigData config, I_CmsResourceType resType) Check whether the given type is enabled for a dialog.
static CmsResource	CmsModelGroupHelper.createModelGroup(CmsObject cms, CmsADEConfigData configData) Creates a new model group resource.
static java.util.List<CmsModelResourceInfo>	CmsContainerpageService.generateModelResourceList(CmsObject cms, java.lang.String resourceType, java.util.List<CmsResource> modelResources, java.util.Locale contentLocale) Generates the model resource data list.
static java.lang.String	CmsDetailOnlyContainerUtil.getDetailContainerLocale(CmsObject cms, java.lang.String contentLocale, CmsResource resource) Returns the detail container resource locale appropriate for the given detail page.
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyPage(CmsObject cms, CmsResource detailContent, java.lang.String contentLocale) Gets the detail only page for a detail content.
static CmsContainerPageBean	CmsDetailOnlyContainerUtil.getDetailOnlyPage(CmsObject cms, javax.servlet.ServletRequest req, java.lang.String pageRootPath) Returns the detail only container page bean or null if none available.
static java.lang.String	CmsDetailOnlyContainerUtil.getDetailOnlyPageName(CmsObject cms, CmsResource pageResource, java.lang.String detailPath, java.lang.String locale) Returns the site/root path to the detail only container page, for site/root path of the detail content.
static com.google.common.base.Optional<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResource(CmsObject cms, java.lang.String contentLocale, CmsResource detailContentRes, CmsResource pageRes) Gets the detail only resource for a given detail content and locale.
static java.util.List<CmsResource>	CmsDetailOnlyContainerUtil.getDetailOnlyResources(CmsObject cms, CmsResource resource) Returns a list of detail only container pages associated with the given resource.
static I_CmsFormatterBean	CmsElementUtil.getFormatterForContainer(CmsObject cms, CmsContainerElementBean element, CmsContainer container, CmsADEConfigData config, CmsADESessionCache cache) Returns the formatter bean for the given element and container.
java.util.List<CmsResourceTypeBean>	CmsAddDialogTypeHelper.getResourceTypes(CmsObject cms, java.lang.String folderRootPath, java.lang.String checkViewableReferenceUri, CmsElementView elementView, I_CmsResourceTypeEnabledCheck checkEnabled) Creates list of resource type beans for gallery or 'New' dialog.
static java.lang.String	CmsContainerpageService.getSerializedElementInfo(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsContainerElementBean elementBean, CmsContainerPageBean page) Returns the serialized element data.
static boolean	CmsDetailOnlyContainerUtil.isDetailContainersPage(CmsObject cms, java.lang.String detailContainersPage) Checks whether the given resource path is of a detail containers page.
static boolean	CmsContainerpageService.isEditingModelGroups(CmsObject cms, CmsResource containerPage) Checks whether the current page is a model group page.
void	CmsAddDialogTypeHelper.precomputeTypeLists(CmsObject cms, java.lang.String folderRootPath, java.lang.String checkViewableReferenceUri, java.util.List<CmsElementView> views, I_CmsResourceTypeEnabledCheck check) Precomputes type lists for multiple views.
static CmsResource	CmsDetailOnlyContainerUtil.readOrCreateDetailOnlyPage(CmsObject cms, CmsUUID detailId, java.lang.String detailOnlyRootPath) Creates an empty detail-only page for a content, or just reads the resource if the detail-only page already exists.
static CmsXmlContainerPage	CmsDetailOnlyContainerUtil.saveDetailOnlyPage(CmsObject cms, CmsResource content, java.lang.String locale, CmsContainerPageBean page) Saves a detail-only page for a content.
static boolean	CmsModelGroupHelper.updateModelGroupResource(CmsObject cms, CmsResource group, java.lang.String baseContainerName) Updates a model group resource to the changed data structure.

Constructors in org.opencms.ade.containerpage with parameters of type CmsObject

Constructor and Description
CmsDetailOnlyContainerPageBuilder(CmsObject cms, CmsADEConfigData config) Creates a new instance.
CmsElementUtil(CmsObject cms, java.lang.String currentPageUri, CmsContainerPageBean containerPage, CmsUUID detailContentId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean isDragMode, java.util.Locale locale) Creates a new instance.
CmsElementUtil(CmsObject cms, java.lang.String currentPageUri, CmsUUID detailContentId, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Locale locale) Creates a new instance.
CmsElementUtil(CmsObject cms, java.lang.String currentPageUri, CmsUUID detailContentId, java.lang.String requestParameters, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Locale locale) Creates a new instance.
CmsModelGroupHelper(CmsObject cms, CmsADEConfigData configData, CmsADESessionCache sessionCache, boolean isEditingModelGroups) Constructor.

Uses of CmsObject in org.opencms.ade.containerpage.inherited

Methods in org.opencms.ade.containerpage.inherited with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsResource	CmsInheritanceGroupUtils.getInheritanceGroupContentByName(CmsObject cms, java.lang.String name) Finds the inheritance group content with a given internal name.
static java.util.Set<java.lang.String>	CmsInheritanceGroupUtils.getNamesOfGroupsContainingResource(CmsObject cms, CmsResource inheritanceConfig, CmsResource target) Parses an inheritance group configuration C and returns the names of inheritance groups in C in which a given resource is defined as a new element.
protected java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsContainerConfigurationWriter.getSettingConfiguration(CmsObject cms, CmsResource resource) Gets the setting configuration of an element.
protected void	CmsContainerConfigurationWriter.removeExistingEntry(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.lang.String name) Removes an existing inheritance container entry with a given name from the configuration file.
void	CmsContainerConfigurationWriter.save(CmsObject cms, java.lang.String name, boolean newOrdering, CmsResource pageResource, java.util.List<CmsContainerElementBean> elements) Saves a list of container element beans to a file in the VFS.
protected CmsXmlContent	CmsContainerConfigurationWriter.saveInContentObject(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.lang.String name, CmsContainerConfiguration configuration) Saves a single container configuration in an XML content object, but doesn't write it to the VFS.
org.dom4j.Element	CmsContainerConfigurationWriter.serializeSingleConfiguration(CmsObject cms, java.lang.String name, CmsContainerConfiguration config, org.dom4j.Element parentElement) Serializes a single container configuration into an XML element.

Constructors in org.opencms.ade.containerpage.inherited with parameters of type CmsObject

Constructor and Description
CmsContainerConfigurationCache(CmsObject cms, java.lang.String name) Creates a new cache instance for inherited containers.
CmsContainerConfigurationParser(CmsObject cms) Creates a new configuration parser.
CmsInheritanceReferenceParser(CmsObject cms) Creates a new parser instance.

Uses of CmsObject in org.opencms.ade.contenteditor

Methods in org.opencms.ade.contenteditor that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsContentTypeVisitor.getCmsObject() Gets the CMS context.
CmsObject	CmsContentService.getCmsObject()

Methods in org.opencms.ade.contenteditor with parameters of type CmsObject

Modifier and Type	Method and Description
static java.lang.String	CmsContentService.defaultCreateResourceToEdit(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String mode, java.lang.String postCreateHandler) Creates a new resource to edit, delegating to an edit handler if edit handler data is passed in.
protected java.lang.String	CmsContentService.getFileEncoding(CmsObject cms, CmsResource file) Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.
CmsXmlContent	CmsDelayedDefaultChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerProperty.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths)
CmsXmlContent	CmsEditorChangeHandlerFormatterSelection.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Adjusts the added/removed formatters if "Remove all formatters" is checked/unchecked.

Constructors in org.opencms.ade.contenteditor with parameters of type CmsObject

Constructor and Description
CmsContentTypeVisitor(CmsObject cms, CmsFile file, java.util.Locale locale) Constructor.

Uses of CmsObject in org.opencms.ade.detailpage

Methods in org.opencms.ade.detailpage with parameters of type CmsObject

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	CmsSitemapDetailPageFinder.getAllDetailPages(CmsObject cms, int resType)
java.util.Collection<java.lang.String>	I_CmsDetailPageFinder.getAllDetailPages(CmsObject cms, int restype) Finds all detail pages for a given resource.
static java.util.List<java.lang.String>	CmsDetailPageUtil.getAllDetailPagesWithUrlName(CmsObject cms, CmsResource res) Gets a list of detail page URIs for the given resource, with its URL name appended.
static java.lang.String	CmsDetailPageUtil.getBestUrlName(CmsObject cms, CmsUUID id) Returns either the newest URL name for a structure id, or the structure id as a string if there is no URL name.
java.lang.String	CmsSitemapDetailPageFinder.getDetailPage(CmsObject cms, java.lang.String rootPath, java.lang.String linkSource, java.lang.String targetDetailPage)
java.lang.String	I_CmsDetailPageFinder.getDetailPage(CmsObject cms, java.lang.String rootPath, java.lang.String linkSource, java.lang.String targetDetailPage) Returns the detail page link for the given resource, or null if there is no detail page for the resource.
CmsResource	CmsDetailPageResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected boolean	CmsDetailPageResourceHandler.isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes) Checks whether the given detail page is valid for the given resource.
static CmsResource	CmsDetailPageUtil.lookupPage(CmsObject cms, java.lang.String uri) Looks up a page by URI (which may be a detail page URI, or a normal VFS uri).

Constructors in org.opencms.ade.detailpage with parameters of type CmsObject

Constructor and Description
CmsDetailPageConfigurationWriter(CmsObject cms, CmsResource res) Creates a new detail page configuration writer.

Uses of CmsObject in org.opencms.ade.galleries

Methods in org.opencms.ade.galleries that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsGalleryService.getSearchCms(CmsGallerySearchBean searchObj) Gets an initialized CmsObject to be used for the actual search for a given search bean.

Methods in org.opencms.ade.galleries with parameters of type CmsObject

Modifier and Type	Method and Description
protected abstract T	A_CmsTreeTabDataPreloader.createEntry(CmsObject cms, CmsResource resource) Creates a tree entry bean from a resource.
static CmsVfsEntryBean	CmsGalleryService.generateVfsPreloadData(CmsObject cms, CmsTreeOpenState vfsState, java.util.Set<java.lang.String> folders) Generates the pre-loaded contents for the VFS tab of the gallery dialog.
static java.lang.String	CmsPreviewService.getPreviewContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsObject cms, CmsResource resource, java.util.Locale locale) Renders the preview content for the given resource and locale.
static CmsVfsEntryBean	CmsGalleryService.internalCreateVfsEntryBean(CmsObject cms, CmsResource resource, java.lang.String title, boolean isRoot, boolean isEditable, java.util.List<CmsVfsEntryBean> children, boolean isMatch) Creates the VFS entry bean for a resource.
protected boolean	CmsGalleryService.isSitemapEntry(CmsObject cms, CmsResource resource) Checks whether a given resource is a sitemap entry.
T	A_CmsTreeTabDataPreloader.preloadData(CmsObject cms, java.util.Set<CmsResource> openResources, java.util.Set<CmsResource> selectedResources) Creates the preload data for a collection of resources which correspond to "opened" tree items.
static CmsPoint	CmsPreviewService.readFocalPoint(CmsObject cms, CmsResource resource) Reads the focal point from a resource.
void	CmsPreviewService.readResourceInfo(CmsObject cms, CmsResource resource, CmsResourceInfoBean resInfo, java.lang.String locale) Retrieves the resource information and puts it into the provided resource info bean.

Constructors in org.opencms.ade.galleries with parameters of type CmsObject

Constructor and Description
CmsGalleryFilteredNavTreeBuilder(CmsObject cms, java.lang.String rootPath) Creates a new navigation tree.
CmsSiteSelectorOptionBuilder(CmsObject cms) Creates a new builder instance.

Uses of CmsObject in org.opencms.ade.publish

Fields in org.opencms.ade.publish declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsPublish.m_cms The current cms context.

Methods in org.opencms.ade.publish that return CmsObject

Modifier and Type	Method and Description
static CmsObject	CmsPublishListHelper.adjustCmsObject(CmsObject cms, boolean online) Initializes a CmsObject based on the given one, but with adjusted project information and configured, such that release and expiration date are ignored.
CmsObject	CmsCollectorPublishListHelper.getCmsObject(boolean online) Initializes a CmsObject.

Methods in org.opencms.ade.publish with parameters of type CmsObject

Modifier and Type	Method and Description
protected void	CmsDirectPublishProject.addSubResources(CmsObject cms, java.util.Set<CmsResource> resources) Adds contents of folders to a list of resources.
static CmsObject	CmsPublishListHelper.adjustCmsObject(CmsObject cms, boolean online) Initializes a CmsObject based on the given one, but with adjusted project information and configured, such that release and expiration date are ignored.
java.util.Set<CmsResource>	CmsDummyRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res)
java.util.Set<CmsResource>	I_CmsPublishRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms, CmsResource res) Gets the set of additional related resources.
protected static java.lang.String	CmsPublish.getOuAwareName(CmsObject cms, java.lang.String name) Returns the simple name if the ou is the same as the current user's ou.
CmsProjectBean	CmsDirectPublishProject.getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
CmsProjectBean	CmsMyChangesProject.getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
CmsProjectBean	I_CmsVirtualProject.getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Gets the project bean.
CmsProjectBean	CmsCurrentPageProject.getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
CmsProjectBean	CmsRealProjectVirtualWrapper.getProjectBean(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
CmsPublishData	CmsPublishService.getPublishData(CmsObject cms, java.util.HashMap<java.lang.String,java.lang.String> params, java.lang.String workflowId, java.lang.String projectParam, java.util.List<java.lang.String> pathList, java.lang.String closeLink, boolean confirm) Gets the publish data for the given parameters.
java.util.Set<CmsResource>	CmsDefaultCollectorPublishListProvider.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
I_CmsPublishRelatedResourceProvider	CmsDirectPublishProject.getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options)
I_CmsPublishRelatedResourceProvider	CmsMyChangesProject.getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options)
I_CmsPublishRelatedResourceProvider	I_CmsVirtualProject.getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options) Returns an object that can be queried for 'related' resources specific to this virtual project.
I_CmsPublishRelatedResourceProvider	CmsCurrentPageProject.getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options)
I_CmsPublishRelatedResourceProvider	CmsRealProjectVirtualWrapper.getRelatedResourceProvider(CmsObject cmsObject, CmsPublishOptions options)
java.util.List<CmsResource>	CmsDirectPublishProject.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId)
java.util.List<CmsResource>	CmsMyChangesProject.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId)
java.util.List<CmsResource>	I_CmsVirtualProject.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId) Gets the resources of the virtual project.
java.util.List<CmsResource>	CmsCurrentPageProject.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId)
java.util.List<CmsResource>	CmsRealProjectVirtualWrapper.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId)
static java.lang.String	CmsPublishService.wrapProjectName(CmsObject cms, java.lang.String name) Wraps the project name in a message string.

Constructors in org.opencms.ade.publish with parameters of type CmsObject

Constructor and Description
CmsCollectorPublishListHelper(CmsObject cms, I_CmsContentLoadCollectorInfo collectorInfo, int collectorLimit) Creates a new instance.
CmsPublish(CmsObject cms) Creates a new instance.
CmsPublish(CmsObject cms, CmsPublishOptions options) Constructor with options.
CmsPublish(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Constructor with default options.
CmsPublishRelationFinder(CmsObject cms, java.util.Collection<CmsResource> resources, boolean keepOriginalUnchangedResources, I_CmsPublishRelatedResourceProvider relProvider) Creates a new instance.

Uses of CmsObject in org.opencms.ade.sitemap

Methods in org.opencms.ade.sitemap with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsVfsSitemapService.checkPermissions(CmsObject cms)
void	CmsAliasEditorLockTable.clear(CmsObject cms, java.lang.String siteRoot) Clears the entry for a given site root, but only if the user from the given CMS context matches the user in the entry.
CmsUser	CmsAliasEditorLockTable.update(CmsObject cms, java.lang.String siteRoot) Tries to update or create an entry for the given user/site root combination.

Constructors in org.opencms.ade.sitemap with parameters of type CmsObject

Constructor and Description
CmsAliasBulkEditHelper(CmsObject cms) Creates a new helper object.
CmsModelPageHelper(CmsObject cms, CmsResource rootResource) Creates a new instance.
CmsSitemapSessionCache(CmsObject cms) Initializes the session cache.

Uses of CmsObject in org.opencms.ade.upload

Methods in org.opencms.ade.upload with parameters of type CmsObject

Modifier and Type	Method and Description
static java.lang.String	CmsUploadBean.getNewResourceName(CmsObject cms, java.lang.String fileName, java.lang.String folder) Returns the VFS path for the given filename and folder.

Uses of CmsObject in org.opencms.cache

Methods in org.opencms.cache with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.Object	CmsVfsMemoryObjectCache.getCachedObject(CmsObject cms, java.lang.String rootPath) Return an object from the cache.
java.lang.Object	CmsVfsMemoryObjectCache.loadVfsObject(CmsObject cms, java.lang.String rootPath, org.apache.commons.collections.Transformer function) Uses a transformer for loading an object from a path if it has not already been cached, and then caches it.
void	CmsVfsMemoryObjectCache.putCachedObject(CmsObject cms, java.lang.String rootPath, java.lang.Object value) Puts an object into the cache.

Uses of CmsObject in org.opencms.cmis

Methods in org.opencms.cmis that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsCmisRepository.getCmsObject(CmsCmisCallContext context) Initializes a CMS context for the authentication data contained in a call context.

Methods in org.opencms.cmis with parameters of type CmsObject

Modifier and Type	Method and Description
static void	CmsCmisUtil.addDynamicProperties(CmsObject cms, CmsCmisTypeManager typeManager, org.apache.chemistry.opencmis.commons.impl.dataobjects.PropertiesImpl props, java.lang.String typeId, CmsResource resource, java.util.Set<java.lang.String> filter) Helper method to add the dynamic properties for a resource.
protected org.apache.chemistry.opencmis.commons.data.Acl	CmsCmisResourceHelper.collectAcl(CmsObject cms, CmsResource resource, boolean onlyBasic) Compiles the ACL for a file or folder.
protected org.apache.chemistry.opencmis.commons.data.Acl	CmsCmisRelationHelper.collectAcl(CmsObject cms, CmsResource resource, boolean onlyBasic) Compiles the ACL for a relation.
protected org.apache.chemistry.opencmis.commons.data.AllowableActions	CmsCmisResourceHelper.collectAllowableActions(CmsObject cms, CmsResource file) Compiles the allowable actions for a file or folder.
protected org.apache.chemistry.opencmis.commons.data.AllowableActions	CmsCmisRelationHelper.collectAllowableActions(CmsObject cms, CmsResource file, CmsRelation relation) Collects the allowable actions for a relation.
protected org.apache.chemistry.opencmis.commons.data.ObjectData	CmsCmisRelationHelper.collectObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, CmsRelation relation, java.util.Set<java.lang.String> filter, boolean includeAllowableActions, boolean includeAcl) Fills in an ObjectData record.
protected org.apache.chemistry.opencmis.commons.data.ObjectData	CmsCmisResourceHelper.collectObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, java.util.Set<java.lang.String> filter, java.lang.String renditionFilter, boolean includeAllowableActions, boolean includeAcl, org.apache.chemistry.opencmis.commons.enums.IncludeRelationships includeRelationships) Fills in an ObjectData record.
protected org.apache.chemistry.opencmis.commons.data.Properties	CmsCmisRelationHelper.collectProperties(CmsObject cms, CmsResource resource, CmsRelation relation, java.util.Set<java.lang.String> orgfilter, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo) Gathers all base properties of a file or folder.
protected org.apache.chemistry.opencmis.commons.data.Properties	CmsCmisResourceHelper.collectProperties(CmsObject cms, CmsResource resource, java.util.Set<java.lang.String> orgfilter, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo) Gathers all base properties of a file or folder.
protected java.util.List<org.apache.chemistry.opencmis.commons.data.RenditionData>	CmsCmisResourceHelper.collectRenditions(CmsObject cms, CmsResource resource, java.lang.String renditionFilterString, org.apache.chemistry.opencmis.commons.impl.server.ObjectInfoImpl objectInfo) Collects renditions for a resource.
static boolean	CmsCmisUtil.ensureLock(CmsObject cms, CmsResource resource) Tries to lock a resource and throws an exception if it can't be locked.
void	CmsCmisRelationHelper.RelationKey.fillRelation(CmsObject cms) Reads the actual resource and relation data from the OpenCms VFS.
protected java.lang.String	A_CmsCmisRepository.getAcePrincipalName(CmsObject cms, CmsUUID principalId) Gets a user-readable name for a principal id read from an ACE.
static java.lang.String	CmsCmisUtil.getAcePrincipalName(CmsObject cms, CmsUUID principalId) Gets a user-readable name for a principal id read from an ACE.
byte[]	I_CmsCmisRenditionProvider.getContent(CmsObject cms, CmsResource resource) Gets the rendition content stream for the resource.
java.lang.String	I_CmsPropertyProvider.getPropertyValue(CmsObject cms, CmsResource resource) Reads the property value.
protected java.util.List<org.apache.chemistry.opencmis.commons.data.ObjectData>	CmsCmisRepository.getRelationshipObjectData(CmsCmisCallContext context, CmsObject cms, CmsResource resource, org.apache.chemistry.opencmis.commons.enums.RelationshipDirection relationshipDirection, java.util.Set<java.lang.String> filterSet, boolean includeAllowableActions) Gets the relationship data for a given resource.
org.apache.chemistry.opencmis.commons.data.RenditionData	I_CmsCmisRenditionProvider.getRendition(CmsObject cms, CmsResource resource) Gets the rendition data for a resource.
static boolean	CmsCmisUtil.hasChildren(CmsObject cms, CmsResource resource) Checks whether the given resource has any children.
void	CmsCmisRepository.initializeCms(CmsObject cms)
void	I_CmsPropertyProvider.setPropertyValue(CmsObject cms, CmsResource resource, java.lang.String valueToSet) Writes the property value.

Constructors in org.opencms.cmis with parameters of type CmsObject

Constructor and Description
CmsCmisTypeManager(CmsObject adminCms, java.util.List<I_CmsPropertyProvider> propertyProviders) Creates a new type manager instance.

Uses of CmsObject in org.opencms.configuration

Methods in org.opencms.configuration with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsConfigurationManager.setAdminCms(CmsObject cms) Sets the admin CmsObject.
void	I_CmsXmlConfigurationWithUpdateHandler.setCmsObject(CmsObject cms) Called during startup with a CmsObject with admin privileges.
void	CmsSitesConfiguration.setCmsObject(CmsObject cms)

Uses of CmsObject in org.opencms.configuration.preferences

Methods in org.opencms.configuration.preferences with parameters of type CmsObject

Modifier and Type	Method and Description
CmsXmlContentProperty	CmsWorkplaceModePreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	A_CmsPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsProjectPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsStartGallleryPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsLanguagePreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsSitePreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsStartFolderPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsElementViewPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsWrapperPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	CmsStartViewPreference.getPropertyDefinition(CmsObject cms)
CmsXmlContentProperty	I_CmsPreference.getPropertyDefinition(CmsObject cms) Gets the metadata describing how the setting should be edited.
CmsXmlContentProperty	CmsUserDefinedPreference.getPropertyDefinition(CmsObject cms)
static java.lang.String	CmsSitePreference.getSiteSelectOptionsStatic(CmsObject cms, java.util.Locale locale) Gets the options for the site selector.
static CmsBuiltinPreference.SelectOptions	CmsStartViewPreference.getViewSelectOptions(CmsObject cms, java.lang.String value) Gets the select options for the view selector.
boolean	CmsWorkplaceModePreference.isDisabled(CmsObject cms)
boolean	A_CmsPreference.isDisabled(CmsObject cms)
boolean	CmsEditorPreference.isDisabled(CmsObject cms)
boolean	CmsWrapperPreference.isDisabled(CmsObject cms)
boolean	CmsStartViewPreference.isDisabled(CmsObject cms)
boolean	I_CmsPreference.isDisabled(CmsObject cms) Returns true if the preference is disabled.

Uses of CmsObject in org.opencms.db

Methods in org.opencms.db with parameters of type CmsObject

Modifier and Type	Method and Description
boolean	CmsLoginManager.canLockBecauseOfInactivity(CmsObject cms, CmsUser user) Checks whether a user account can be locked because of inactivity.
protected CmsResource	CmsPublishList.checkContainsSubResources(CmsObject cms, java.util.List<CmsResource> folders) Checks whether the publish list contains all sub-resources of a list of folders.
protected void	CmsAliasManager.checkPermissionsForMassEdit(CmsObject cms) Checks whether the current user has the permissions to mass edit the alias table, and throws an exception otherwise.
protected boolean	CmsPublishList.containsSubResources(CmsObject cms, CmsResource folder) Checks if the publish list contains all sub-resources of a given folder.
protected void	CmsDriverManager.ensureSubResourcesOfMovedFoldersPublished(CmsObject cms, CmsDbContext dbc, CmsPublishList pubList) Tries to add sub-resources of moved folders to the publish list and throws an exception if the publish list still does not contain some sub-resources of the moved folders.
static java.lang.String	CmsUserSettings.getAdditionalPreference(CmsObject cms, java.lang.String key, boolean useDefault) Gets a configured preference.
java.util.List<CmsAlias>	CmsAliasManager.getAliasesForPath(CmsObject cms, java.lang.String siteRoot, java.lang.String aliasPath) Gets the list of aliases for a path in a given site.
java.util.List<CmsAlias>	CmsAliasManager.getAliasesForSite(CmsObject cms, java.lang.String siteRoot) Gets the list of aliases for a given site root.
java.util.List<CmsAlias>	CmsAliasManager.getAliasesForStructureId(CmsObject cms, CmsUUID structureId) Gets the aliases for a given structure id.
long	CmsSubscriptionManager.getDateLastVisitedBy(CmsObject cms, CmsUser user, CmsResource resource) Returns the date when the resource was last visited by the user.
long	CmsSubscriptionManager.getDateLastVisitedBy(CmsObject cms, CmsUser user, java.lang.String resourcePath) Returns the date when the resource was last visited by the user.
protected java.util.List<CmsResource>	CmsPublishList.getMissingSubResources(CmsObject cms, java.util.List<CmsResource> folders) Gets the sub-resources of a list of folders which are missing from the publish list.
protected java.util.List<CmsResource>	CmsPublishList.getMovedFolders(CmsObject cms) Internal method to get the moved folders from the publish list.
java.util.List<CmsRewriteAlias>	CmsAliasManager.getRewriteAliases(CmsObject cms, java.lang.String siteRoot) Reads the rewrite aliases for a given site root.
CmsRewriteAliasMatcher	CmsAliasManager.getRewriteAliasMatcher(CmsObject cms, java.lang.String siteRoot) Gets the rewrite alias matcher for the given site.
java.lang.String	CmsUserSettings.getStartGallery(java.lang.String galleryType, CmsObject cms) Returns the root site path to the start gallery of the user or the constant CmsPreferences.INPUT_DEFAULT.
java.util.List<CmsResource>	CmsPublishList.getTopMovedFolders(CmsObject cms) Gets the list of moved folders which are not subfolders of other moved folders in the publish list.
boolean	CmsAliasManager.hasPermissionsForMassEdit(CmsObject cms, java.lang.String siteRoot) Checks whether the current user has permissions for mass editing the alias table.
protected CmsAliasImportResult	CmsAliasManager.importAlias(CmsObject cms, java.lang.String siteRoot, java.lang.String aliasPath, java.lang.String vfsPath, CmsAliasMode mode) Imports a single alias.
java.util.List<CmsAliasImportResult>	CmsAliasManager.importAliases(CmsObject cms, byte[] aliasData, java.lang.String siteRoot, java.lang.String separator) Imports alias CSV data.
void	CmsImportFolder.importFolder(java.lang.String importFolderName, java.lang.String importPath, CmsObject cms) Import that will read from the real file system.
void	CmsImportFolder.importZip(byte[] content, java.lang.String importPath, CmsObject cms, boolean noSubFolder) Import that will read from a ZIP file.
void	CmsSubscriptionManager.initialize(CmsObject cms) Initializes this subscription manager with the OpenCms system configuration.
CmsResource	CmsUserTrackingResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
boolean	CmsLoginManager.isPasswordReset(CmsObject cms, CmsUser user) Checks if password has to be reset.
void	CmsSubscriptionManager.markResourceAsVisitedBy(CmsObject cms, CmsResource resource, CmsUser user) Mark the given resource as visited by the user.
void	CmsSubscriptionManager.markResourceAsVisitedBy(CmsObject cms, java.lang.String resourcePath, CmsUser user) Mark the given resource as visited by the user.
protected CmsAliasImportResult	CmsAliasManager.processAliasImport(CmsObject cms, java.lang.String siteRoot, java.lang.String aliasPath, java.lang.String vfsPath, CmsAliasMode mode) Processes a single alias import operation which has already been parsed into fields.
protected CmsAliasImportResult	CmsAliasManager.processAliasLine(CmsObject cms, java.lang.String siteRoot, java.lang.String line, java.lang.String separator) Processes a line from a CSV file containing the alias data to be imported.
void	CmsDriverManager.publishJob(CmsObject cms, CmsDbContext dbc, CmsPublishList publishList, I_CmsReport report) Publishes the given publish job.
void	CmsDriverManager.publishProject(CmsObject cms, CmsDbContext dbc, CmsPublishList publishList, I_CmsReport report) Publishes the resources of a specified publish list.
CmsUUID	CmsSecurityManager.publishProject(CmsObject cms, CmsPublishList publishList, I_CmsReport report) Publishes the resources of a specified publish list.
java.util.List<CmsResource>	CmsSubscriptionManager.readAllSubscribedResources(CmsObject cms, CmsPrincipal principal) Returns all resources subscribed by the given user or group.
java.util.List<CmsResource>	CmsSubscriptionManager.readResourcesVisitedBy(CmsObject cms, CmsVisitedByFilter filter) Returns the resources that were visited by a user set in the filter.
java.util.List<I_CmsHistoryResource>	CmsSubscriptionManager.readSubscribedDeletedResources(CmsObject cms, CmsUser user, boolean includeGroups, java.lang.String folderPath, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
java.util.List<CmsResource>	CmsSubscriptionManager.readSubscribedResources(CmsObject cms, CmsSubscriptionFilter filter) Returns the resources that were subscribed by a user or group set in the filter.
void	CmsLoginManager.removeLoginMessage(CmsObject cms) Removes the current login message.
boolean	CmsLoginManager.requiresPasswordChange(CmsObject cms, CmsUser user) Checks if a user is required to change his password now.
boolean	CmsLoginManager.requiresUserDataCheck(CmsObject cms, CmsUser user) Checks if a user is required to change his password now.
void	CmsPublishList.revive(CmsObject cms) Revives the publish list by populating the internal resource lists with CmsResource instances.
void	CmsUserSettings.save(CmsObject cms) Saves the changed settings of the user to the users CmsUser.getAdditionalInfo() map.
void	CmsAliasManager.saveAliases(CmsObject cms, CmsUUID structureId, java.util.List<CmsAlias> aliases) Saves the aliases for a given structure id, completely replacing any existing aliases for the same structure id.
void	CmsAliasManager.saveRewriteAliases(CmsObject cms, java.lang.String siteRoot, java.util.List<CmsRewriteAlias> newAliases) Saves the rewrite alias for a given site root.
static void	CmsUserSettings.setAdditionalPreference(CmsObject cms, java.lang.String key, java.lang.String value) Sets a configured preference.
void	CmsLoginManager.setBeforeLoginMessage(CmsObject cms, CmsLoginMessage message) Sets the before login message to display on the login form.
void	CmsLoginManager.setLoginMessage(CmsObject cms, CmsLoginMessage message) Sets the login message to display if a user logs in.
void	CmsSubscriptionManager.setSubscribedResourceAsDeleted(CmsObject cms, CmsResource resource) Marks a subscribed resource as deleted.
void	CmsSubscriptionFilter.setUserGroups(CmsObject cms) Sets the groups of the user currently set in this filter as the list of groups to check subscribed resources for.
void	CmsSubscriptionManager.subscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource) Subscribes the user or group to the resource.
void	CmsSubscriptionManager.subscribeResourceFor(CmsObject cms, CmsPrincipal principal, java.lang.String resourcePath) Subscribes the user or group to the resource.
void	CmsLoginManager.unlockUser(CmsObject cms, CmsUser user) Unlocks a user who has exceeded his number of failed login attempts so that he can try to log in again.
void	CmsSubscriptionManager.unsubscribeAllDeletedResources(CmsObject cms, long deletedTo) Unsubscribes all deleted resources that were deleted before the specified time stamp.
void	CmsSubscriptionManager.unsubscribeAllResourcesFor(CmsObject cms, CmsPrincipal principal) Unsubscribes the user or group from all resources.
void	CmsSubscriptionManager.unsubscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource) Unsubscribes the principal from the resource.
void	CmsSubscriptionManager.unsubscribeResourceFor(CmsObject cms, CmsPrincipal principal, java.lang.String resourcePath) Unsubscribes the principal from the resource.
void	CmsSubscriptionManager.unsubscribeResourceForAll(CmsObject cms, CmsResource resource) Unsubscribes all groups and users from the resource.
void	CmsSubscriptionManager.unsubscribeResourceForAll(CmsObject cms, java.lang.String resourcePath) Unsubscribes all groups and users from the resource.
void	CmsAliasManager.updateAliases(CmsObject cms, java.util.Collection<CmsAlias> toDelete, java.util.Collection<CmsAlias> toAdd) Updates the aliases in the database.

Constructors in org.opencms.db with parameters of type CmsObject

Constructor and Description
CmsImportFolder(byte[] content, java.lang.String importPath, CmsObject cms, boolean noSubFolder) Constructor for a new CmsImportFolder that will read from a ZIP file.
CmsImportFolder(java.lang.String importFolderName, java.lang.String importPath, CmsObject cms) Constructor for a new CmsImportFolder that will read from the real file system.
CmsSubscriptionFilter(CmsObject cms) Constructor, setting the user to the current user from the context.
CmsSubscriptionFilter(CmsObject cms, boolean addUserGroups) Constructor, setting the user to the current user from the context.
CmsUserSettings(CmsObject cms) Creates a user settings object with initialized settings of the current user.
CmsVisitedByFilter(CmsObject cms) Constructor, setting the user to the current user from the context.

Uses of CmsObject in org.opencms.file

Methods in org.opencms.file with parameters of type CmsObject

Modifier and Type	Method and Description
protected java.lang.String	CmsLinkRewriter.getConfiguredEncoding(CmsObject cms, CmsResource resource) Gets the encoding which is configured at the location of a given resource.
java.lang.String	CmsUser.getDisplayName(CmsObject cms, java.util.Locale locale)
static CmsResourceFilter	CmsResourceFilter.ignoreExpirationOffline(CmsObject cms) Returns the DEFAULT filter in the Online project, and IGNORE_EXPIRATION otherwise.

Constructors in org.opencms.file with parameters of type CmsObject

Constructor and Description
CmsLinkRewriter(CmsObject cms, java.util.List<java.lang.String> sources, java.lang.String target) Creates a link rewriter for use after a multi-copy operation.
CmsLinkRewriter(CmsObject cms, java.lang.String targetPath, java.util.List<CmsPair<java.lang.String,java.lang.String>> sourceTargetPairs) Creates a new link rewriter for a list of sources and corresponding targets.
CmsLinkRewriter(CmsObject cms, java.lang.String source, java.lang.String target) Creates a link rewriter for use after a single copy operation.

Uses of CmsObject in org.opencms.file.collectors

Methods in org.opencms.file.collectors with parameters of type CmsObject

Modifier and Type	Method and Description
protected java.util.List<CmsResource>	CmsChangedResourceCollector.allChangedInFolderDate(CmsObject cms, java.lang.String param, boolean tree, boolean asc, int numResults) Returns a List of all changed resources in the folder pointed to by the parameter sorted by the date attributes specified in the parameter.
protected java.util.List<CmsResource>	CmsDateResourceCollector.allInFolderDate(CmsObject cms, java.lang.String param, boolean tree, boolean asc, int numResults) Returns a List of all resources in the folder pointed to by the parameter sorted by the selected dates.
protected java.util.List<CmsResource>	CmsDefaultResourceCollector.allInFolderDateReleasedDesc(CmsObject cms, java.lang.String param, boolean tree, int numResults) Returns a List of all resources in the folder pointed to by the parameter sorted by the release date, descending.
protected java.util.List<CmsResource>	CmsDefaultResourceCollector.allInFolderNavPos(CmsObject cms, java.lang.String param, boolean readSubTree, int numResults) Collects all resources in a folder (or subtree) sorted by the NavPos property.
protected java.util.List<CmsResource>	CmsPriorityResourceCollector.allInFolderPriorityDate(CmsObject cms, java.lang.String param, boolean tree, boolean asc, int numResults) Returns a list of all resource in a specified folder sorted by priority, then date ascending or descending.
protected java.util.List<CmsResource>	CmsPriorityResourceCollector.allInFolderPriorityTitle(CmsObject cms, java.lang.String param, boolean tree, int numResults) Returns a list of all resource in a specified folder sorted by priority descending, then Title ascending.
protected java.util.List<CmsResource>	CmsCategoryResourceCollector.allKeyValuePairFiltered(CmsObject cms, java.lang.String param, int numResults) Collects all resources for the given categories filtered and sorted by the given collector parameter.
protected java.util.List<CmsResource>	CmsPriorityResourceCollector.allMappedToUriPriorityDate(CmsObject cms, java.lang.String param, boolean asc, int numResults) Returns a list of all resource from specified folder that have been mapped to the currently requested uri, sorted by priority, then date ascending or descending.
static long	CmsDateResourceComparator.calculateDate(CmsObject cms, CmsResource resource, java.util.List<java.lang.String> dateIdentifiers, long defaultValue) Calculates the date to use for comparison of this resource based on the given date identifiers.
static java.lang.String	A_CmsResourceCollector.createResourceForCollector(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceResource, java.lang.String modelFile, java.lang.String mode, java.lang.String postCreateHandler) Creates a new content collector resource.
protected java.util.List<CmsResource>	CmsDefaultResourceCollector.getAllInFolder(CmsObject cms, java.lang.String param, boolean tree, int numResults) Returns all resources in the folder pointed to by the parameter.
protected java.lang.String	A_CmsResourceCollector.getCreateInFolder(CmsObject cms, CmsCollectorData data) Returns the link to create a new XML content item in the folder pointed to by the parameter.
protected java.lang.String	A_CmsResourceCollector.getCreateInFolder(CmsObject cms, java.lang.String param) Returns the link to create a new XML content item in the folder pointed to by the parameter.
java.lang.String	A_CmsResourceCollector.getCreateLink(CmsObject cms)
java.lang.String	I_CmsResourceCollector.getCreateLink(CmsObject cms) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector.
java.lang.String	CmsSolrCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsDefaultResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsTimeFrameCategoryCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsChangedResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsDateResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsSubscriptionCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsPriorityResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsCategoryResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	I_CmsResourceCollector.getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector.
java.lang.String	A_CmsResourceCollector.getCreateParam(CmsObject cms)
java.lang.String	I_CmsResourceCollector.getCreateParam(CmsObject cms) Returns the default parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.
java.lang.String	CmsSolrCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsDefaultResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsTimeFrameCategoryCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsChangedResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsDateResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsSubscriptionCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsPriorityResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	CmsCategoryResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.lang.String	I_CmsResourceCollector.getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the parameter that must be passed to the I_CmsResourceCollector.getCreateLink(CmsObject, String, String) method.
int	CmsSolrCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	CmsDefaultResourceCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	CmsTimeFrameCategoryCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	A_CmsResourceCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	CmsDateResourceCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	CmsPriorityResourceCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param)
int	I_CmsResourceCollector.getCreateTypeId(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns the id of the resource type for new collector items.
java.util.Set<CmsResource>	I_CmsCollectorPublishListProvider.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info) Gets the publish list for the collector.
java.util.Set<CmsResource>	A_CmsResourceCollector.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
java.util.List<CmsResource>	A_CmsResourceCollector.getResults(CmsObject cms)
java.util.List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms) Returns a list of CmsResource Objects that are gathered in the VFS using the default collector name and parameter.
java.util.List<CmsResource>	CmsSolrCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsDefaultResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsTimeFrameCategoryCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsChangedResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsDateResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsSubscriptionCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsPriorityResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	CmsCategoryResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
java.util.List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param) Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.
java.util.List<CmsResource>	CmsSolrCollector.getResults(CmsObject cms, java.lang.String name, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsDefaultResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsTimeFrameCategoryCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsChangedResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsDateResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsSubscriptionCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsPriorityResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	CmsCategoryResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param, int numResults)
java.util.List<CmsResource>	I_CmsResourceCollector.getResults(CmsObject cms, java.lang.String collectorName, java.lang.String params, int numResults) Returns a list of CmsResource Objects that are gathered in the VFS using the named collector.
protected java.util.List<CmsResource>	CmsDefaultResourceCollector.getSingleFile(CmsObject cms, java.lang.String param) Returns a List containing the resources pointed to by the parameter.
protected java.util.List<CmsResource>	CmsSubscriptionCollector.getSubscribedDeletedResources(CmsObject cms, java.lang.String param, int numResults) Returns the subscribed deleted resources according to the collector parameter.
protected java.util.List<CmsResource>	CmsSubscriptionCollector.getSubscribedResources(CmsObject cms, java.lang.String param, int numResults) Returns the subscribed resources according to the collector parameter.
protected CmsSubscriptionFilter	CmsSubscriptionCollector.getSubscriptionFilter(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns the configured subscription filter to use.
protected CmsSubscriptionFilter	CmsSubscriptionCollector.getSubscriptionFilter(CmsObject cms, java.lang.String param) Returns the configured subscription filter to use.
protected CmsVisitedByFilter	CmsSubscriptionCollector.getVisitedByFilter(CmsObject cms, java.lang.String param) Returns the configured visited by filter to use.
protected java.util.List<CmsResource>	CmsSubscriptionCollector.getVisitedResources(CmsObject cms, java.lang.String param, int numResults) Returns the visited resources according to the collector parameter.
void	I_CmsCollectorPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode) This is called after the new content has been created (and possibly already been filled with content).
void	CmsDefaultPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
void	CmsAddCategoriesPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode)
default void	I_CmsCollectorPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, java.lang.String config) This is called after the new content has been created (and possibly already been filled with content).
void	CmsAddCategoriesPostCreateHandler.onCreate(CmsObject cms, CmsResource createdResource, boolean copyMode, java.lang.String config) Adds the categories specified via config to the newly created resource iff not in copy mode.

Constructors in org.opencms.file.collectors with parameters of type CmsObject

Constructor and Description
CmsDateResourceComparator(CmsObject cms, java.util.List<java.lang.String> dateIdentifiers, boolean asc) Creates a new instance of this comparator key.
CmsPriorityDateResourceComparator(CmsObject cms, boolean asc) Creates a new instance of this comparator key.
CmsPriorityTitleResourceComparator(CmsObject cms) Creates a new instance of this comparator key.
CmsPropertyResourceComparator(CmsObject cms, java.lang.String property, boolean asc) Creates a new instance of this comparator key.

Uses of CmsObject in org.opencms.file.history

Methods in org.opencms.file.history with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsHistoryProject.getGroupManagersName(CmsObject cms) Returns the project manager group name.
java.lang.String	CmsHistoryProject.getGroupUsersName(CmsObject cms) Returns the projects user group name.
java.lang.String	CmsHistoryProject.getOwnerName(CmsObject cms) Returns the owner name.
java.lang.String	CmsHistoryProject.getPublishedByName(CmsObject cms) Returns the publishers name.
static CmsResource	CmsHistoryResourceHandler.getResourceWithHistory(CmsObject cms, java.lang.String resourceUri) Returns the correct resource for the given URI, taken into account historical versions marked by the version parameter.
java.lang.String	CmsHistoryFile.getUserCreatedName(CmsObject cms) Returns the name of the user that created this resource.
java.lang.String	CmsHistoryFolder.getUserCreatedName(CmsObject cms) Returns the name of the user that created this resource.
java.lang.String	CmsHistoryFile.getUserLastModifiedName(CmsObject cms) Returns the name of the user that last modified this resource.
java.lang.String	CmsHistoryFolder.getUserLastModifiedName(CmsObject cms) Returns the name of the user that last modified this resource.
CmsResource	CmsHistoryResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)

Uses of CmsObject in org.opencms.file.types

Methods in org.opencms.file.types with parameters of type CmsObject

Modifier and Type	Method and Description
void	A_CmsResourceType.changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Changes the lock of a resource to the current user, that is "steals" the lock from another user.
void	A_CmsResourceType.chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags)
void	I_CmsResourceType.chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags) Changes the resource flags of a resource.
void	A_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type)
void	I_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type) Changes the resource type of a resource.
void	A_CmsResourceTypeFolderBase.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource filename, int newType)
void	CmsResourceTypePlain.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)
void	A_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) Deprecated. Use A_CmsResourceType.chtype(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType) instead. Resource types should always be referenced either by its type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	I_CmsResourceType.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) Deprecated. Use I_CmsResourceType.chtype(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType) instead. Resource types should always be referenced either by this type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	CmsResourceTypeJsp.chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type)
void	A_CmsResourceTypeFolderBase.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode)
void	A_CmsResourceType.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode)
void	I_CmsResourceType.copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode) Copies a resource.
void	A_CmsResourceType.copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Copies a resource to the current project of the user.
protected CmsResource	A_CmsResourceType.createRelations(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourceName) Creates the relation information for the resource with the given resource name.
CmsResource	A_CmsResourceTypeFolderBase.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlContainerPage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeImage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceTypeXmlPage.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
CmsResource	CmsResourceTypeXmlContent.createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, java.util.List<CmsProperty> properties) Creates a new sibling of the source resource.
void	CmsResourceTypePlain.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	A_CmsResourceType.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	I_CmsResourceType.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode) Deletes a resource given its name.
void	CmsResourceTypeJsp.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
void	CmsResourceTypeXmlContent.deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode)
static CmsImageScaler	CmsResourceTypeImage.getDownScaler(CmsObject cms, java.lang.String rootPath) Returns the image downscaler to use when writing an image resource to the given root path.
I_CmsEditHandler	CmsResourceTypeXmlContent.getEditHandler(CmsObject cms) Returns the edit handler if configured.
CmsFormatterConfiguration	A_CmsResourceType.getFormattersForResource(CmsObject cms, CmsResource res)
CmsFormatterConfiguration	I_CmsResourceType.getFormattersForResource(CmsObject cms, CmsResource resource) Returns the formatter configuration for the given resource.
CmsFormatterConfiguration	CmsResourceTypeJsp.getFormattersForResource(CmsObject cms, CmsResource res)
CmsFormatterConfiguration	CmsResourceTypeXmlContent.getFormattersForResource(CmsObject cms, CmsResource resource)
protected java.util.Locale	CmsResourceTypeLocaleIndependentXmlContent.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) This overridden method ensures that configurations will always be created with an english locale node.
protected java.util.Locale	CmsResourceTypeXmlAdeConfiguration.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) This overridden method ensures that configurations will always be created with an english locale node.
protected java.util.Locale	CmsResourceTypeXmlContent.getLocaleForNewContent(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, java.util.List<CmsProperty> properties) Gets the locale which should be used for creating an empty content.
protected CmsMacroResolver	A_CmsResourceType.getMacroResolver(CmsObject cms, java.lang.String resourcename) Creates a macro resolver based on the current users OpenCms context and the provided resource name.
static java.util.List<CmsResource>	CmsResourceTypeXmlContent.getModelFiles(CmsObject cms, java.lang.String currentFolder, java.lang.String newResourceTypeName) Returns the possible model files for the new resource.
protected java.util.Set<java.lang.String>	CmsResourceTypePlain.getReferencingStrongLinks(CmsObject cms, CmsResource resource) Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
protected java.util.Set<java.lang.String>	CmsResourceTypeJsp.getReferencingStrongLinks(CmsObject cms, CmsResource resource) Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
protected CmsLink	CmsResourceTypeXmlContent.getXsdLink(CmsObject cms, CmsXmlContent xmlContent) Creates a new link object for the schema definition.
CmsResource	CmsResourceTypeImage.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceType.importResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, CmsResource resource, byte[] content, java.util.List<CmsProperty> properties) Imports a resource to the OpenCms VFS.
void	CmsResourceTypePlain.initialize(CmsObject cms)
void	A_CmsResourceType.initialize(CmsObject cms)
void	I_CmsResourceType.initialize(CmsObject cms) Initializes this resource type.
void	CmsResourceTypeJsp.initialize(CmsObject cms)
void	CmsResourceTypeXmlContent.initialize(CmsObject cms)
static boolean	CmsResourceTypeXmlContainerPage.isModelCopyGroup(CmsObject cms, CmsResource resource) Checks whether the given resource is a model reuse group.
void	A_CmsResourceType.lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type)
void	I_CmsResourceType.lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type) Locks a resource.
void	A_CmsResourceTypeFolderBase.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination)
void	CmsResourceTypePlain.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination)
void	A_CmsResourceType.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination)
void	I_CmsResourceType.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination) Moves a resource to the given destination.
void	CmsResourceTypeJsp.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination)
void	CmsResourceTypeXmlContent.moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination)
java.util.List<CmsLink>	CmsResourceTypeXmlContainerPage.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlPage.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeJsp.parseLinks(CmsObject cms, CmsFile file)
java.util.List<CmsLink>	CmsResourceTypeXmlContent.parseLinks(CmsObject cms, CmsFile file)
protected void	A_CmsResourceType.processCopyResources(CmsObject cms, java.lang.String resourcename, CmsMacroResolver resolver) Processes the copy resources of this resource type.
void	A_CmsResourceType.removeResourceFromProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.removeResourceFromProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Removes a resource from the current project of the user.
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties)
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, java.util.List<CmsProperty> properties) Replaces the content, type and properties of a resource.
void	A_CmsResourceTypeFolderBase.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	CmsResourceTypeImage.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	CmsResourceTypePlain.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	A_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use A_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by its type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	I_CmsResourceType.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties) Deprecated. Use I_CmsResourceType.replaceResource(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType, byte[], List) instead. Resource types should always be referenced either by this type class (preferred) or by type name. Use of int based resource type references will be discontinued in a future OpenCms release.
void	CmsResourceTypeJsp.replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List<CmsProperty> properties)
void	CmsResourceTypePlain.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	A_CmsResourceType.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	I_CmsResourceType.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version) Restores a resource in the current project with a version from the historical archive.
void	CmsResourceTypeJsp.restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version)
void	A_CmsResourceTypeFolderBase.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypePlain.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	A_CmsResourceType.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	I_CmsResourceType.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive) Changes the "expire" date of a resource.
void	CmsResourceTypeJsp.setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive)
void	A_CmsResourceTypeFolderBase.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypePlain.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	A_CmsResourceType.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	I_CmsResourceType.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive) Changes the "last modified" date of a resource.
void	CmsResourceTypeJsp.setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	A_CmsResourceTypeFolderBase.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive)
void	CmsResourceTypePlain.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	A_CmsResourceType.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	I_CmsResourceType.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive) Changes the "release" date of a resource.
void	CmsResourceTypeJsp.setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive)
void	A_CmsResourceTypeFolderBase.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive)
void	A_CmsResourceType.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive)
void	I_CmsResourceType.undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive) Undeletes a resource.
void	A_CmsResourceTypeFolderBase.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	CmsResourceTypePlain.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	A_CmsResourceType.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	I_CmsResourceType.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode) Undos all changes in the resource by restoring the version from the online project to the current offline project.
void	CmsResourceTypeJsp.undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode)
void	A_CmsResourceType.unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource)
void	I_CmsResourceType.unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Unlocks a resource.
protected void	A_CmsResourceType.updateRelationForUndo(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Update the relations after an undo changes operation.
CmsFile	CmsResourceTypeFunctionConfig.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContainerPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeImage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypePlain.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlPage.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	A_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	I_CmsResourceType.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
CmsFile	CmsResourceTypeJsp.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
CmsFile	CmsResourceTypeXmlContent.writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)
void	A_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property)
void	I_CmsResourceType.writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property) Writes a property for a specified resource.
void	A_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.util.List<CmsProperty> properties)
void	I_CmsResourceType.writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.util.List<CmsProperty> properties) Writes a list of properties for a specified resource.

Uses of CmsObject in org.opencms.file.wrapper

Methods in org.opencms.file.wrapper with parameters of type CmsObject

Modifier and Type	Method and Description
static java.lang.String	CmsResourceWrapperUtils.addFileExtension(CmsObject cms, java.lang.String resourcename, java.lang.String extension) Adds a file extension to the resource name.
java.util.List<CmsResource>	CmsResourceWrapperXmlPage.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
java.util.List<CmsResource>	CmsResourceWrapperSystemFolder.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
java.util.List<CmsResource>	CmsResourceWrapperPropertyFile.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
java.util.List<CmsResource>	CmsResourceWrapperModules.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
java.util.List<CmsResource>	A_CmsResourceWrapper.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
java.util.List<CmsResource>	I_CmsResourceWrapper.addResourcesToFolder(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Here it is possible to add additional (virtual) child resources to those already existing in the VFS.
boolean	CmsResourceWrapperXmlPage.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode)
boolean	A_CmsResourceExtensionWrapper.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode)
boolean	A_CmsResourceWrapper.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode)
boolean	I_CmsResourceWrapper.copyResource(CmsObject cms, java.lang.String source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode) Copies a resource.
static CmsFile	CmsResourceWrapperUtils.createPropertyFile(CmsObject cms, CmsResource res, java.lang.String path) Creates a virtual CmsFile with the individual and shared properties as content.
CmsResource	CmsResourceWrapperReplaceDeleted.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperXmlPage.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceExtensionWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPropertyFile.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperModules.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	A_CmsResourceWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	CmsResourceWrapperPreventCreateNameCI.createResource(CmsObject cms, java.lang.String resourcepath, int type, byte[] content, java.util.List<CmsProperty> properties)
CmsResource	I_CmsResourceWrapper.createResource(CmsObject cms, java.lang.String resourcename, int type, byte[] content, java.util.List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.
boolean	CmsResourceWrapperXmlPage.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode)
boolean	A_CmsResourceExtensionWrapper.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode)
boolean	CmsResourceWrapperPropertyFile.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode)
boolean	CmsResourceWrapperModules.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode)
boolean	A_CmsResourceWrapper.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode)
boolean	I_CmsResourceWrapper.deleteResource(CmsObject cms, java.lang.String resourcename, CmsResource.CmsResourceDeleteMode siblingMode) Deletes a resource given its name.
CmsLock	CmsResourceWrapperXmlPage.getLock(CmsObject cms, CmsResource resource)
CmsLock	A_CmsResourceExtensionWrapper.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsResourceWrapperPropertyFile.getLock(CmsObject cms, CmsResource resource)
CmsLock	CmsResourceWrapperModules.getLock(CmsObject cms, CmsResource resource)
CmsLock	A_CmsResourceWrapper.getLock(CmsObject cms, CmsResource resource)
CmsLock	I_CmsResourceWrapper.getLock(CmsObject cms, CmsResource resource) Returns the lock for the resource.
protected java.lang.String	CmsResourceWrapperXmlPage.getUriStyleSheet(CmsObject cms, CmsResource res) Returns the OpenCms VFS uri of the style sheet of the resource.
protected java.lang.String	CmsResourceWrapperXmlPage.getUriTemplate(CmsObject cms, CmsResource res) Returns the OpenCms VFS uri of the template of the resource.
boolean	CmsResourceWrapperReplaceDeleted.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperXmlPage.isWrappedResource(CmsObject cms, CmsResource res)
boolean	A_CmsResourceExtensionWrapper.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperSystemFolder.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperPropertyFile.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperModules.isWrappedResource(CmsObject cms, CmsResource res)
boolean	CmsResourceWrapperPreventCreateNameCI.isWrappedResource(CmsObject cms, CmsResource res)
boolean	I_CmsResourceWrapper.isWrappedResource(CmsObject cms, CmsResource res) Is called to check if the given resource is handled by this wrapper.
boolean	CmsResourceWrapperXmlPage.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary)
boolean	A_CmsResourceExtensionWrapper.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary)
boolean	CmsResourceWrapperPropertyFile.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary)
boolean	CmsResourceWrapperModules.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary)
boolean	A_CmsResourceWrapper.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary)
boolean	I_CmsResourceWrapper.lockResource(CmsObject cms, java.lang.String resourcename, boolean temporary) Locks a resource.
boolean	CmsResourceWrapperXmlPage.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
boolean	A_CmsResourceExtensionWrapper.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
boolean	A_CmsResourceWrapper.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
boolean	CmsResourceWrapperPreventCreateNameCI.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination)
boolean	I_CmsResourceWrapper.moveResource(CmsObject cms, java.lang.String source, java.lang.String destination) Moves a resource to the given destination.
protected java.lang.String	CmsResourceWrapperXmlPage.prepareContent(java.lang.String content, CmsObject cms, CmsResource xmlPage, java.lang.String path) Prepare the content of a xml page before returning.
CmsFile	CmsResourceWrapperXmlPage.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceExtensionWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsResourceWrapperPropertyFile.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	CmsResourceWrapperModules.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	A_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsFile	I_CmsResourceWrapper.readFile(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Reads a file resource (including it's binary content) from the VFS, using the specified resource filter.
CmsResource	CmsResourceWrapperXmlPage.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsResource	A_CmsResourceExtensionWrapper.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperSystemFolder.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperPropertyFile.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsResource	CmsResourceWrapperModules.readResource(CmsObject cms, java.lang.String resourcepath, CmsResourceFilter filter)
CmsResource	A_CmsResourceWrapper.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter)
CmsResource	I_CmsResourceWrapper.readResource(CmsObject cms, java.lang.String resourcename, CmsResourceFilter filter) Reads a resource from the VFS, using the specified resource filter.
static java.lang.String	CmsResourceWrapperUtils.removeFileExtension(CmsObject cms, java.lang.String resourcename, java.lang.String extension) Removes an added file extension from the resource name.
java.lang.String	CmsResourceWrapperXmlPage.restoreLink(CmsObject cms, java.lang.String uri)
java.lang.String	A_CmsResourceExtensionWrapper.restoreLink(CmsObject cms, java.lang.String uri)
java.lang.String	CmsResourceWrapperPropertyFile.restoreLink(CmsObject cms, java.lang.String uri)
java.lang.String	A_CmsResourceWrapper.restoreLink(CmsObject cms, java.lang.String uri)
java.lang.String	I_CmsResourceWrapper.restoreLink(CmsObject cms, java.lang.String uri) Returns the link to a existing resource in the VFS for the uri.
java.lang.String	CmsResourceWrapperXmlPage.rewriteLink(CmsObject cms, CmsResource res)
java.lang.String	A_CmsResourceExtensionWrapper.rewriteLink(CmsObject cms, CmsResource res)
java.lang.String	A_CmsResourceWrapper.rewriteLink(CmsObject cms, CmsResource res)
java.lang.String	I_CmsResourceWrapper.rewriteLink(CmsObject cms, CmsResource res) Returns the link how it is for the resource after using this resource wrapper.
boolean	CmsResourceWrapperXmlPage.unlockResource(CmsObject cms, java.lang.String resourcename)
boolean	A_CmsResourceExtensionWrapper.unlockResource(CmsObject cms, java.lang.String resourcename)
boolean	CmsResourceWrapperPropertyFile.unlockResource(CmsObject cms, java.lang.String resourcename)
boolean	CmsResourceWrapperModules.unlockResource(CmsObject cms, java.lang.String resourcename)
boolean	A_CmsResourceWrapper.unlockResource(CmsObject cms, java.lang.String resourcename)
boolean	I_CmsResourceWrapper.unlockResource(CmsObject cms, java.lang.String resourcename) Unlocks a resource.
CmsResource	CmsResourceWrapperXmlPage.wrapResource(CmsObject cms, CmsResource res)
CmsResource	A_CmsResourceExtensionWrapper.wrapResource(CmsObject cms, CmsResource res)
CmsResource	A_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource)
CmsResource	I_CmsResourceWrapper.wrapResource(CmsObject cms, CmsResource resource) Changes the given resource based on the implementation of this wrapper.
CmsFile	CmsResourceWrapperXmlPage.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceExtensionWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperPropertyFile.writeFile(CmsObject cms, CmsFile resource)
CmsFile	CmsResourceWrapperModules.writeFile(CmsObject cms, CmsFile resource)
CmsFile	A_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource)
CmsFile	I_CmsResourceWrapper.writeFile(CmsObject cms, CmsFile resource) Writes a resource, including it's content.
static void	CmsResourceWrapperUtils.writePropertyFile(CmsObject cms, java.lang.String resourcename, byte[] content) Takes the content which should be formatted as a property file and set them as properties to the resource.

Constructors in org.opencms.file.wrapper with parameters of type CmsObject

Constructor and Description
CmsObjectWrapper(CmsObject cms, java.util.List<I_CmsResourceWrapper> wrappers) Constructor with the CmsObject to wrap and the resource wrappers to use.

Uses of CmsObject in org.opencms.flex

Methods in org.opencms.flex that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsFlexController.getCmsObject() Returns the wrapped CmsObject.
static CmsObject	CmsFlexController.getCmsObject(javax.servlet.ServletRequest req) Returns the wrapped CmsObject form the provided request, or null if the request is not running inside OpenCms.

Methods in org.opencms.flex with parameters of type CmsObject

Modifier and Type	Method and Description
CmsFlexCacheKey	CmsFlexCache.getCachedKey(java.lang.String key, CmsObject cms) Returns the CmsFlexCacheKey data structure for a given key (i.e. resource name).
java.util.Set<java.lang.String>	CmsFlexCache.getCachedResources(CmsObject cms) Returns a set of all cached resource names.
java.util.Set<java.lang.String>	CmsFlexCache.getCachedVariations(java.lang.String key, CmsObject cms) Returns all variations in the cache for a given resource name.
void	CmsFlexCache.initializeCms(CmsObject adminCms) Initializes the flex cache.
static CmsFlexBucketConfiguration	CmsFlexBucketConfiguration.loadFromVfsFile(CmsObject cms, java.lang.String path) Loads a flex bucket configuration from the OpenCms VFS.

Constructors in org.opencms.flex with parameters of type CmsObject

Constructor and Description
CmsFlexController(CmsObject cms, CmsFlexController base) Creates a new controller form the old one, exchanging just the provided OpenCms user context.
CmsFlexController(CmsObject cms, CmsResource resource, CmsFlexCache cache, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top) Default constructor.

Uses of CmsObject in org.opencms.gwt

Fields in org.opencms.gwt declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsTemplateFinder.m_cms The cms context.

Methods in org.opencms.gwt that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsGwtService.getCmsObject() Returns the current cms context.
protected CmsObject	CmsTemplateFinder.getCmsObject() Gets the CMS context to use.

Methods in org.opencms.gwt with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsListInfoBean	CmsVfsService.addLockInfo(CmsObject cms, CmsResource resource, CmsListInfoBean resourceInfo) Adds the lock state information to the resource info bean.
protected static CmsListInfoBean	CmsVfsService.addPageInfo(CmsObject cms, CmsResource resource, CmsListInfoBean listInfo) Gets page information of a resource and adds it to the given list info bean.
static java.util.List<CmsCategoryTreeEntry>	CmsCoreService.buildCategoryTree(CmsObject cms, java.util.List<CmsCategory> categories) Builds the tree structure for the given categories.
void	CmsGwtService.checkPermissions(CmsObject cms) Checks the permissions of the current user to match the required security level.
java.lang.String	CmsAliasHelper.exportAliasesAsCsv(CmsObject cms) Returns the comma separated alias data.
static java.lang.String	CmsGwtActionElement.exportCommon(CmsObject cms, CmsCoreData coreData) Returns the serialized data for the core provider wrapped into a script tag.
static java.lang.String	CmsVfsService.formatDateTime(CmsObject cms, long date) Formats a date given the current user's workplace locale.
static java.util.List<CmsCategoryTreeEntry>	CmsCoreService.getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath) Helper method for getting the category beans for the given site path.
static java.util.List<CmsCategoryTreeEntry>	CmsCoreService.getCategoriesForSitePathStatic(CmsObject cms, java.lang.String sitePath, java.lang.String localCategoryRepositoryPath) Helper method for getting the category beans for the given site path.
static CmsRelationTargetListBean	CmsDefaultResourceStatusProvider.getContainerpageRelationTargets(CmsObject cms, CmsUUID source, java.util.List<CmsUUID> additionalIds, boolean cancelIfChanged) Gets the relation targets for a resource.
static java.util.List<CmsContextMenuEntryBean>	CmsCoreService.getContextMenuEntries(CmsObject cms, CmsUUID structureId, CmsCoreData.AdeContext context) Returns the context menu entries for the given URI.
static java.lang.String	CmsIconUtil.getDisplayType(CmsObject cms, CmsResource resource) Returns the resource type name used to display the resource icon.
static java.lang.String	CmsCoreService.getFileExplorerLink(CmsObject cms, java.lang.String siteRoot) Returns the file explorer link prefix.
static java.lang.String	CmsVfsService.getNoPreviewReason(CmsObject cms, CmsResource resource) Returns the no preview reason if there is any.
static CmsListInfoBean	CmsVfsService.getPageInfo(CmsObject cms, CmsResource res) Gets page information of a resource.
static CmsListInfoBean	CmsVfsService.getPageInfoWithLock(CmsObject cms, CmsResource resource) Returns a bean to display the org.opencms.gwt.client.ui.CmsListItemWidget including the lock state.
static java.util.List<CmsQuickLaunchData>	CmsQuickLaunchProvider.getQuickLaunchData(CmsObject cms, javax.servlet.http.HttpSession session, CmsQuickLaunchParams params) Gets the quick launch data for the current user and context.
CmsResourceStatusBean	CmsDefaultResourceStatusProvider.getResourceStatus(javax.servlet.http.HttpServletRequest request, CmsObject cms, CmsUUID structureId, java.lang.String contentLocale, boolean includeTargets, CmsUUID detailContentId, java.util.List<CmsUUID> additionalStructureIds, java.util.Map<java.lang.String,java.lang.String> context) Collects all the data to display in the resource status dialog.
protected com.google.gwt.user.server.rpc.SerializationPolicy	CmsGwtServiceContext.getSerializationPolicy(CmsObject cms, java.lang.String moduleBaseURL, java.lang.String strongName) Returns the serialization policy for the service.
protected java.util.List<CmsResourceStatusRelationBean>	CmsDefaultResourceStatusProvider.getSiblings(CmsObject cms, java.lang.String locale, CmsResource resource) Gets beans which represents the siblings of a resource.
protected java.util.List<CmsResourceStatusRelationBean>	CmsDefaultResourceStatusProvider.getTargets(CmsObject cms, java.lang.String locale, CmsResource resource, java.util.List<CmsUUID> additionalStructureIds) Gets the list of relation targets for a resource.
static java.lang.String	CmsCoreService.getVaadinWorkplaceLink(CmsObject cms, CmsUUID structureId) Returns the workplace link.
static java.lang.String	CmsCoreService.getVaadinWorkplaceLink(CmsObject cms, java.lang.String resourceRootFolder) Returns the workplace link.
static CmsReturnLinkInfo	CmsCoreService.internalGetLinkForReturnCode(CmsObject cms, java.lang.String returnCode) Implementation method for getting the link for a given return code.
protected boolean	CmsPropertyEditorHelper.isWritable(CmsObject cms, CmsResource resource) Returns whether the current user has write permissions, the resource is lockable or already locked by the current user and is in the current project.
static java.lang.String	CmsVfsService.prepareFileNameForEditor(CmsObject cms, CmsResource res, java.lang.String pathWithMacros) Processes a file path, which may have macros in it, so it can be opened by the XML content editor.
void	CmsGwtService.setCms(CmsObject cms) Sets the current cms context.
void	CmsVfsService.setCms(CmsObject cms) Sets the current cms context.
void	CmsAliasHelper.setCms(CmsObject cms) Sets the CMS object.
void	CmsDefaultResourceStatusProvider.sortRelations(CmsObject cms, CmsResourceStatusBean resStatus) Sorts relation beans from other sites by site order.
static void	CmsPropertyEditorHelper.updateWysiwygConfig(java.util.Map<java.lang.String,CmsXmlContentProperty> propertyConfig, CmsObject cms, CmsResource resource) Updates the property configuration for properties using WYSIWYG widgets.
java.util.Map<java.lang.String,CmsValidationResult>	I_CmsFormValidator.validate(CmsObject cms, java.util.Map<java.lang.String,CmsValidationQuery> queries, java.util.Map<java.lang.String,java.lang.String> values, java.lang.String config) Validates the form and returns the validation result.
java.util.Map<java.lang.String,CmsValidationResult>	CmsDefaultFormValidator.validate(CmsObject cms, java.util.Map<java.lang.String,CmsValidationQuery> queries, java.util.Map<java.lang.String,java.lang.String> values, java.lang.String config)
CmsValidationResult	I_CmsValidationService.validate(CmsObject cms, java.lang.String value, java.lang.String config) Validates a single form field value.
CmsValidationResult	CmsUrlNameValidationService.validate(CmsObject cms, java.lang.String value, java.lang.String config)

Constructors in org.opencms.gwt with parameters of type CmsObject

Constructor and Description
CmsBrokenLinkRenderer(CmsObject cms) Creates a new broken link renderer instance.
CmsClientUserSettingConverter(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates a new instance.
CmsPropertyEditorHelper(CmsObject cms) Creates a new instance.
CmsTemplateFinder(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.i18n

Fields in org.opencms.i18n declared as CmsObject

Modifier and Type	Field and Description
protected static CmsObject	CmsVfsResourceBundle.m_cms The CMS context to use.

Methods in org.opencms.i18n with parameters of type CmsObject

Modifier and Type	Method and Description
java.util.List<java.util.Locale>	CmsLocaleManager.getAvailableLocales(CmsObject cms, CmsResource resource) Returns an array of available locale names for the given resource.
java.util.List<java.util.Locale>	CmsLocaleManager.getAvailableLocales(CmsObject cms, java.lang.String resourceName) Returns an array of available locale names for the given resource.
java.util.Locale	CmsLocaleManager.getBestAvailableLocaleForXmlContent(CmsObject cms, CmsResource resource, I_CmsXmlDocument content) Returns the best available locale present in the given XML content, or the default locale.
java.util.Locale	CmsLocaleManager.getDefaultLocale(CmsObject cms, CmsResource resource) Returns the "the" default locale for the given resource.
java.util.Locale	CmsLocaleManager.getDefaultLocale(CmsObject cms, java.lang.String resourceName) Returns the "the" default locale for the given resource.
java.util.List<java.util.Locale>	CmsLocaleManager.getDefaultLocales(CmsObject cms, CmsResource resource) Returns an array of default locales for the given resource.
java.util.List<java.util.Locale>	CmsLocaleManager.getDefaultLocales(CmsObject cms, java.lang.String resourceName) Returns an array of default locales for the given resource.
static java.util.Locale	CmsLocaleManager.getMainLocale(CmsObject cms, CmsResource res) Utility method to get the primary locale for a given resource.
static java.util.List<java.util.Locale>	CmsLocaleGroupService.getPossibleLocales(CmsObject cms, CmsResource currentResource) Helper method for getting the possible locales for a resource.
static java.lang.String	CmsLocaleManager.getResourceEncoding(CmsObject cms, CmsResource res) Returns the content encoding set for the given resource.
void	CmsSingleTreeLocaleHandler.initHandler(CmsObject cms)
void	CmsDefaultLocaleHandler.initHandler(CmsObject cms)
void	I_CmsLocaleHandler.initHandler(CmsObject cms) Will be called during system startup.
void	CmsLocaleManager.initialize(CmsObject cms) Initializes this locale manager with the OpenCms system configuration.
java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>>	CmsVfsResourceBundle.I_Loader.loadData(CmsObject cms, CmsVfsBundleParameters params) Loads the data from the VFS.
java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>>	CmsVfsBundleLoaderProperties.loadData(CmsObject cms, CmsVfsBundleParameters params)
static void	CmsVfsResourceBundle.setCmsObject(CmsObject cms) Sets the CMS context used by this class.

Constructors in org.opencms.i18n with parameters of type CmsObject

Constructor and Description
CmsLocaleGroup(CmsObject cms, CmsResource primaryResource, java.util.List<CmsResource> secondaryResources) Creates a new instance.
CmsLocaleGroupService(CmsObject cms) Creates a new instance.
CmsVfsBundleManager(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.i18n.tools

Constructors in org.opencms.i18n.tools with parameters of type CmsObject

Constructor and Description
CmsContainerPageCopier(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.importexport

Fields in org.opencms.importexport declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsImport.m_cms Deprecated. The cms context to do the import operations with.
protected CmsObject	CmsImportVersion10.m_cms The cms object.
protected CmsObject	CmsImport.m_cms The cms context.

Methods in org.opencms.importexport that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsImportVersion7.getCms() Deprecated. Returns the cms object.
protected CmsObject	CmsExport.getCms() Returns the OpenCms context object this export was initialized with.
CmsObject	CmsImportVersion10.getCms() Returns the cms object.

Methods in org.opencms.importexport with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsXmlPage	CmsXmlPageConverter.convertToXmlPage(CmsObject cms, byte[] content, java.util.Locale locale, java.lang.String encoding) Deprecated. Converts the contents of a page into an xml page.
void	CmsImportExportManager.exportData(CmsObject cms, I_CmsImportExportHandler handler, I_CmsReport report) Checks if the current user has permissions to export Cms data of a specified export handler, and if so, triggers the handler to write the export.
void	I_CmsImportExportHandler.exportData(CmsObject cms, I_CmsReport report) Exports the data from the Cms.
void	CmsVfsImportExportHandler.exportData(CmsObject cms, I_CmsReport report)
void	I_CmsImportExportHandler.importData(CmsObject cms, I_CmsReport report) Imports the data into the Cms.
void	CmsVfsImportExportHandler.importData(CmsObject cms, I_CmsReport report)
void	CmsImportVersion2.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.
void	CmsImportExportManager.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) Checks if the current user has permissions to import data into the Cms, and if so, creates a new import handler instance that imports the data.
void	CmsImportVersion4.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.
void	CmsImportResourceDataReader.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters)
void	CmsImportVersion7.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) Deprecated.
void	I_CmsImport.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters) Imports the data.
void	CmsImportVersion5.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.
void	CmsImportVersion10.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters)
void	CmsImportVersion3.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params) Deprecated.
void	CmsImportExportManager.importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) Deprecated. use CmsImportExportManager.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	I_CmsImportExportHandler.importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) Deprecated. use I_CmsImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	CmsVfsImportExportHandler.importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) Deprecated. use CmsVfsImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	CmsImportVersion2.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion2.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportVersion4.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion4.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportVersion7.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion7.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	I_CmsImport.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use I_CmsImport.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportVersion5.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion5.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportVersion10.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion10.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportVersion3.importResources(CmsObject cms, java.lang.String importPath, I_CmsReport report, java.io.File importResource, java.util.zip.ZipFile importZip, org.dom4j.Document docXml) Deprecated. use CmsImportVersion3.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
static void	CmsImportVersion10.parseLinks(CmsObject cms, java.util.List<CmsResource> parseables, I_CmsReport report) Parses the links.

Constructors in org.opencms.importexport with parameters of type CmsObject

Constructor and Description
CmsExport(CmsObject cms, I_CmsReport report) Constructs a new export.
CmsImport(CmsObject cms, I_CmsReport report) Constructs a new import object which imports the resources from an OpenCms export zip file or a folder in the "real" file system.

Uses of CmsObject in org.opencms.jlan

Methods in org.opencms.jlan with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsJlanRepository.initializeCms(CmsObject cms)
static void	CmsJlanUsers.setAdminCms(CmsObject cms) Sets the CMS context.

Uses of CmsObject in org.opencms.jsp

Fields in org.opencms.jsp declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsJspTagResourceLoad.m_cms The CmsObject for the current user.
protected CmsObject	CmsJspNavBuilder.m_cms The current CMS context.
protected CmsObject	CmsJspTagFormatter.m_cms The CmsObject for the current user.
protected CmsObject	CmsJspTagNavigation.m_cms The CmsObject for the current user.
protected CmsObject	CmsJspTagSearch.m_cms The CmsObject for the current user.

Methods in org.opencms.jsp that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsJspBean.getCmsObject() Returns the CmsObject from the wrapped request.
CmsObject	CmsJspNavBuilder.getCmsObject() Gets the CMS context used for building the navigation.
CmsObject	CmsJspResourceWrapper.getCmsObject() Returns the OpenCms user context this resource was initialized with.

Methods in org.opencms.jsp with parameters of type CmsObject

Modifier and Type	Method and Description
protected void	CmsJspTagHeadIncludes.collectHeadIncludesForContainerElement(CmsObject cms, javax.servlet.ServletRequest req, CmsJspStandardContextBean standardContext, CmsContainerPageBean containerPage, java.lang.String includeType, java.util.Set<java.lang.String> headincludes, java.util.Map<java.lang.String,java.lang.String> inline) Collects the head includes for a given container element.
static java.lang.String	CmsJspTagEdit.createResource(CmsObject cmsObject, java.lang.String newLink, java.util.Locale locale, java.lang.String sitePath, java.lang.String modelFileName, java.lang.String mode, java.lang.String postCreateHandler) Creates a new resource.
static I_CmsFormatterBean	CmsJspTagContainer.ensureValidFormatterSettings(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth) Ensures the appropriate formatter configuration ID is set in the element settings.
protected java.lang.String	CmsJspTagContainer.getContainerData(CmsObject cms, int maxElements, boolean isDetailView, boolean isDetailOnly) Returns the serialized data of the given container.
static java.lang.String	CmsJspNavBuilder.getDefaultFile(CmsObject cms, java.lang.String folder) Deprecated. use readDefaultFile(String) instead
static I_CmsFormatterBean	CmsJspTagContainer.getFormatterConfigurationForElement(CmsObject cms, CmsContainerElementBean element, CmsADEConfigData adeConfig, java.lang.String containerName, java.lang.String containerType, int containerWidth) Returns the formatter configuration for the given element.
static java.util.List<CmsContainerElementBean>	CmsJspTagContainer.getGroupContainerElements(CmsObject cms, CmsContainerElementBean element, javax.servlet.ServletRequest req, java.lang.String containerType) Returns the element group elements.
static java.util.List<CmsContainerElementBean>	CmsJspTagContainer.getInheritedContainerElements(CmsObject cms, CmsContainerElementBean element) Reads elements from an inherited container.
static java.lang.String	Messages.getLocalizedMessage(CmsMessageContainer container, CmsObject cms) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.
static java.util.List<CmsJspNavElement>	CmsJspNavBuilder.getNavigationForFolder(CmsObject cms, java.lang.String folder) Deprecated. use CmsJspNavBuilder.getNavigationForFolder(String) instead
static java.util.List<CmsJspNavElement>	CmsJspNavBuilder.getNavigationForFolder(CmsObject cms, java.lang.String folder, int level) Deprecated. use CmsJspNavBuilder.getNavigationForFolder(String, int) instead
static CmsJspNavElement	CmsJspNavBuilder.getNavigationForResource(CmsObject cms, java.lang.String resource) Deprecated. use CmsJspNavBuilder.getNavigationForResource(String) instead
static java.util.List<CmsJspNavElement>	CmsJspNavBuilder.getNavigationTreeForFolder(CmsObject cms, java.lang.String folder, int startlevel, int endlevel) Deprecated. use CmsJspNavBuilder.getNavigationForResource(String) instead
static java.lang.String	CmsJspTagEdit.getNewLink(CmsObject cms, I_CmsResourceType resType, java.lang.String creationSitemap) Creates the String specifying where which type of resource has to be created.
java.util.Set<CmsResource>	CmsJspTagSimpleSearch.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
java.util.Set<CmsResource>	CmsJspTagSearch.getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)
static java.util.Set<CmsResource>	CmsJspTagSimpleSearch.getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
static java.util.Set<CmsResource>	CmsJspTagSearch.getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
protected static java.lang.String	CmsJspTagResourceLoad.getResourceName(CmsObject cms, I_CmsResourceContainer contentContainer) Returns the resource name currently processed.
static java.util.List<CmsJspNavElement>	CmsJspNavBuilder.getSiteNavigation(CmsObject cms, java.lang.String folder, int endLevel) Deprecated. use CmsJspNavBuilder.getNavigationForResource(String) instead
static CmsJspImageBean	CmsJspTagScaleImage.imageTagAction(CmsObject cms, java.lang.String imageUri, CmsImageScaler targetScaler, java.util.List<java.lang.String> hiDpiVariantList) Internal action method to create the scaled image bean.
void	CmsJspNavBuilder.init(CmsObject cms) Initializes this bean.
void	CmsJspNavBuilder.init(CmsObject cms, java.util.Locale locale) Initializes this bean.
void	CmsJspNavBuilder.init(CmsObject cms, java.util.Locale locale, java.lang.String requestUri) Initializes this bean.
static boolean	CmsJspTagEdit.insertDirectEditStart(CmsObject cms, javax.servlet.jsp.PageContext pageContext, CmsResource resource, boolean canCreate, boolean canDelete, java.lang.String createType, java.lang.String creationSitemap, java.lang.String postCreateHandler) Inserts the opening direct edit tag.
protected boolean	CmsJspTagContainer.isEditable(CmsObject cms) Returns if the container is editable by the current user.
static boolean	CmsJspNavBuilder.isNavLevelFolder(CmsObject cms, CmsResource resource) Returns whether the given resource is a folder and is marked to be a navigation level folder.
protected static boolean	CmsJspTagUserTracking.isResourceSubscribed(CmsObject cms, java.lang.String fileName, boolean subFolder, CmsUser user, java.util.List<CmsGroup> groups, javax.servlet.http.HttpServletRequest req) Returns if the given resource is subscribed to the user or groups.
protected static boolean	CmsJspTagUserTracking.isResourceVisited(CmsObject cms, java.lang.String fileName, boolean subFolder, CmsUser user, javax.servlet.http.HttpServletRequest req) Returns if the given resource was visited by the user.
protected void	CmsJspTagContainer.printElementWrapperTagStart(CmsObject cms, CmsContainerElementBean elementBean, CmsContainerPageBean page, boolean isGroupContainer) Prints the opening element wrapper tag for the container page editor if we are in Offline mode.
void	CmsJspTagHeadIncludes.tagCssAction(CmsObject cms, javax.servlet.http.HttpServletRequest req) Action to include the CSS resources.
void	CmsJspTagHeadIncludes.tagJSAction(CmsObject cms, javax.servlet.http.HttpServletRequest req) Action to include the java-script resources.
static CmsJspResourceWrapper	CmsJspResourceWrapper.wrap(CmsObject cms, CmsResource res) Factory method to create a new CmsJspResourceWrapper instance from a CmsResource.

Constructors in org.opencms.jsp with parameters of type CmsObject

Constructor and Description
CmsJspNavBuilder(CmsObject cms) Default constructor.
CmsJspNavBuilder(CmsObject cms, java.util.Locale locale) Constructor for a version that reads properties according to a locale.

Uses of CmsObject in org.opencms.jsp.decorator

Methods in org.opencms.jsp.decorator that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsDecoratorConfiguration.getCms() Returns the cms.

Methods in org.opencms.jsp.decorator with parameters of type CmsObject

Modifier and Type	Method and Description
CmsDecorationBundle	CmsDecorationDefintion.createDecorationBundle(CmsObject cms, java.util.Locale locale) Creates a CmsDecorationBundle of text decoration to be used by the decorator.
static java.util.List<java.lang.String>	CmsDecorationDefintion.getDecorationDefinitionNames(CmsObject cms) Returns all different decoration configuration names (like "abbr" or "acronym") that are in the config file pointed to by module parameter "configfile".
void	I_CmsDecoratorConfiguration.init(CmsObject cms, java.lang.String configFile, java.util.Locale locale) Initialises the configuration.
void	CmsDecoratorConfiguration.init(CmsObject cms, java.lang.String configFile, java.util.Locale locale)
void	CmsDecoratorConfiguration.setCms(CmsObject cms) Sets the cms.

Constructors in org.opencms.jsp.decorator with parameters of type CmsObject

Constructor and Description
CmsDecorationMap(CmsObject cms, CmsResource res, CmsDecorationDefintion decDef) Constructor, creates a new CmsDecorationMap.
CmsDecoratorConfiguration(CmsObject cms) Constructor, creates a new, empty CmsDecoratorConfiguration.
CmsDecoratorConfiguration(CmsObject cms, java.lang.String configFile) Constructor, creates a new, CmsDecoratorConfiguration with a given config file.
CmsDecoratorConfiguration(CmsObject cms, java.lang.String configFile, java.util.Locale locale) Constructor, creates a new, CmsDecoratorConfiguration with a given config file and locale.
CmsHtmlDecorator(CmsObject cms) Constructor, creates a new, empty CmsHtmlDecorator.
CmsHtmlDecorator(CmsObject cms, I_CmsDecoratorConfiguration config) Constructor, creates a new CmsHtmlDecorator with a given configuration.

Uses of CmsObject in org.opencms.jsp.parse

Methods in org.opencms.jsp.parse that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	A_CmsConfiguredHtmlParser.getCmsObject() Returns the internal cms object for accessing core functionality.

Methods in org.opencms.jsp.parse with parameters of type CmsObject

Modifier and Type	Method and Description
void	A_CmsConfiguredHtmlParser.setCmsObject(CmsObject cmsObject) Sets the internal cms object for accessing core functionality.

Uses of CmsObject in org.opencms.jsp.search.config.parser

Methods in org.opencms.jsp.search.config.parser with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsSimpleSearchConfigurationParser	CmsSimpleSearchConfigurationParser.createInstanceWithNoJsonConfig(CmsObject cms, CmsListManager.ListConfigurationBean config) Creates an instance for an empty JSON configuration.

Constructors in org.opencms.jsp.search.config.parser with parameters of type CmsObject

Constructor and Description
CmsSimpleSearchConfigurationParser(CmsObject cms, CmsListManager.ListConfigurationBean config, java.lang.String additionalParamJSON) Constructor.

Uses of CmsObject in org.opencms.jsp.search.controller

Methods in org.opencms.jsp.search.controller with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSearchControllerFacetRange.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerFacetsField.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerFacetsRange.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerHighlighting.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerCommon.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerSorting.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchController.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerFacetQuery.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerDidYouMean.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerFacetField.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	CmsSearchControllerPagination.addQueryParts(CmsSolrQuery query, CmsObject cms)
void	I_CmsSearchController.addQueryParts(CmsSolrQuery query, CmsObject cms) Generate the Solr query part specific for the controller, e.g., the part for a field facet.

Uses of CmsObject in org.opencms.jsp.search.result

Constructors in org.opencms.jsp.search.result with parameters of type CmsObject

Constructor and Description
CmsSearchResourceBean(CmsSearchResource searchResource, CmsObject cms) Constructor taking the search resource to wrap.
CmsSearchResultWrapper(I_CmsSearchControllerMain controller, CmsSolrResultList resultList, CmsSolrQuery query, CmsObject cms, CmsSearchException exception) Constructor taking the main search form controller and the result list as normally returned.

Uses of CmsObject in org.opencms.jsp.util

Fields in org.opencms.jsp.util declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsJspVfsAccessBean.m_cms The OpenCms context of the current user.
protected CmsObject	CmsJspStandardContextBean.m_cms OpenCms user context.
protected CmsObject	CmsDynamicFunctionBeanWrapper.m_cms The internal CMS object to use.
protected CmsObject	CmsJspContentLoadBean.m_cms The OpenCms context of the current user.
protected CmsObject	CmsJspNavigationBean.m_cms The OpenCms user context.
protected CmsObject	CmsJspResourceLoadBean.m_cms The OpenCms context of the current user.

Methods in org.opencms.jsp.util that return CmsObject

Modifier and Type	Method and Description
static CmsObject	CmsJspElFunctions.convertCmsObject(java.lang.Object input) Returns an OpenCms user context created from an Object.
CmsObject	A_CmsJspCustomContextBean.getCmsObject() Returns the cms object for the current context.
CmsObject	CmsJspVfsAccessBean.getCmsObject() Returns the OpenCms user context this bean was initialized with.
CmsObject	CmsJspResourceAccessBean.getCmsObject() Returns the OpenCms user context this bean was initialized with.
CmsObject	CmsJspContentLoadBean.getCmsObject() Returns the OpenCms user context this bean was initialized with.
CmsObject	CmsJspElementSettingValueWrapper.getCmsObject()
protected CmsObject	CmsJspImageBean.getCmsObject() Returns the current OpenCms user context.
CmsObject	CmsJspContentAccessBean.getCmsObject() Returns the OpenCms user context this bean was initialized with.
CmsObject	CmsJspResourceLoadBean.getCmsObject() Returns the OpenCms user context this bean was initialized with.
static CmsObject	CmsJspElFunctions.getCmsObject(java.lang.Object input) Returns the current OpenCms user context from the given page context.
CmsObject	CmsJspContentAccessValueWrapper.obtainCmsObject() Deprecated. use A_CmsJspValueWrapper.getCmsObject() instead

Methods in org.opencms.jsp.util with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsResource	CmsJspElFunctions.convertRawResource(CmsObject cms, java.lang.Object input) Returns a resource created from an Object.
static CmsJspResourceWrapper	CmsJspElFunctions.convertResource(CmsObject cms, java.lang.Object input) Returns a resource wrapper created from the input.
static java.util.List<CmsJspContentAccessBean>	CmsJspContentLoadBean.convertResourceList(CmsObject cms, java.util.List<CmsResource> resources) Converts a list of CmsResource objects to a list of CmsJspContentAccessBean objects, using the current request context locale.
static java.util.List<CmsJspResourceWrapper>	CmsJspElFunctions.convertResourceList(CmsObject cms, java.util.List<CmsResource> list) Returns a list of resource wrappers created from the input list of resources.
static java.util.List<CmsJspContentAccessBean>	CmsJspContentLoadBean.convertResourceList(CmsObject cms, java.util.Locale locale, java.util.List<CmsResource> resources) Converts a list of CmsResource objects to a list of CmsJspContentAccessBean objects, using the given locale.
static CmsJspVfsAccessBean	CmsJspVfsAccessBean.create(CmsObject cms) Creates a new instance of the JSP VFS access utility bean.
static CmsJspContentAccessValueWrapper	CmsJspContentAccessValueWrapper.createWrapper(CmsObject cms, I_CmsXmlContentValue value, I_CmsXmlContentValue parentValue, java.lang.String valueName) Factory method to create a new XML content value wrapper.
static CmsJspContentAccessValueWrapper	CmsJspContentAccessValueWrapper.createWrapper(CmsObject cms, I_CmsXmlContentValue value, I_CmsXmlDocument content, java.lang.String valueName, java.util.Locale locale) Factory method to create a new XML content value wrapper.
static CmsJspObjectValueWrapper	CmsJspObjectValueWrapper.createWrapper(CmsObject cms, java.lang.Object value) Factory method to create a new XML content value wrapper.
static java.util.List<java.lang.String>	CmsJspContentAttachmentsBean.getAttachmentLocales(CmsObject cms, CmsResource content) Gets the list of locales for which attachments / detail-only containers are available.
static CmsJspContentAttachmentsBean	CmsJspContentAttachmentsBean.getAttachmentsForCurrentPage(CmsObject cms, CmsResource content) Gets the attachments / detail-only contents for the current page (i.e. cms.getRequestContext().getUri()).
static CmsJspContentAttachmentsBean	CmsJspContentAttachmentsBean.getAttachmentsForLocale(CmsObject cms, CmsResource content, java.lang.String locale) Loads the attachments for a given content.
static CmsResource	CmsFunctionRenderer.getDefaultFunctionInstance(CmsObject cms) Cached method for accessing the default function formatter.
static CmsResource	CmsFunctionRenderer.getDefaultFunctionJsp(CmsObject cms) Cached method for accessing the default function formatter JSP.
void	CmsJspResourceAccessBean.init(CmsObject cms, CmsResource resource) Initialize this instance.
protected void	CmsJspImageBean.init(CmsObject cms, CmsResource imageRes, java.lang.String scaleParams) Initializes this new image bean based on a VFS resource and optional scaler parameters.
void	CmsJspResourceLoadBean.init(CmsObject cms, java.util.List<CmsResource> resources) Initialize this instance.
void	CmsJspContentAccessBean.init(CmsObject cms, java.util.Locale locale, I_CmsXmlDocument content, CmsResource resource) Initialize this instance.
void	CmsJspContentLoadBean.init(CmsObject cms, java.util.Locale locale, java.util.List<CmsResource> content) Initialize this instance.
void	CmsJspStandardContextBean.CmsContainerElementWrapper.initResource(CmsObject cms)
void	CmsJspStandardContextBean.CmsContainerElementWrapper.initSettings(CmsObject cms, I_CmsFormatterBean formatterBean, java.util.Locale locale, javax.servlet.ServletRequest request, java.util.Map<java.lang.String,java.lang.String> settingPresets)
boolean	CmsJspStandardContextBean.CmsContainerElementWrapper.isGroupContainer(CmsObject cms)
boolean	CmsJspStandardContextBean.CmsContainerElementWrapper.isInheritedContainer(CmsObject cms)
static java.lang.String	CmsStringTemplateRenderer.renderTemplate(CmsObject cms, java.lang.String template, CmsJspContentAccessBean content, java.util.Map<java.lang.String,java.lang.Object> contextObjects) Renders the given string template.
static java.lang.String	CmsStringTemplateRenderer.renderTemplate(CmsObject cms, java.lang.String template, CmsResource content, java.util.Map<java.lang.String,java.lang.Object> contextObjects) Renders the given string template.
protected void	CmsJspImageBean.setCmsObject(CmsObject cms) Sets the current OpenCms user context.
protected void	CmsJspImageBean.setResource(CmsObject cms, CmsResource resource) Sets the CmsResource for this image.
void	CmsJspStandardContextBean.updateCmsObject(CmsObject cms) Updates the internally stored OpenCms user context.
static java.util.Map<java.lang.String,CmsJspObjectValueWrapper>	CmsStringTemplateRenderer.wrapSettings(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> settings) Wraps the element settings with access wrappers.

Constructors in org.opencms.jsp.util with parameters of type CmsObject

Constructor and Description
CmsDynamicFunctionBeanWrapper(CmsObject cms, CmsDynamicFunctionBean functionBean) Creates a new wrapper instance.
CmsDynamicFunctionFormatWrapper(CmsObject cms, CmsDynamicFunctionBean.Format format) Creates a new wrapper instance for a given format.
CmsErrorBean(CmsObject cms, java.lang.Throwable throwable) Constructs a new error bean.
CmsJspCategoryAccessBean(CmsObject cms, CmsResource resource) Default constructor.
CmsJspContentAccessBean(CmsObject cms, CmsResource resource) Creates a content access bean based on a Resource, using the current request context locale.
CmsJspContentAccessBean(CmsObject cms, java.util.Locale locale, CmsResource resource) Creates a content access bean based on a Resource.
CmsJspContentAccessBean(CmsObject cms, java.util.Locale locale, I_CmsXmlDocument content) Creates a content access bean based on an XML content object.
CmsJspContentAttachmentsBean(CmsObject cms, CmsResource pageResource) Initializes this bean with the contents of a detail-only page.
CmsJspContentLoadBean(CmsObject cms, java.util.List<CmsResource> content) Creates a new context bean using the OpenCms context of the current user.
CmsJspContentLoadBean(CmsObject cms, java.util.Locale locale, java.util.List<CmsResource> content) Creates a new context bean using the OpenCms context of the current user with the given locale.
CmsJspImageBean(CmsObject cms, CmsResource imageRes, java.lang.String scaleParams) Initializes a new image bean based on a VFS resource and optional scaler parameters.
CmsJspImageBean(CmsObject cms, java.lang.String imageUri) Initializes a new image bean based on a string pointing to a VFS resource that may contain appended scaling parameters.
CmsJspImageBean(CmsObject cms, java.lang.String imageUri, CmsImageScaler initScaler) Initializes a new image bean based on a VFS input string and applies additional re-scaling.
CmsJspLinkMacroResolver(CmsObject cms, java.lang.String jspRootPath, boolean forRfs) Default constructor.
CmsJspNavigationBean(CmsObject cms, CmsJspTagNavigation.Type type, int startLevel, int endLevel, java.lang.String resource, java.lang.String param) Base constructor.
CmsJspNavigationBean(CmsObject cms, CmsJspTagNavigation.Type type, int startLevel, int endLevel, java.lang.String resource, java.lang.String param, java.util.Locale locale) Base constructor.
CmsJspResourceAccessBean(CmsObject cms, CmsResource resource) Creates a content access bean based on a Resource.
CmsJspResourceLoadBean(CmsObject cms, java.util.List<CmsResource> resources) Creates a new context bean using the OpenCms context of the current user.
CmsLocalePropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search) Default constructor.
CmsObjectFunctionTransformer(CmsObject cms) Constructor.
CmsPropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search) Creates a new property loading Transformer.
CmsPropertyLoaderTransformer(CmsObject cms, CmsResource resource, boolean search, java.util.Locale locale) Creates a new property loading Transformer.

Uses of CmsObject in org.opencms.loader

Methods in org.opencms.loader with parameters of type CmsObject

Modifier and Type	Method and Description
byte[]	I_CmsResourceLoader.dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Dumps the processed content of the the requested file (and it's sub-elements) to a byte array.
byte[]	CmsPointerLoader.dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsDumpLoader.dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsJspLoader.dump(CmsObject cms, CmsResource file, java.lang.String element, java.util.Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsRedirectLoader.dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsMacroFormatterLoader.dump(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale selectedLocale, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
java.lang.String	I_CmsResourceStringDumpLoader.dumpAsString(CmsObject cms, CmsResource resource, java.lang.String element, java.util.Locale locale, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Dumps the processed content of the the requested file (and it's sub-elements) to a String.
byte[]	I_CmsResourceLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Static exports the contents of the requested file and it's sub-elements.
byte[]	CmsPointerLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsDumpLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsJspLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsRedirectLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
byte[]	CmsMacroFormatterLoader.export(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
java.util.Map<java.lang.String,CmsDefaultSet<java.lang.String>>	CmsResourceManager.getAllowedContextMap(CmsObject cms) Gets the map of forbidden contexts for resource types.
CmsTemplateContextInfo	CmsTemplateContextManager.getContextInfoBean(CmsObject cms, javax.servlet.http.HttpServletRequest request) Creates a bean with information about the current template context, for use in the client-side code.
protected CmsFlexController	CmsJspLoader.getController(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top) Delivers a Flex controller, either by creating a new one, or by re-using an existing one.
protected CmsFlexController	CmsRedirectLoader.getController(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean streaming, boolean top) Delivers a Flex controller, either by creating a new one, or by re-using an existing one.
java.lang.String	CmsDefaultFileNameGenerator.getCopyFileName(CmsObject cms, java.lang.String parentFolder, java.lang.String baseName)
java.lang.String	I_CmsFileNameGenerator.getCopyFileName(CmsObject cms, java.lang.String parentFolder, java.lang.String baseName) Returns a unique copy filename for the given base name and the parent folder.
java.lang.String	CmsDefaultTemplateContextProvider.getEditorStyleSheet(CmsObject cms, java.lang.String editedResourcePath)
java.lang.String	I_CmsTemplateContextProvider.getEditorStyleSheet(CmsObject cms, java.lang.String editedResourcePath) Returns the style sheet to be used for the editor.
java.lang.String	CmsDefaultFileNameGenerator.getNewFileName(CmsObject cms, java.lang.String namePattern, int defaultDigits)
java.lang.String	I_CmsFileNameGenerator.getNewFileName(CmsObject cms, java.lang.String namePattern, int defaultDigits) Generates a new file name based on the provided OpenCms user context and name pattern.
java.lang.String	CmsDefaultFileNameGenerator.getNewFileName(CmsObject cms, java.lang.String namePattern, int defaultDigits, boolean explorerMode) Returns a new resource name based on the provided OpenCms user context and name pattern.
java.lang.String	I_CmsFileNameGenerator.getNewFileName(CmsObject cms, java.lang.String namePattern, int defaultDigits, boolean explorerMode) Generates a new file name based on the provided OpenCms user context and name pattern.
void	CmsJspLoader.getReferencingStrongLinks(CmsObject cms, CmsResource resource, java.util.Set<java.lang.String> referencingPaths) Returns a set of root paths of files that are including the given resource using the 'link.strong' macro.
protected CmsFile	CmsImageLoader.getScaledImage(CmsObject cms, CmsResource resource, CmsImageScaler scaler) Returns a scaled version of the given OpenCms VFS image resource.
CmsTemplateContext	CmsDefaultTemplateContextProvider.getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource)
CmsTemplateContext	I_CmsTemplateContextProvider.getTemplateContext(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource) Determines the template context from the current CMS context, request, and resource.
CmsTemplateContext	CmsTemplateContextManager.getTemplateContext(java.lang.String providerName, CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource) Gets the template context to use.
I_CmsTemplateContextProvider	CmsTemplateContextManager.getTemplateContextProvider(CmsObject cms, java.lang.String path) Gets the template context provider for a given path.
protected CmsTemplateLoaderFacade	CmsSeoFileLoader.getTemplateLoaderFacade(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req)
CmsTemplateLoaderFacade	CmsResourceManager.getTemplateLoaderFacade(CmsObject cms, CmsResource resource, java.lang.String templateProperty) Returns a template loader facade for the given file.
CmsTemplateLoaderFacade	CmsResourceManager.getTemplateLoaderFacade(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsResource resource, java.lang.String templateProperty) Returns a template loader facade for the given file.
java.lang.String	CmsDefaultFileNameGenerator.getUniqueFileName(CmsObject cms, java.lang.String parentFolder, java.lang.String baseName)
java.lang.String	I_CmsFileNameGenerator.getUniqueFileName(CmsObject cms, java.lang.String parentFolder, java.lang.String baseName) Returns a unique filename for the given base name and the parent folder.
void	CmsResourceManager.initialize(CmsObject cms) Initializes all additional resource types stored in the modules.
void	CmsDefaultTemplateContextProvider.initialize(CmsObject cms, java.lang.String config)
void	I_CmsTemplateContextProvider.initialize(CmsObject cms, java.lang.String config) Initializes the context provider using a CMS object.
void	I_CmsResourceLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Basic top-page processing method for a I_CmsResourceLoader, this method is called if the page is called as a sub-element on a page not already loaded with a I_CmsResourceLoader.
void	CmsPointerLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsXmlContainerPageLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsDumpLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsJspLoader.load(CmsObject cms, CmsResource file, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsRedirectLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsImageLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsMacroFormatterLoader.load(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	CmsResourceManager.loadResource(CmsObject cms, CmsResource resource, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Loads the requested resource and writes the contents to the response stream.
java.lang.String	CmsDefaultTemplateContextProvider.readCommonProperty(CmsObject cms, java.lang.String propertyName, java.lang.String fallbackValue)
java.lang.String	I_CmsTemplateContextProvider.readCommonProperty(CmsObject cms, java.lang.String propertyName, java.lang.String fallbackValue) Gets the value which should be used instead of a property which was read from the template resource.
java.lang.String	CmsTemplateContextManager.readPropertyFromTemplate(CmsObject cms, CmsResource res, java.lang.String propertyName, java.lang.String fallbackValue) Utility method which either reads a property from the template used for a specific resource, or from the template context provider used for the resource if available.
void	I_CmsResourceLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res) Does the job of including the requested resource, this method is called directly if the element is called as a sub-element from another I_CmsResourceLoader.
void	CmsPointerLoader.service(CmsObject cms, CmsResource file, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsDumpLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsJspLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsRedirectLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
void	CmsMacroFormatterLoader.service(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)
protected void	CmsJspLoader.showSource(CmsObject cms, CmsResource file, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Delivers the plain uninterpreted resource with escaped XML.
protected CmsXmlContainerPage	CmsXmlContainerPageLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsSeoFileLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlPageLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)
protected I_CmsXmlDocument	CmsXmlContentLoader.unmarshalXmlDocument(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)

Constructors in org.opencms.loader with parameters of type CmsObject

Constructor and Description
CmsImageScaler(CmsObject cms, CmsResource res) Creates a new image scaler by reading the property CmsPropertyDefinition.PROPERTY_IMAGE_SIZE from the given resource.
CmsTemplateContextManager(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.lock

Methods in org.opencms.lock with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsLockActionRecord	CmsLockUtil.ensureLock(CmsObject cms, CmsResource resource) Static helper method to lock a resource.
boolean	CmsLock.isDirectlyOwnedInProjectBy(CmsObject cms) Returns true if this is an exclusive, temporary exclusive, or directly inherited lock, and the current user is the owner of this lock, checking also the project of the lock.
static CmsLockUtil.LockedFile	CmsLockUtil.LockedFile.lockResource(CmsObject cms, CmsResource resource) Lock and read a file.
static void	CmsLockUtil.tryUnlock(CmsObject cms, CmsResource resource) Tries to unlock the given resource.
static java.lang.AutoCloseable	CmsLockUtil.withLockedResources(CmsObject cms, CmsResource... resources) Utility method for locking and unlocking a set of resources conveniently with the try-with syntax from Java 1.7.

Uses of CmsObject in org.opencms.mail

Constructors in org.opencms.mail with parameters of type CmsObject

Constructor and Description
CmsVfsDataSource(CmsObject cms, CmsResource resource) Creates a new data source for the given VFS resource.

Uses of CmsObject in org.opencms.main

Fields in org.opencms.main declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsShell.m_cms The OpenCms context object.

Methods in org.opencms.main that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsUIServlet.getCmsObject() Returns the current cms context.
protected CmsObject	OpenCmsSpellcheckHandler.getCmsObject(javax.servlet.http.HttpServletRequest req) Returns the CMS object.
protected CmsObject	OpenCmsSolrHandler.getCmsObject(javax.servlet.http.HttpServletRequest req) Returns the CMS object.
protected CmsObject	OpenCmsCore.initCmsObject(CmsObject cms) Returns an independent copy of the provided CmsObject.
static CmsObject	OpenCms.initCmsObject(CmsObject cms) Returns an independent copy of the provided CmsObject.
protected CmsObject	OpenCmsCore.initCmsObject(CmsObject adminCms, CmsContextInfo contextInfo) Returns an initialized CmsObject with the user and context initialized as provided.
static CmsObject	OpenCms.initCmsObject(CmsObject adminCms, CmsContextInfo contextInfo) Returns an initialized CmsObject with the user and context initialized as provided.
protected CmsObject	OpenCmsCore.initCmsObject(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean allowPrivilegedLogin) Handles the user authentification for each request sent to OpenCms.
protected CmsObject	OpenCmsCore.initCmsObject(java.lang.String user) Returns an initialized CmsObject with the user initialized as provided, with the "Online" project selected and "/" set as the current site root.
static CmsObject	OpenCms.initCmsObject(java.lang.String user) Returns an initialized CmsObject (OpenCms user context) with the user initialized as provided, with the "Online" project selected and "/" set as the current site root.
protected CmsObject	A_CmsAuthorizationHandler.initCmsObjectFromSession(javax.servlet.http.HttpServletRequest request) Initializes a new cms object from the session data of the request.
protected CmsObject	OpenCmsCore.initCmsObjectFromSession(javax.servlet.http.HttpServletRequest req) Initializes a new cms object from the session data of the request.
protected CmsObject	A_CmsAuthorizationHandler.registerSession(javax.servlet.http.HttpServletRequest request, CmsObject cms) Registers the current session with OpenCms.
protected CmsObject	OpenCmsCore.updateContext(javax.servlet.http.HttpServletRequest request, CmsObject cms) This method updates the request context information.

Methods in org.opencms.main with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsSystemInfo.getConfigFilePath(CmsObject cms, java.lang.String configFile) Returns the path to a configuration file.
protected CmsObject	OpenCmsCore.initCmsObject(CmsObject cms) Returns an independent copy of the provided CmsObject.
static CmsObject	OpenCms.initCmsObject(CmsObject cms) Returns an independent copy of the provided CmsObject.
protected CmsObject	OpenCmsCore.initCmsObject(CmsObject adminCms, CmsContextInfo contextInfo) Returns an initialized CmsObject with the user and context initialized as provided.
static CmsObject	OpenCms.initCmsObject(CmsObject adminCms, CmsContextInfo contextInfo) Returns an initialized CmsObject with the user and context initialized as provided.
protected CmsResource	OpenCmsCore.initResource(CmsObject cms, java.lang.String resourceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Reads the requested resource from the OpenCms VFS, in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.
static CmsResource	OpenCms.initResource(CmsObject cms, java.lang.String resourceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Reads the requested resource from the OpenCms VFS, and in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.
CmsResource	CmsPermalinkResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
CmsResource	I_CmsResourceInit.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Possibility to modify or change the CmsFile with the CmsObject.
CmsResource	CmsAliasResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
void	I_CmsShellCommands.initShellCmsObject(CmsObject cms, CmsShell shell) Provides access to the shell CmsObject and the shell itself.
void	CmsSessionManager.killSession(CmsObject cms, CmsUser user) Kills all sessions for the given user.
void	CmsSessionManager.killSession(CmsObject cms, CmsUUID sessionid) Destroys a session given the session id.
protected CmsObject	A_CmsAuthorizationHandler.registerSession(javax.servlet.http.HttpServletRequest request, CmsObject cms) Registers the current session with OpenCms.
void	CmsSessionManager.sendBroadcast(CmsObject cms, java.lang.String message) Sends a broadcast to all sessions of all currently authenticated users.
void	CmsSessionManager.sendBroadcast(CmsObject cms, java.lang.String message, boolean repeat) Sends a broadcast to all sessions of all currently authenticated users.
void	CmsSessionManager.sendBroadcast(CmsObject cms, java.lang.String message, java.lang.String sessionId) Sends a broadcast to the specified user session.
void	CmsSessionManager.sendBroadcast(CmsObject cms, java.lang.String message, java.lang.String sessionId, boolean repeat) Sends a broadcast to the specified user session.
void	CmsUIServlet.setCms(CmsObject cms) Sets the current cms context.
java.lang.String	CmsSessionManager.switchUser(CmsObject cms, javax.servlet.http.HttpServletRequest req, CmsUser user) Switches the current user to the given user.
java.lang.String	CmsSessionManager.switchUserFromSession(CmsObject cms, javax.servlet.http.HttpServletRequest req, CmsUser user, CmsSessionInfo sessionInfo) Switches the current user to the given user.
protected CmsObject	OpenCmsCore.updateContext(javax.servlet.http.HttpServletRequest request, CmsObject cms) This method updates the request context information.
void	CmsSessionManager.updateSessionInfo(CmsObject cms, javax.servlet.http.HttpServletRequest req) Updates the the OpenCms session data used for quick authentication of users.
void	CmsSessionManager.updateSessionInfo(CmsObject cms, javax.servlet.http.HttpSession session) Updates the the OpenCms session data used for quick authentication of users.
void	CmsSessionManager.updateSessionInfos(CmsObject cms) Updates all session info objects, so that invalid projects are replaced by the Online project.

Constructors in org.opencms.main with parameters of type CmsObject

Constructor and Description
CmsShell(CmsObject cms, java.lang.String prompt, I_CmsShellCommands additionalShellCommands, java.io.PrintStream out, java.io.PrintStream err) Creates a new CmsShell.

Uses of CmsObject in org.opencms.module

Methods in org.opencms.module that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsModuleImportData.getCms() Gets the CMS object.

Methods in org.opencms.module with parameters of type CmsObject

Modifier and Type	Method and Description
static void	CmsModule.addCalculatedModuleResources(java.util.List<CmsResource> result, CmsObject cms, java.util.List<CmsResource> moduleResources, java.util.List<java.lang.String> excludeResources) Determines the resources that are: accessible with the provided CmsObject, part of the moduleResources (or in a folder of these resources) and not contained in excludedResources (or a folder of these resources).
void	CmsModuleManager.addModule(CmsObject cms, CmsModule module) Adds a new module to the module manager.
static java.util.List<java.lang.String>	CmsModule.calculateModuleResourceNames(CmsObject cms, CmsModule module) Calculates the resources belonging to the module, taking excluded resources and readability of resources into account, and returns site paths of the module resources.
static java.util.List<CmsResource>	CmsModule.calculateModuleResources(CmsObject cms, CmsModule module) Calculates and returns the resources belonging to the module, taking excluded resources and readability of resources into account.
void	CmsModule.checkResources(CmsObject cms) Checks if all resources of the module are present.
boolean	CmsModuleImportData.checkUpdatable(CmsObject cms) Checks if the installed module is updatable with the version from the import zip file.
java.lang.Object	CmsResourceImportData.computeRootPath(CmsObject cms) Computes the root path.
static java.util.Optional<CmsModuleUpdater>	CmsModuleUpdater.create(CmsObject cms, java.lang.String importFile, I_CmsReport report) Tries to create a new updater instance.
protected CmsProject	CmsModuleUpdater.createAndSetModuleImportProject(CmsObject cms, CmsModule module) Creates the project used to import module resources and sets it on the CmsObject.
protected void	CmsModuleUpdater.deleteConflictingResources(CmsObject cms, CmsModule module, java.util.Map<CmsUUID,CmsUUID> conflictingIds) Deletes and publishes resources with ID conflicts.
void	CmsModuleManager.deleteModule(CmsObject cms, java.lang.String moduleName, boolean replace, boolean preserveLibs, I_CmsReport report) Deletes a module from the configuration.
void	CmsModuleManager.deleteModule(CmsObject cms, java.lang.String moduleName, boolean replace, I_CmsReport report) Deletes a module from the configuration.
void	CmsModuleImportExportHandler.exportData(CmsObject cms, I_CmsReport report)
static CmsModuleImportExportHandler	CmsModuleImportExportHandler.getExportHandler(CmsObject cms, CmsModule module, java.lang.String handlerDescription) Gets the module export handler containing all resources used in the module export.
void	CmsModuleImportExportHandler.importData(CmsObject cms, I_CmsReport report)
void	CmsModuleImportExportHandler.importData(CmsObject cms, java.lang.String importFile, java.lang.String importPath, I_CmsReport report) Deprecated. use CmsModuleImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	CmsModuleUpdater.importRelations(CmsObject cms) Update relations for all imported resources.
void	CmsModuleImportExportRepository.initialize(CmsObject adminCms) Initializes the CMS context.
protected void	CmsModule.initialize(CmsObject cms) Initializes this module, also freezing the module configuration.
void	CmsModuleManager.initialize(CmsObject cms, CmsConfigurationManager configurationManager) Initializes all module instance classes managed in this module manager.
void	A_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)
void	I_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module) Will be called by the OpenCms system during server startup.
protected void	CmsModuleUpdater.parseLinks(CmsObject cms) Parses links for XMLContents etc.
protected void	CmsModuleUpdater.processDeletions(CmsObject cms, java.util.List<CmsResource> toDelete) Handles the file deletions.
protected void	CmsModuleUpdater.processImportResource(CmsObject cms, CmsResourceImportData resData, int index) Processes single resource from module import data.
void	A_CmsModuleAction.publishProject(CmsObject cms, CmsPublishList publishList, int publishTag, I_CmsReport report)
void	I_CmsModuleAction.publishProject(CmsObject cms, CmsPublishList publishList, int publishTag, I_CmsReport report) Will be called during a the publish process after the resources have been published, but before the publish event is fired.
static CmsModuleImportData	CmsModuleUpdater.readModuleData(CmsObject cms, java.lang.String importFile, I_CmsReport report) Reads the module data from an import zip file.
CmsReplaceModuleInfo	CmsModuleManager.replaceModule(CmsObject cms, java.lang.String importFile, I_CmsReport report) Replaces an existing module with the one read from an import ZIP file.
protected void	CmsModuleUpdater.runImportScript(CmsObject cms, CmsModule module) Runs the module import script.
void	CmsModuleImportData.setCms(CmsObject cms) Sets the CMS object.
boolean	CmsModule.shouldIncrementVersionBasedOnResources(CmsObject cms) Determines if the version should be incremented based on the module resources' modification dates.
boolean	CmsModuleUpdater.updateAcls(CmsObject cms, CmsResourceImportData resData, CmsResource resource) Updates the access control list fr a resource.
void	CmsModuleManager.updateModule(CmsObject cms, CmsModule module) Updates a already configured module with new values.

Uses of CmsObject in org.opencms.monitor

Methods in org.opencms.monitor with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsMemoryMonitor.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)

Uses of CmsObject in org.opencms.newsletter

Methods in org.opencms.newsletter with parameters of type CmsObject

Modifier and Type	Method and Description
void	I_CmsNewsletter.addAttachment(CmsObject cms, CmsResource resource) Adds a OpenCms resource as an attachment to the newsletter.
void	CmsNewsletter.addAttachment(CmsObject cms, CmsResource resource)
void	CmsNewsletterDistributor.distribute(CmsObject cms, java.util.List<I_CmsNewsletterRecipient> recipients, I_CmsNewsletter newsletter) Sends a I_CmsNewsletter to a list of I_CmsNewsletterRecipient objects.
org.apache.commons.mail.Email	I_CmsNewsletter.getEmail(CmsObject cms, I_CmsNewsletterRecipient recipient) Returns the newsletter as an e-mail to be sent.
org.apache.commons.mail.Email	CmsNewsletter.getEmail(CmsObject cms, I_CmsNewsletterRecipient recipient) Returns the e-mail for the newsletter.

Uses of CmsObject in org.opencms.notification

Fields in org.opencms.notification declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsNotification.m_cms The CmsObject.

Methods in org.opencms.notification that return CmsObject

Modifier and Type	Method and Description
CmsObject	A_CmsNotification.getCmsObject() Returns the CmsObject.

Methods in org.opencms.notification with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsContentNotificationJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)

Constructors in org.opencms.notification with parameters of type CmsObject

Constructor and Description
A_CmsNotification(CmsObject cms, CmsUser receiver) Creates a new A_CmsNotification.
CmsNotificationCandidates(CmsObject cms) Collects all resources that will expire in short time, or will become valid, or are not modified since a long time.
CmsNotificationMacroResolver(CmsObject cms, CmsUser receiver) public constructor.
CmsPublishNotification(CmsObject cms, CmsUser receiver, I_CmsReport report) Creates a new CmsPublishNotification.

Uses of CmsObject in org.opencms.pdftools

Methods in org.opencms.pdftools with parameters of type CmsObject

Modifier and Type	Method and Description
byte[]	CmsPdfConverter.convertXhtmlToPdf(CmsObject cms, byte[] xhtmlData, java.lang.String uri) Converts XHTML data to a PDF document.
static byte[]	CmsPdfFormatterUtils.executeJsp(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, CmsResource jsp, CmsResource content) Executes a JSP with a given content as input and returns the output of the JSP.
protected void	CmsPdfResourceHandler.handlePdfLink(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String uri) Handles a link for generating a PDF.
CmsResource	CmsPdfResourceHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Constructors in org.opencms.pdftools with parameters of type CmsObject

Constructor and Description
CmsPdfLink(CmsObject cms, CmsResource formatter, CmsResource content) Creates a new PDF link object based on the formatter and content resources and the locale of the current CMS context.
CmsPdfLink(CmsObject cms, java.lang.String link) Creates a PDF link object by parsing it from a link string.
CmsPdfThumbnailLink(CmsObject cms, CmsResource pdfResource, int width, int height, java.lang.String format) Creates a new thumbnail link for the given resource and options.
CmsPdfThumbnailLink(CmsObject cms, java.lang.String link, java.lang.String options) Parses a thumbnail link object from the given link path and options.
CmsPdfUserAgent(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.publish

Methods in org.opencms.publish that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsPublishJobInfoBean.getCmsObject() Returns the cms object, will be set to null after publishing.

Methods in org.opencms.publish with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsPublishManager.abortPublishJob(CmsObject cms, CmsPublishJobEnqueued publishJob, boolean removeJob) Aborts the given publish job.
void	CmsPublishEngine.enqueuePublishJob(CmsObject cms, CmsPublishList publishList, I_CmsReport report) Enqueues a new publish job with the given information in publish queue.
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms) Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published.
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, CmsResource directPublishResource, boolean directPublishSiblings) Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a single resource.
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, java.util.List<CmsResource> directPublishResources, boolean directPublishSiblings) Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a List of resources.
CmsPublishList	CmsPublishManager.getPublishList(CmsObject cms, java.util.List<CmsResource> directPublishResources, boolean directPublishSiblings, boolean publishSubResources) Returns a publish list with all new/changed/deleted resources of the current (offline) project that actually get published for a direct publish of a List of resources.
CmsPublishList	CmsPublishManager.getPublishListAll(CmsObject cms, java.util.List<CmsResource> directPublishResources, boolean directPublishSiblings, boolean isUserPublishList) Returns a publish list with all the given resources, filtered only by state.
CmsPublishList	CmsPublishManager.getRelatedResourcesToPublish(CmsObject cms, CmsPublishList publishList) Returns a new publish list that contains the unpublished resources related to all resources in the given publish list, the related resources exclude all resources in the given publish list and also locked (by other users) resources.
java.lang.String	CmsPublishJobBase.getUserName(CmsObject cms) Returns the name of the user who initialized this publish job.
java.util.List<CmsResource>	CmsPublishManager.getUsersPubList(CmsObject cms) Returns the current user's publish list.
void	CmsPublishManager.initialize(CmsObject cms) Initializes the publish manager and the publish engine finally.
protected void	CmsPublishQueue.initialize(CmsObject adminCms, boolean revive) Initializes the internal FIFO queue with publish jobs from the database.
protected void	CmsPublishEngine.initialize(CmsObject adminCms, boolean publishQueuePersistance, int publishQueueShutdowntime) Initializes the publish engine.
CmsPublishList	CmsPublishManager.mergePublishLists(CmsObject cms, CmsPublishList pubList1, CmsPublishList pubList2) Returns a new publish list that contains all resources of both given publish lists.
CmsUUID	CmsPublishManager.publishProject(CmsObject cms) Publishes the current project, printing messages to a shell report.
CmsUUID	CmsPublishManager.publishProject(CmsObject cms, I_CmsReport report) Publishes the current project.
CmsUUID	CmsPublishManager.publishProject(CmsObject cms, I_CmsReport report, CmsPublishList publishList) Publishes the resources of a specified publish list.
CmsUUID	CmsPublishManager.publishProject(CmsObject cms, I_CmsReport report, CmsResource directPublishResource, boolean directPublishSiblings) Direct publishes a specified resource.
CmsUUID	CmsPublishManager.publishResource(CmsObject cms, java.lang.String resourcename) Publishes a single resource, printing messages to a shell report.
CmsUUID	CmsPublishManager.publishResource(CmsObject cms, java.lang.String resourcename, boolean publishSiblings, I_CmsReport report) Publishes a single resource.
void	CmsPublishManager.removeResourceFromUsersPubList(CmsObject cms, java.util.Collection<CmsUUID> structureIds) Removes the given resource to the given user's publish list.
void	CmsPublishJobInfoBean.revive(CmsObject adminCms, CmsPublishList publishList) Revives this publish job.
java.util.Map<java.lang.String,java.util.List<CmsRelation>>	CmsPublishManager.validateRelations(CmsObject cms, CmsPublishList publishList, I_CmsReport report) Validates the relations for the given resources.

Constructors in org.opencms.publish with parameters of type CmsObject

Constructor and Description
CmsPublishJobInfoBean(CmsObject cms, CmsPublishList publishList, I_CmsReport report) The Default constructor.

Uses of CmsObject in org.opencms.relations

Methods in org.opencms.relations with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsCategoryService.addResourceToCategory(CmsObject cms, java.lang.String resourceName, CmsCategory category) Adds a resource identified by the given resource name to the given category.
void	CmsCategoryService.addResourceToCategory(CmsObject cms, java.lang.String resourceName, java.lang.String categoryPath) Adds a resource identified by the given resource name to the category identified by the given category path.
void	CmsLink.checkConsistency(CmsObject cms) Checks and updates the structure id or the path of the target.
static boolean	CmsExternalLinksValidator.checkUrl(CmsObject cms, java.lang.String check) Checks if the given url is valid.
void	CmsCategoryService.clearCategoriesForResource(CmsObject cms, java.lang.String resourcePath) Removes the given resource from all categories.
void	CmsCategoryService.copyCategories(CmsObject cms, CmsResource fromResource, java.lang.String toResourceSitePath) Adds all categories from one resource to another, skipping categories that are not available for the resource copied to.
CmsCategory	CmsCategoryService.createCategory(CmsObject cms, CmsCategory parent, java.lang.String name, java.lang.String title, java.lang.String description, java.lang.String referencePath) Creates a new category.
void	CmsCategoryService.deleteCategory(CmsObject cms, java.lang.String categoryPath, java.lang.String referencePath) Deletes the category identified by the given path.
CmsCategory	CmsCategoryService.getCategory(CmsObject cms, CmsResource resource) Creates a category from the given resource.
CmsCategory	CmsCategoryService.getCategory(CmsObject cms, java.lang.String categoryRootPath) Creates a category from the given category root path.
java.util.List<java.lang.String>	CmsCategoryService.getCategoryRepositories(CmsObject cms, java.lang.String referencePath) Returns all category repositories for the given reference path.
java.lang.String	CmsLink.getLink(CmsObject cms) Returns the processed link.
java.lang.String	CmsLink.getLink(CmsObject cms, boolean processEditorLinks) Deprecated. use CmsLink.getLink(CmsObject) instead, the process editor option is set using the OpenCms request context attributes
java.lang.String	CmsCategoryService.getRepositoryBaseFolderName(CmsObject cms) Returns the category repositories base folder name.
java.lang.String	CmsLink.getSitePath(CmsObject cms) Returns the path of the link target relative to the current site.
CmsResource	CmsRelation.getSource(CmsObject cms, CmsResourceFilter filter) Returns the source resource when possible to read with the given filter.
CmsResource	CmsRelation.getTarget(CmsObject cms, CmsResourceFilter filter) Returns the target resource when possible to read with the given filter.
java.lang.String	CmsInternalRelationsValidationJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsExternalLinksValidator.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters) This method is called by the cron scheduler.
java.util.List<CmsCategory>	CmsCategoryService.localizeCategories(CmsObject cms, java.util.List<CmsCategory> categories, java.util.Locale locale) Localizes a list of categories by reading locale-specific properties for their title and description, if possible.
CmsCategory	CmsCategoryService.localizeCategory(CmsObject cms, CmsCategory category, java.util.Locale locale) Localizes a single category by reading its locale-specific properties for title and description, if possible.
void	CmsCategoryService.moveCategory(CmsObject cms, java.lang.String oldCatPath, java.lang.String newCatPath, java.lang.String referencePath) Renames/Moves a category from the old path to the new one.
java.util.List<CmsLink>	I_CmsLinkParseable.parseLinks(CmsObject cms, CmsFile file) Returns a list of all links from the specified file.
java.util.List<CmsCategory>	CmsCategoryService.readCategories(CmsObject cms, java.lang.String parentCategoryPath, boolean includeSubCats, java.lang.String referencePath) Returns all categories given some search parameters.
java.util.List<CmsCategory>	CmsCategoryService.readCategoriesForRepositories(CmsObject cms, java.lang.String parentCategoryPath, boolean includeSubCats, java.util.List<java.lang.String> repositories) Returns all categories given some search parameters.
java.util.List<CmsCategory>	CmsCategoryService.readCategoriesForRepositories(CmsObject cms, java.lang.String parentCategoryPath, boolean includeSubCats, java.util.List<java.lang.String> repositories, boolean includeRepositories) Returns all categories given some search parameters.
CmsCategory	CmsCategoryService.readCategory(CmsObject cms, java.lang.String categoryPath, java.lang.String referencePath) Reads all categories identified by the given category path for the given reference path.
java.util.List<CmsResource>	CmsCategoryService.readCategoryResources(CmsObject cms, java.lang.String categoryPath, boolean recursive, java.lang.String referencePath) Reads the resources for a category identified by the given category path.
java.util.List<CmsResource>	CmsCategoryService.readCategoryResources(CmsObject cms, java.lang.String categoryPath, boolean recursive, java.lang.String referencePath, CmsResourceFilter resFilter) Reads the resources for a category identified by the given category path.
java.util.List<CmsCategory>	CmsCategoryService.readResourceCategories(CmsObject cms, CmsResource resource) Reads the categories for a resource.
java.util.List<CmsCategory>	CmsCategoryService.readResourceCategories(CmsObject cms, java.lang.String resourceName) Reads the categories for a resource identified by the given resource name.
void	CmsCategoryService.removeResourceFromCategory(CmsObject cms, java.lang.String resourceName, CmsCategory category) Removes a resource identified by the given resource name from the given category.
void	CmsCategoryService.removeResourceFromCategory(CmsObject cms, java.lang.String resourceName, java.lang.String categoryPath) Removes a resource identified by the given resource name from the category identified by the given category path.
void	CmsCategoryService.repairRelations(CmsObject cms, CmsResource resource) Repairs broken category relations.
void	CmsCategoryService.repairRelations(CmsObject cms, java.lang.String resourceName) Repairs broken category relations.
void	CmsExternalLinksValidator.validateLinks(CmsObject cms) Validate all links.

Constructors in org.opencms.relations with parameters of type CmsObject

Constructor and Description
CmsInternalLinksValidator(CmsObject cms, java.util.List<java.lang.String> resourceNames) Creates a new helper object.
CmsRelationDeleteValidator(CmsObject cms, java.util.List<java.lang.String> resourceNames, boolean includeSiblings) Creates a new helper object.
CmsRelationPublishValidator(CmsObject cms, CmsPublishList publishList) Creates a new helper object.

Uses of CmsObject in org.opencms.report

Methods in org.opencms.report that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	A_CmsReportThread.getCms() Returns the OpenCms context object this Thread is initialized with.

Constructors in org.opencms.report with parameters of type CmsObject

Constructor and Description
A_CmsReportThread(CmsObject cms, java.lang.String name) Constructs a new report Thread with the given name.

Uses of CmsObject in org.opencms.repository

Methods in org.opencms.repository with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsRepositoryManager.initializeCms(CmsObject cms) Initializes repositories using an admin CMS object.
void	I_CmsRepository.initializeCms(CmsObject cms) Initializes this repository with an admin CMS object.
void	CmsRepository.initializeCms(CmsObject cms)

Uses of CmsObject in org.opencms.scheduler

Methods in org.opencms.scheduler with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsScheduleManager.initialize(CmsObject adminCms) Initializes the OpenCms scheduler.
java.lang.String	I_CmsScheduledJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters) This method will be called when this scheduled job is executed.
void	CmsScheduleManager.scheduleJob(CmsObject cms, CmsScheduledJobInfo jobInfo) Adds a new job to the scheduler.
CmsScheduledJobInfo	CmsScheduleManager.unscheduleJob(CmsObject cms, java.lang.String jobId) Removes a currently scheduled job from the scheduler.

Uses of CmsObject in org.opencms.scheduler.jobs

Methods in org.opencms.scheduler.jobs with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsImageCacheCleanupJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsRemoveOldDbLogEntriesJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsSearchIndexOptimizeJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsUnsubscribeDeletedResourcesJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsDeleteExpiredResourcesJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsPublishScheduledJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsStaticExportJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsHistoryClearJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsCreateImageSizeJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
java.lang.String	CmsPublishJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)

Uses of CmsObject in org.opencms.search

Fields in org.opencms.search declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsSearchManager.m_adminCms The administrator OpenCms user context to access OpenCms VFS resources.
protected CmsObject	CmsSearch.m_cms The cms object.
protected CmsObject	CmsVfsIndexer.m_cms The OpenCms user context to use when reading resources from the VFS during indexing.

Methods in org.opencms.search that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsVfsIndexer.getCms() Returns the OpenCms user context used by this indexer.

Methods in org.opencms.search with parameters of type CmsObject

Modifier and Type	Method and Description
protected org.apache.lucene.search.BooleanQuery.Builder	CmsSearchIndex.appendCategoryFilter(CmsObject cms, org.apache.lucene.search.BooleanQuery.Builder filter, java.util.List<java.lang.String> categories) Appends the a category filter to the given filter clause that matches all given categories.
protected org.apache.lucene.search.BooleanQuery.Builder	CmsSearchIndex.appendPathFilter(CmsObject cms, org.apache.lucene.search.BooleanQuery.Builder filter, java.util.List<java.lang.String> roots) Appends the a VFS path filter to the given filter clause that matches all given root paths.
protected org.apache.lucene.search.BooleanQuery.Builder	CmsSearchIndex.appendResourceTypeFilter(CmsObject cms, org.apache.lucene.search.BooleanQuery.Builder filter, java.util.List<java.lang.String> resourceTypes) Appends the a resource type filter to the given filter clause that matches all given resource types.
boolean	I_CmsSearchIndex.checkConfiguration(CmsObject cms) Checks is this index has been configured correctly.
boolean	A_CmsSearchIndex.checkConfiguration(CmsObject cms)
static java.util.List<java.lang.String>	CmsSearchUtil.computeScopeFolders(CmsObject cms, CmsGallerySearchParameters params) Computes the search root folders for the given search parameters based on the search scope.
protected I_CmsSearchDocument	CmsIndexingThread.createIndexDocument(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Creates the search index document.
boolean	I_CmsSearchIndex.excludeFromIndex(CmsObject cms, CmsResource resource) Checks if the provided resource should be excluded from this search index.
boolean	A_CmsSearchIndex.excludeFromIndex(CmsObject cms, CmsResource resource) Checks if the provided resource should be excluded from this search index.
protected java.util.List<CmsPublishedResource>	CmsSearchManager.findRelatedContainerPages(CmsObject adminCms, java.util.List<CmsPublishedResource> updateResources) Collects the related containerpages to the resources that have been published.
static CmsSolrIndex	CmsSearchManager.getIndexSolr(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> params) Returns the Solr index configured with the parameters name.
java.util.Locale	I_CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, java.util.List<java.util.Locale> availableLocales) Returns the language locale for the given resource in this index.
java.util.Locale	CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, java.util.List<java.util.Locale> availableLocales) Returns the language locale for the given resource in this index.
java.util.Locale	A_CmsSearchIndex.getLocaleForResource(CmsObject cms, CmsResource resource, java.util.List<java.util.Locale> availableLocales) Returns the language locale for the given resource in this index.
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc) Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.
protected CmsResource	CmsSearchIndex.getResource(CmsObject cms, I_CmsSearchDocument doc, CmsResourceFilter filter) Checks if the OpenCms resource referenced by the result document can be read by the user of the given OpenCms context.
protected boolean	CmsSearchIndex.hasReadPermission(CmsObject cms, I_CmsSearchDocument doc) Checks if the OpenCms resource referenced by the result document can be read be the user of the given OpenCms context.
void	CmsSearch.init(CmsObject cms) Initializes the bean with the cms object.
void	CmsSearchManager.initialize(CmsObject cms) Initializes the search manager.
void	CmsSearchManager.initSpellcheckIndex(CmsObject adminCms) Initializes the spell check index.
java.lang.String	CmsSearchManager.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters) Updates the indexes from as a scheduled job.
I_CmsIndexer	CmsVfsIndexer.newInstance(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index)
I_CmsIndexer	I_CmsIndexer.newInstance(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index) Creates and initializes a new instance of this indexer implementation.
CmsSearchResultList	CmsSearchIndex.search(CmsObject cms, CmsSearchParameters params) Performs a search on the index within the given fields.
protected void	CmsSearchManager.updateAllIndexes(CmsObject adminCms, CmsUUID publishHistoryId, I_CmsReport report) Incrementally updates all indexes that have their rebuild mode set to "auto" after resources have been published.
protected void	CmsSearchManager.updateIndexCompletely(CmsObject cms, I_CmsSearchIndex index, I_CmsReport report) The method updates all OpenCms documents that are indexed.
protected void	CmsSearchManager.updateIndexIncremental(CmsObject cms, I_CmsSearchIndex index, I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Incrementally updates the given index.

Constructors in org.opencms.search with parameters of type CmsObject

Constructor and Description
CmsIndexingThread(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Create a new indexing thread.

Uses of CmsObject in org.opencms.search.documents

Methods in org.opencms.search.documents with parameters of type CmsObject

Modifier and Type	Method and Description
I_CmsSearchDocument	A_CmsVfsDocument.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	I_CmsDocumentFactory.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Creates the Lucene Document for the given VFS resource and the given search index.
I_CmsSearchDocument	CmsDocumentContainerPage.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	CmsDocumentXmlContent.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
I_CmsExtractionResult	CmsDocumentPdf.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing Adobe PDF data.
I_CmsExtractionResult	CmsDocumentMsOfficeOOXML.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentPlainText.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing plain text data.
I_CmsExtractionResult	CmsDocumentHtml.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given VFS resource containing HTML data.
I_CmsExtractionResult	CmsDocumentGeneric.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Just returns an empty extraction result since the content can't be extracted form a generic resource.
I_CmsExtractionResult	I_CmsSearchExtractor.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Extracts the content of a given index resource according to the resource file type and the configuration of the given index.
I_CmsExtractionResult	CmsDocumentRtf.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing RTF data.
I_CmsExtractionResult	CmsDocumentXmlPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource of type CmsResourceTypeXmlPage.
I_CmsExtractionResult	CmsDocumentMsOfficeOLE2.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentOpenOffice.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given VFS resource of type CmsResourceTypeXmlContent.
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsPublishedResource pubRes) Loads or creates a dependency object for the given parameters.
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsResource res) Loads or creates a dependency object for the given parameters.
static CmsDocumentDependency	CmsDocumentDependency.load(CmsObject cms, CmsResource res, java.util.List<CmsResource> resources) Loads or creates a dependency object for the given parameters.
void	CmsDocumentDependency.readDependencies(CmsObject cms) Reads all dependencies that exist for this main resource in the OpenCms VFS.
void	CmsDocumentDependency.readDependencies(CmsObject cms, java.util.List<CmsResource> folderContent) Reads all dependencies that exist for this main resource in provided list of resources.
protected CmsFile	A_CmsVfsDocument.readFile(CmsObject cms, CmsResource resource) Upgrades the given resource to a CmsFile with content.
protected static void	CmsDocumentDependency.removeFromContext(CmsObject cms, CmsPublishedResource pubRes) Removes the dependency object for a published resource from the OpenCms runtime context.
void	CmsDocumentDependency.storeInContext(CmsObject cms) Stores this dependency object for a published resource in the OpenCms runtime context.
java.lang.String	CmsDocumentDependency.toDependencyString(CmsObject cms) Creates the String representation of this dependency object.
JSONObject	CmsDocumentDependency.toJSON(CmsObject cms, boolean includeLang) Returns a JSON object describing this dependency document.

Uses of CmsObject in org.opencms.search.fields

Methods in org.opencms.search.fields with parameters of type CmsObject

Modifier and Type	Method and Description
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Overriding this method allows to append some 'extra' values/fields to a document without overriding the CmsSearchFieldConfiguration.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.I_CmsSearchIndex, org.opencms.search.extractors.I_CmsExtractionResult) method itself.
protected I_CmsSearchDocument	CmsSearchFieldConfigurationOldCategories.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendCategories(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by resource category information based on properties.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendContentBlob(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the extracted content blob.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for date of creation, content and last modification.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField field, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the mappings for the given field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the configured field mappings.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendFileSize(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "size" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by the "res_locales" field.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendPath(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by fields for VFS path lookup.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Appends all direct properties, that are not empty or white space only to the document.
protected I_CmsSearchDocument	CmsSearchFieldConfiguration.appendType(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Extends the given document by a field that contains the resource type name.
I_CmsSearchDocument	I_CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extractionResult) Creates the document to index.
I_CmsSearchDocument	CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extraction) Creates the Lucene Document with this field configuration for the provided VFS resource, search index and content.
java.lang.String	CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
java.lang.String	I_CmsSearchFieldMapping.getStringValue(CmsObject cms, CmsResource res, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched) Returns the String value extracted form the provided data according to the rules of this mapping type.

Uses of CmsObject in org.opencms.search.galleries

Fields in org.opencms.search.galleries declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsGallerySearch.m_cms The OpenCms object used for the search.

Methods in org.opencms.search.galleries with parameters of type CmsObject

Modifier and Type	Method and Description
CmsSolrQuery	CmsGallerySearchParameters.getQuery(CmsObject cms) Returns a CmsSolrQuery representation of this class.
void	CmsGallerySearch.init(CmsObject cms) Initializes the bean with the provided OpenCms context object.
protected void	CmsGallerySearchResult.initializeMissingFieldsFromVfs(CmsObject cms, CmsUUID structureId) Initializes missing fields by reading the information from the VFS.
boolean	CmsGallerySearchResult.isReleaseAndNotExpired(CmsObject cms) Returns if the related resource is released and not expired.
static CmsGallerySearchResult	CmsGallerySearch.searchById(CmsObject cms, CmsUUID structureId, java.util.Locale locale) Searches by structure id.
static CmsGallerySearchResult	CmsGallerySearch.searchByPath(CmsObject cms, java.lang.String rootPath, java.util.Locale locale) Searches by structure id.
void	CmsGallerySearch.setIndexForProject(CmsObject cms) Sets the index name according to the current project.

Constructors in org.opencms.search.galleries with parameters of type CmsObject

Constructor and Description
CmsGalleryNameMacroResolver(CmsObject cms, A_CmsXmlDocument content, java.util.Locale locale) Creates a new instance.
CmsGallerySearchResult(CmsObject cms, CmsResource res) Creates a fake gallery search result by reading the necessary data from a VFS resource.
CmsGallerySearchResult(I_CmsSearchDocument doc, CmsObject cms, int score, java.util.Locale locale) Creates a new gallery search result.

Uses of CmsObject in org.opencms.search.solr

Methods in org.opencms.search.solr with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSolrDocument.addDocumentDependency(CmsObject cms, CmsDocumentDependency resDeps) Adds the given document dependency to this document.
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendAdditionalValuesToDcoument(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendDates(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMapping(I_CmsSearchDocument document, CmsSearchField sfield, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappings(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extractionResult, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendFieldMappingsFromElementsOnThePage(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, java.util.List<java.lang.String> systemFields) Adds search fields from elements on a container page to a container page's document.
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendLocales(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
protected I_CmsSearchDocument	CmsSolrFieldConfiguration.appendProperties(I_CmsSearchDocument document, CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction, java.util.List<CmsProperty> properties, java.util.List<CmsProperty> propertiesSearched)
static void	CmsSolrDocumentXmlContent.collectSchemaXpathsForSimpleValues(CmsObject cms, CmsXmlContentDefinition def, java.lang.String path, java.util.Set<java.lang.String> result) Collects a list of all possible XPaths for a content definition.
boolean	CmsSolrIndex.excludeFromIndex(CmsObject cms, CmsResource resource)
I_CmsExtractionResult	CmsSolrDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
I_CmsExtractionResult	CmsSolrDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsSolrDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, java.util.Locale forceLocale) Extracts the content of a given index resource according to the resource file type and the configuration of the given index.
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Extracts the content of a single XML content resource.
static CmsExtractionResult	CmsSolrDocumentXmlContent.extractXmlContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, java.util.Locale forceLocale) Extracts the content of a single XML content resource.
CmsGallerySearchResultList	CmsSolrIndex.gallerySearch(CmsObject cms, CmsGallerySearchParameters params) Performs a search with according to the gallery search parameters.
protected java.util.List<java.util.Locale>	CmsSolrFieldConfiguration.getContentLocales(CmsObject cms, CmsResource resource, I_CmsExtractionResult extraction) Retrieves the locales for an content, that is whether an XML content nor an XML page.
java.util.Locale	CmsSolrIndex.getLocaleForResource(CmsObject cms, CmsResource resource, java.util.List<java.util.Locale> availableLocales) Returns the language locale for the given resource in this index.
static java.lang.String	CmsSolrIndex.getType(CmsObject cms, java.lang.String rootPath) Returns the resource type for the given root path.
protected java.util.Set<CmsSearchField>	CmsSolrFieldConfiguration.getXSDMappings(CmsObject cms, CmsResource resource) Returns the search field mappings declared within the XSD.
protected java.util.Set<CmsSearchField>	CmsSolrFieldConfiguration.getXSDMappingsForPage(CmsObject cms, CmsResource resource) Returns the search field mappings declared within the XSD that should be applied to the container page.
protected boolean	CmsSolrIndex.hasPermissions(CmsObject cms, CmsSolrDocument doc, CmsResourceFilter filter) Check, if the current user has permissions on the document's resource.
org.apache.solr.common.SolrDocument	CmsSolrLinkProcessor.process(CmsObject cms, CmsResource resource, org.apache.solr.common.SolrInputDocument document)
org.apache.solr.common.SolrDocument	I_CmsSolrPostSearchProcessor.process(CmsObject searchCms, CmsResource resource, org.apache.solr.common.SolrInputDocument document) Performs the post processing.
CmsSearchResultList	CmsSolrIndex.search(CmsObject cms, CmsSearchParameters params) Deprecated. Use CmsSolrIndex.search(CmsObject, SolrQuery) or CmsSolrIndex.search(CmsObject, String) instead
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query) Default search method.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows) Performs a search.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, CmsResourceFilter filter) Like CmsSolrIndex.search(CmsObject, CmsSolrQuery, boolean), but additionally a resource filter can be specified.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, javax.servlet.ServletResponse response, boolean ignoreSearchExclude, CmsResourceFilter filter) Performs the actual search.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows, javax.servlet.ServletResponse response, boolean ignoreSearchExclude, CmsResourceFilter filter, int maxNumResults) Performs the actual search.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, org.apache.solr.client.solrj.SolrQuery query) Default search method.
CmsSolrResultList	CmsSolrIndex.search(CmsObject cms, java.lang.String solrQuery) Performs a search.
void	CmsSolrIndex.select(javax.servlet.ServletResponse response, CmsObject cms, CmsSolrQuery query, boolean ignoreMaxRows) Writes the response into the writer.
void	CmsSolrIndex.spellCheck(javax.servlet.ServletResponse res, CmsObject cms, CmsSolrQuery q) Executes a spell checking Solr query and returns the Solr query response.

Constructors in org.opencms.search.solr with parameters of type CmsObject

Constructor and Description
CmsSolrQuery(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> queryParams) Public constructor.

Uses of CmsObject in org.opencms.search.solr.spellchecking

Methods in org.opencms.search.solr.spellchecking with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSolrSpellchecker.getSpellcheckingResult(javax.servlet.http.HttpServletResponse res, javax.servlet.ServletRequest servletRequest, CmsObject cms) Performs spellchecking using Solr and returns the spellchecking results using JSON.
void	CmsSolrSpellchecker.parseAndAddDictionaries(CmsObject cms) Parses and adds dictionaries to the Solr index.
static void	CmsSpellcheckDictionaryIndexer.parseAndAddDictionaries(org.apache.solr.client.solrj.SolrClient client, CmsObject cms) Adds all dictionaries that are available in the default directory.
static void	CmsSpellcheckDictionaryIndexer.parseAndAddZippedDictionaries(org.apache.solr.client.solrj.SolrClient client, CmsObject cms)
static boolean	CmsSpellcheckDictionaryIndexer.updatingIndexNecessesary(CmsObject cms) Checks whether a built of the indices is necessary.

Uses of CmsObject in org.opencms.security

Methods in org.opencms.security that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsDefaultAuthorizationHandler.checkBasicAuthorization(javax.servlet.http.HttpServletRequest req) Checks if the current request contains HTTP basic authentication information in the headers, if so the user is tried to log in with this data, and on success a session is generated.
CmsObject	I_CmsAuthorizationHandler.I_PrivilegedLoginAction.doLogin(javax.servlet.http.HttpServletRequest request, java.lang.String principal) Performs a privileged login action and returns a cms object initialized for the principal.
CmsObject	I_CmsLoginAction.doLogin(java.lang.String principal) Returns a cms object initialized for the passed principal.
CmsObject	I_CmsAuthorizationHandler.I_PrivilegedLoginAction.getCmsObject() Returns the cms object.
CmsObject	I_CmsAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request) Creates a new cms object from the given request object.
CmsObject	CmsDefaultAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request)
CmsObject	CmsPersistentLoginAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request, I_CmsAuthorizationHandler.I_PrivilegedLoginAction loginAction)
CmsObject	I_CmsAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request, I_CmsAuthorizationHandler.I_PrivilegedLoginAction loginAction) Creates a new cms object from the given request object.
CmsObject	CmsDefaultAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request, I_CmsAuthorizationHandler.I_PrivilegedLoginAction loginAction)
CmsObject	I_CmsAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String pwd) Authenticates the current request with additional user information.
CmsObject	CmsDefaultAuthorizationHandler.initCmsObject(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String pwd)
CmsObject	CmsPersistentLoginAuthorizationHandler.initCmsObjectFromToken(javax.servlet.http.HttpServletRequest request, I_CmsAuthorizationHandler.I_PrivilegedLoginAction loginAction) Tries to initialize the CmsObject from a login token given as a cookie in the request.

Methods in org.opencms.security with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsOrgUnitManager.addResourceToOrgUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String resourceName) Adds a resource to the given organizational unit.
void	CmsRoleManager.addUserToRole(CmsObject cms, CmsRole role, java.lang.String username) Adds a user to the given role.
void	CmsRoleManager.checkRole(CmsObject cms, CmsRole role) Checks if the user of this OpenCms context is a member of the given role for the given organizational unit.
void	CmsRoleManager.checkRoleForResource(CmsObject cms, CmsRole role, java.lang.String resourceName) Checks if the user of this OpenCms context is a member of the given role for the given resource.
long	CmsOrgUnitManager.countUsers(CmsObject cms, CmsUserSearchParameters params) Counts the users which fit the given search criteria.
CmsOrganizationalUnit	CmsOrgUnitManager.createOrganizationalUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String description, int flags, java.lang.String resourceName) Creates a new organizational unit.
java.lang.String	CmsPersistentLoginTokenHandler.createToken(CmsObject cms) Generates a new login token for a given user and registers the token in the user's additional info.
void	CmsOrgUnitManager.deleteOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Deletes an organizational unit.
java.util.List<CmsProject>	CmsOrgUnitManager.getAllAccessibleProjects(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all accessible projects of the given organizational unit.
java.util.List<CmsProject>	CmsOrgUnitManager.getAllManageableProjects(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all manageable projects of the given organizational unit.
java.lang.String	CmsRole.getDisplayName(CmsObject cms, java.util.Locale locale) Returns the display name of this role including the organizational unit.
java.lang.String	CmsPrincipal.getDisplayName(CmsObject cms, java.util.Locale locale) Returns the display name of this principal including the organizational unit.
java.lang.String	CmsPrincipal.getDisplayName(CmsObject cms, java.util.Locale locale, I_CmsGroupNameTranslation translation) Returns the translated display name of this principal if it is a group and the display name otherwise.
java.util.List<CmsGroup>	CmsOrgUnitManager.getGroups(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all groups of the given organizational unit.
java.util.List<CmsGroup>	CmsRoleManager.getManageableGroups(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all groups of organizational units for which the current user has the CmsRole.ACCOUNT_MANAGER role.
java.util.List<CmsOrganizationalUnit>	CmsRoleManager.getManageableOrgUnits(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus, boolean includeWebusers) Returns a list of those organizational units whose members can be managed by the current user.
java.util.List<CmsResource>	CmsRoleManager.getManageableResources(CmsObject cms, CmsRole role) Returns all resources of organizational units for which the current user has the given role role.
java.util.List<CmsUser>	CmsRoleManager.getManageableUsers(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all users of organizational units for which the current user has the CmsRole.ACCOUNT_MANAGER role.
java.util.List<CmsUser>	CmsRoleManager.getManageableUsers(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus, boolean includeWebusers) Returns all users of organizational units for which the current user has the CmsRole.ACCOUNT_MANAGER role.
java.util.List<CmsOrganizationalUnit>	CmsOrgUnitManager.getOrganizationalUnits(CmsObject cms, java.lang.String ouFqn, boolean includeChildren) Returns all child organizational units of the given parent organizational unit including hierarchical deeper organization units if needed.
java.util.List<CmsOrganizationalUnit>	CmsRoleManager.getOrgUnitsForRole(CmsObject cms, CmsRole role, boolean includeSubOus) Returns all the organizational units for which the current user has the given role.
java.util.List<CmsResource>	CmsOrgUnitManager.getResourcesForOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Returns all resources of the given organizational unit.
java.util.Set<CmsGroup>	CmsRoleManager.getRoleGroups(CmsObject cms, CmsRole role, boolean directUsersOnly) Returns the groups which constitute a given role, i.e. the set of groups such that a member of any of them has the given role.
java.util.List<CmsRole>	CmsRoleManager.getRoles(CmsObject cms, java.lang.String ouFqn, boolean includeSubOus) Returns all roles, in the given organizational unit.
java.util.List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, CmsUser user, CmsResource resource) Returns all roles the given user has over the given resource.
java.util.List<CmsRole>	CmsRoleManager.getRolesForResource(CmsObject cms, java.lang.String userFqn, java.lang.String resourceName) Returns all roles the given user has over the given resource.
java.util.List<CmsRole>	CmsRoleManager.getRolesOfUser(CmsObject cms, java.lang.String username, java.lang.String ouFqn, boolean includeChildOus, boolean directRolesOnly, boolean recursive) Returns all roles the given user belongs to, in the given organizational unit.
java.util.List<CmsUser>	CmsOrgUnitManager.getUsers(CmsObject cms, java.lang.String ouFqn, boolean recursive) Returns all users of the given organizational unit.
java.util.List<CmsUser>	CmsRoleManager.getUsersOfRole(CmsObject cms, CmsRole role, boolean includeOtherOuUsers, boolean directUsersOnly) Returns all direct users of a given role, in the given organizational unit.
java.util.List<CmsUser>	CmsOrgUnitManager.getUsersWithoutAdditionalInfo(CmsObject cms, java.lang.String ouFqn, boolean recursive) Returns all users of the given organizational unit, without their additional info.
boolean	CmsRoleManager.hasRole(CmsObject cms, CmsRole role) Checks if the given context user has the given role in the given organizational unit.
boolean	CmsRoleManager.hasRole(CmsObject cms, java.lang.String userName, CmsRole role) Checks if the given user has the given role in the given organizational unit.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, CmsResource resource) Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, CmsRole role, java.lang.String resourceName) Checks if the given context user has the given role for the given resource.
boolean	CmsRoleManager.hasRoleForResource(CmsObject cms, java.lang.String userName, CmsRole role, java.lang.String resourceName) Checks if the given context user has the given role for the given resource.
void	CmsOrgUnitManager.initialize(CmsObject cms) Initializes the organizational units.
CmsOrganizationalUnit	CmsOrgUnitManager.readOrganizationalUnit(CmsObject cms, java.lang.String ouFqn) Reads an organizational Unit based on its fully qualified name.
static I_CmsPrincipal	CmsPrincipal.readPrefixedPrincipal(CmsObject cms, java.lang.String name) Utility function to read a prefixed principal from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	CmsPrincipal.readPrincipal(CmsObject cms, CmsUUID id) Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	CmsPrincipal.readPrincipal(CmsObject cms, java.lang.String name) Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	CmsPrincipal.readPrincipal(CmsObject cms, java.lang.String type, java.lang.String name) Utility function to read a principal of the given type from the OpenCms database using the provided OpenCms user context.
static I_CmsPrincipal	CmsPrincipal.readPrincipalIncludingHistory(CmsObject cms, CmsUUID id) Utility function to read a principal by its id from the OpenCms database using the provided OpenCms user context.
void	CmsOrgUnitManager.removeResourceFromOrgUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String resourceName) Removes a resource from the given organizational unit.
void	CmsRoleManager.removeUserFromRole(CmsObject cms, CmsRole role, java.lang.String username) Removes a user from a role, in the given organizational unit.
java.util.List<CmsUser>	CmsOrgUnitManager.searchUsers(CmsObject cms, CmsUserSearchParameters params) Searches users which fit the given search parameters.
static void	CmsPersistentLoginTokenHandler.setAdminCms(CmsObject adminCms) Static method used to give this class access to an admin cms context.
void	I_CmsAuthorizationHandler.I_PrivilegedLoginAction.setCmsObject(CmsObject cms) Used to provide an initial cms object.
void	CmsOrgUnitManager.setUsersOrganizationalUnit(CmsObject cms, java.lang.String ouFqn, java.lang.String userName) Moves an user to the given organizational unit.
void	CmsOrgUnitManager.writeOrganizationalUnit(CmsObject cms, CmsOrganizationalUnit organizationalUnit) Writes an already existing organizational unit.

Constructors in org.opencms.security with parameters of type CmsObject

Constructor and Description
CmsPasswordInfo(CmsObject cms) Use this Constructor if you need to check the old password of the current logged in user.

Uses of CmsObject in org.opencms.site

Methods in org.opencms.site with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSiteManagerImpl.addSite(CmsObject cms, CmsSite site) Adds a site.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableCorruptedSites(CmsObject cms, boolean workplaceMode) Returns all wrong configured sites.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableSites(CmsObject cms, boolean workplaceMode) Returns a list of all sites available (visible) for the current user.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableSites(CmsObject cms, boolean workplaceMode, boolean showShared, java.lang.String ouFqn) Returns a list of all CmsSite instances that are compatible to the given organizational unit.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableSites(CmsObject cms, boolean workplaceMode, boolean showShared, java.lang.String ouFqn, CmsSSLMode filterMode) Returns a list of all CmsSite instances that are compatible to the given organizational unit.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableSites(CmsObject cms, boolean workplaceMode, CmsSSLMode filterMode) Returns a list of all sites available (visible) for the current user.
java.util.List<CmsSite>	CmsSiteManagerImpl.getAvailableSites(CmsObject cms, boolean workplaceMode, java.lang.String ouFqn) Returns a list of all CmsSite instances that are compatible to the given organizational unit.
CmsSite	CmsSiteManagerImpl.getCurrentSite(CmsObject cms) Returns the current site for the provided OpenCms user context object.
java.lang.String	CmsSite.getServerPrefix(CmsObject cms, CmsResource resource) Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.
java.lang.String	CmsSite.getServerPrefix(CmsObject cms, java.lang.String resourceName) Returns the server prefix for the given resource in this site, used to distinguish between secure (https) and non-secure (http) sites.
java.lang.String	CmsSiteManagerImpl.getSiteTitle(CmsObject cms, CmsResource resource) Returns the site title.
void	CmsSiteManagerImpl.initialize(CmsObject cms) Initializes the site manager with the OpenCms system configuration.
boolean	CmsSiteManagerImpl.isMatchingCurrentSite(CmsObject cms, CmsSiteMatcher matcher) Returns true if the given site matcher matches the current site.
void	CmsSiteManagerImpl.removeSite(CmsObject cms, CmsSite site) Removes a site from the list of configured sites.
void	CmsSiteManagerImpl.updateGeneralSettings(CmsObject cms, java.lang.String defaultUri, java.util.List<java.lang.String> workplaceServersList, java.lang.String sharedFolder) Method for backward compability reasons.
void	CmsSiteManagerImpl.updateGeneralSettings(CmsObject cms, java.lang.String defaulrUri, java.util.Map<java.lang.String,CmsSSLMode> workplaceServers, java.lang.String sharedFolder) Updates the general settings.
void	CmsSiteManagerImpl.updateSite(CmsObject cms, CmsSite oldSite, CmsSite newSite) Updates or creates a site.

Uses of CmsObject in org.opencms.site.xmlsitemap

Fields in org.opencms.site.xmlsitemap declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsXmlSitemapGenerator.m_guestCms A CMS context with guest privileges.
protected CmsObject	CmsXmlSitemapGenerator.m_siteGuestCms A guest user CMS object with the site root of the base folder.

Methods in org.opencms.site.xmlsitemap with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsUpdateXmlSitemapCacheJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
void	CmsXmlSeoConfiguration.load(CmsObject cms, CmsResource resource) Loads the bean data from the given resource.

Uses of CmsObject in org.opencms.staticexport

Methods in org.opencms.staticexport with parameters of type CmsObject

Modifier and Type	Method and Description
protected java.util.List<CmsPublishedResource>	A_CmsStaticExportHandler.addMovedLinkSources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Add the link sources of moved resources to the list of published resources.
protected CmsPair<java.lang.String,java.lang.String>	CmsLocalePrefixLinkSubstitutionHandler.addVfsPrefix(CmsObject cms, java.lang.String vfsName, CmsSite targetSite, java.lang.String parameters)
protected CmsPair<java.lang.String,java.lang.String>	CmsDefaultLinkSubstitutionHandler.addVfsPrefix(CmsObject cms, java.lang.String vfsName, CmsSite targetSite, java.lang.String parameters) Adds the VFS prefix to the VFS name and potentially adjusts request parameters This method is required as a hook used in CmsLocalePrefixLinkSubstitutionHandler.
int	CmsStaticExportManager.export(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, CmsObject cms, CmsStaticExportData data) Exports the requested uri and at the same time writes the uri to the response output stream if required.
protected boolean	CmsAfterPublishStaticExportHandler.exportNonTemplateResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources, I_CmsReport report) Exports all non template resources found in a list of published resources.
protected void	CmsAfterPublishStaticExportHandler.exportTemplateResources(CmsObject cms, java.util.List<java.lang.String> publishedTemplateResources, I_CmsReport report) Exports all template resources found in a list of published resources.
protected java.lang.String	CmsLocalePrefixLinkSubstitutionHandler.generateCacheKey(CmsObject cms, java.lang.String targetSiteRoot, java.lang.String detailPagePart, java.lang.String absoluteLink)
protected java.lang.String	CmsDefaultLinkSubstitutionHandler.generateCacheKey(CmsObject cms, java.lang.String targetSiteRoot, java.lang.String detailPagePart, java.lang.String absoluteLink) Generates the cache key for Online links.
java.util.List<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getAllResources(CmsObject cms) Returns all resources within the current OpenCms site that are not marked as internal.
CmsStaticExportData	CmsStaticExportManager.getExportData(javax.servlet.http.HttpServletRequest request, CmsObject cms) Returns the export data for the request, if null is returned no export is required.
java.util.Set<CmsPublishedResource>	CmsStaticExportExportRule.getExportResources(CmsObject cms) Returns a set of CmsPublishedResource objects containing all resources specified by the <export-resources> node of this rule.
java.lang.String	CmsAdvancedLinkSubstitutionHandler.getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, boolean forceSecure)
java.lang.String	CmsDefaultLinkSubstitutionHandler.getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, boolean forceSecure) Returns the resource root path in the OpenCms VFS for the given link, or null in case the link points to an external site.
java.lang.String	I_CmsLinkSubstitutionHandler.getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot, for use on web pages.
java.lang.String	CmsDefaultLinkSubstitutionHandler.getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, java.lang.String targetDetailPage, boolean forceSecure)
java.lang.String	I_CmsLinkSubstitutionHandler.getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, java.lang.String targetDetailPage, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot, for use on web pages.
java.lang.String	CmsLinkManager.getOnlineLink(CmsObject cms, java.lang.String resourceName) Returns the online link for the given resource, with full server prefix.
java.lang.String	CmsLinkManager.getOnlineLink(CmsObject cms, java.lang.String resourceName, boolean forceSecure) Returns the online link for the given resource, with full server prefix.
java.lang.String	CmsLinkManager.getOnlineLink(CmsObject cms, java.lang.String resourceName, java.lang.String targetDetailPage, boolean forceSecure) Returns the online link for the given resource, with full server prefix.
java.lang.String	CmsLinkManager.getPermalink(CmsObject cms, java.lang.String resourceName) Returns the perma link for the given resource.
java.lang.String	CmsLinkManager.getPermalink(CmsObject cms, java.lang.String resourceName, CmsUUID detailContentId) Returns the perma link for the given resource and optional detail content.
java.lang.String	CmsLinkManager.getPermalinkForCurrentPage(CmsObject cms) Returns the perma link for the current page based on the URI and detail content id stored in the CmsObject passed as a parameter.
java.util.Set<CmsPublishedResource>	CmsStaticExportExportRule.getRelatedResources(CmsObject cms, CmsPublishedResource publishedResource) Returns a set of CmsPublishedResource objects specified by the <export-resources> node of this rule, if the publishedResource matches a modified Resource regular expression.
protected java.util.List<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getRelatedResources(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources) Creates a list of CmsPublishedResource objects containing all related resources of the VFS tree.
protected CmsStaticExportData	CmsStaticExportManager.getRfsExportData(CmsObject cms, java.lang.String uri) Returns the export data for a requested resource, if null is returned no export is required.
java.lang.String	CmsStaticExportManager.getRfsName(CmsObject cms, java.lang.String vfsName) Returns the static export rfs name for a given vfs resource.
java.lang.String	CmsStaticExportManager.getRfsName(CmsObject cms, java.lang.String vfsName, java.lang.String parameters, java.lang.String targetDetailPage) Returns the static export rfs name for a given vfs resource where the link to the resource includes request parameters.
protected java.lang.String	CmsStaticExportManager.getRfsNameWithExportName(CmsObject cms, java.lang.String vfsName) Returns the rfs name for a given vfs name with consideration of the export name.
java.lang.String	CmsLinkManager.getRootPath(CmsObject cms, java.lang.String targetUri) Returns the resource root path in the OpenCms VFS for the given target URI link, or null in case the link points to an external site.
java.lang.String	CmsAdvancedLinkSubstitutionHandler.getRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath)
java.lang.String	CmsLinkManager.getRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath) Returns the resource root path in the OpenCms VFS for the given target URI link, or null in case the link points to an external site.
java.lang.String	CmsDefaultLinkSubstitutionHandler.getRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath)
java.lang.String	I_CmsLinkSubstitutionHandler.getRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath) Returns the resource root path in the OpenCms VFS for the given target URI link, or null in case the link points to an external site.
protected java.lang.String	CmsLocalePrefixLinkSubstitutionHandler.getRootPathForSite(CmsObject cms, java.lang.String path, java.lang.String siteRoot, boolean isRootPath)
protected java.lang.String	CmsDefaultLinkSubstitutionHandler.getRootPathForSite(CmsObject cms, java.lang.String path, java.lang.String siteRoot, boolean isRootPath) Returns the root path for given site.
java.lang.String	CmsLinkManager.getServerLink(CmsObject cms, java.lang.String resourceName) Returns the link for the given resource in the current project, with full server prefix.
java.lang.String	CmsLinkManager.getServerLink(CmsObject cms, java.lang.String resourceName, boolean forceSecure) Returns the link for the given resource in the current project, with full server prefix.
protected java.util.Set<CmsPublishedResource>	CmsAfterPublishStaticExportHandler.getSiblings(CmsObject cms, CmsPublishedResource pubResource) Returns all siblings of the published resource as list of CmsPublishedResource.
protected java.util.List<java.lang.String>	A_CmsStaticExportHandler.getSiblingsList(CmsObject cms, java.lang.String resPath) Returns a list containing the root paths of all siblings of a resource.
protected java.lang.String	CmsDefaultLinkSubstitutionHandler.getSimpleRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath) Gets the root path without taking into account detail page links.
static java.lang.String	CmsLinkManager.getSitePath(CmsObject cms, java.lang.String basePath, java.lang.String targetUri) Deprecated. use CmsLinkManager.getRootPath(CmsObject, String, String) instead, obtain the link manager with OpenCms.getLinkManager()
CmsStaticExportData	CmsStaticExportManager.getVfsExportData(CmsObject cms, java.lang.String vfsName) Returns the export data for a requested resource, if null is returned no export is required.
java.lang.String	CmsStaticExportManager.getVfsName(CmsObject cms, java.lang.String rfsName) Returns the VFS name for the given RFS name, being the exact reverse of CmsStaticExportManager.getRfsName(CmsObject, String).
CmsStaticExportData	CmsStaticExportManager.getVfsNameInternal(CmsObject cms, java.lang.String rfsName) Returns the VFS name from a given RFS name.
java.lang.String	CmsLinkManager.getWorkplaceLink(CmsObject cms, java.lang.String resourceName, boolean forceSecure) Returns the link for the given workplace resource.
void	CmsStaticExportManager.initialize(CmsObject cms) Initializes the static export manager with the OpenCms system configuration.
protected boolean	CmsDefaultLinkSubstitutionHandler.isDetailPageLinkSecure(CmsObject cms, java.lang.String detailPage, CmsResource detailContent, CmsSite targetSite, boolean secureRequest) Checks whether a link to a detail page should be secure.
protected boolean	CmsAdvancedLinkSubstitutionHandler.isExcluded(CmsObject cms, java.lang.String path) Returns if the given path starts with an exclude prefix.
boolean	CmsStaticExportManager.isExportLink(CmsObject cms, java.lang.String vfsName) Checks if the static export is required for the given VFS resource.
boolean	CmsStaticExportManager.isSecureLink(CmsObject cms, java.lang.String vfsName) Returns true if the given VFS resource should be transported through a secure channel.
boolean	CmsStaticExportManager.isSecureLink(CmsObject cms, java.lang.String vfsName, boolean fromSecure) Returns true if the given VFS resource should be transported through a secure channel.
protected boolean	CmsDefaultLinkSubstitutionHandler.isSecureLink(CmsObject cms, java.lang.String vfsName, CmsSite targetSite, boolean secureRequest) Checks if the link target is a secure link.
boolean	CmsStaticExportManager.isSecureLink(CmsObject cms, java.lang.String vfsName, java.lang.String siteRoot) Returns true if the given VFS resource that is located under the given site root should be transported through a secure channel.
boolean	CmsStaticExportManager.isSecureLink(CmsObject cms, java.lang.String vfsName, java.lang.String siteRoot, boolean fromSecure) Returns true if the given VFS resource should be transported through a secure channel.
protected java.lang.String	CmsLocalePrefixLinkSubstitutionHandler.prepareExportParameters(CmsObject cms, java.lang.String vfsName, java.lang.String parameters)
protected java.lang.String	CmsDefaultLinkSubstitutionHandler.prepareExportParameters(CmsObject cms, java.lang.String vfsName, java.lang.String parameters) Prepares the request parameters for the given resource.
protected boolean	CmsAfterPublishStaticExportHandler.readNonTemplateResourcesToExport(CmsObject cms, java.util.List<CmsPublishedResource> publishedResources, java.util.List<CmsStaticExportData> resourcesToExport) Returns all non template resources found in a list of published resources.
protected CmsStaticExportData	CmsStaticExportManager.readResource(CmsObject cms, java.lang.String uri) Reads the resource with the given URI.
protected void	A_CmsStaticExportHandler.scrubResource(CmsObject cms, CmsPublishedResource res, java.util.Set<java.lang.String> scrubbedFolders, java.util.Set<java.lang.String> scrubbedFiles) Scrub a single file or folder.
void	CmsLinkManager.setLinkSubstitutionHandler(CmsObject cms, I_CmsLinkSubstitutionHandler linkSubstitutionHandler) Sets the internal link substitution handler.
java.lang.String	CmsLinkManager.substituteLink(CmsObject cms, CmsResource resource) Returns a link from the URI stored in the provided OpenCms user context to the given VFS resource, for use on web pages.
java.lang.String	CmsLinkManager.substituteLink(CmsObject cms, java.lang.String link) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link in the current site, for use on web pages.
java.lang.String	CmsLinkManager.substituteLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot, for use on web pages.
java.lang.String	CmsLinkManager.substituteLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot, for use on web pages, using the configured link substitution handler.
java.lang.String	CmsLinkManager.substituteLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, java.lang.String targetDetailPage, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot, for use on web pages, using the configured link substitution handler.
java.lang.String	CmsLinkManager.substituteLinkForRootPath(CmsObject cms, java.lang.String rootPath) Returns a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given root path, for use on web pages.
java.lang.String	CmsLinkManager.substituteLinkForUnknownTarget(CmsObject cms, java.lang.String link) Returns a link from the URI stored in the provided OpenCms user context to the given link, for use on web pages.
java.lang.String	CmsLinkManager.substituteLinkForUnknownTarget(CmsObject cms, java.lang.String link, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the given link, for use on web pages.
java.lang.String	CmsLinkManager.substituteLinkForUnknownTarget(CmsObject cms, java.lang.String link, java.lang.String targetDetailPage, boolean forceSecure) Returns a link from the URI stored in the provided OpenCms user context to the given link, for use on web pages.

Constructors in org.opencms.staticexport with parameters of type CmsObject

Constructor and Description
CmsLinkProcessor(CmsObject cms, CmsLinkTable linkTable, java.lang.String encoding, java.lang.String relativePath) Creates a new link processor.

Uses of CmsObject in org.opencms.synchronize

Methods in org.opencms.synchronize with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSynchronizeSettings.checkValues(CmsObject cms) Performs a check if the values that have been set are valid.
void	I_CmsSynchronizeModification.modifyFs(CmsObject cms, CmsResource vfsRes, java.io.File fsFile) Possibility to modify a resource after it has benn exported or updated to the FS.
void	I_CmsSynchronizeModification.modifyVfs(CmsObject cms, CmsResource vfsRes, java.io.File fsFile) Possibility to modify a resource after it has been imported or updated into the VFS.
java.lang.String	I_CmsSynchronizeModification.translate(CmsObject cms, java.lang.String resName) Translates the resource name.

Constructors in org.opencms.synchronize with parameters of type CmsObject

Constructor and Description
CmsSynchronize(CmsObject cms, CmsSynchronizeSettings settings, I_CmsReport report) Creates a new CmsSynchronize object which automatically start the synchronization process.

Uses of CmsObject in org.opencms.ugc

Methods in org.opencms.ugc that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsUgcSession.getCmsObject() Gets the CMS context used by this session.

Methods in org.opencms.ugc with parameters of type CmsObject

Modifier and Type	Method and Description
static void	CmsUgcSessionSecurityUtil.checkCreateContent(CmsObject cms, CmsUgcConfiguration config) Checks whether a new XML content may be created and throws an exception if this is not the case.
static void	CmsUgcSessionSecurityUtil.checkCreateUpload(CmsObject cms, CmsUgcConfiguration config, java.lang.String name, long size) Checks whether an uploaded file can be created in the VFS, and throws an exception otherwise.
void	CmsUgcEditService.checkPermissions(CmsObject cms)
CmsUgcSession	CmsUgcSessionFactory.createSession(CmsObject cms, javax.servlet.http.HttpServletRequest request, CmsUgcConfiguration config) Creates a new editing session.
CmsUgcSession	CmsUgcSessionFactory.createSession(CmsObject cms, javax.servlet.http.HttpServletRequest request, java.lang.String sitePath) Creates a new editing session.
CmsUgcSession	CmsUgcSessionFactory.createSessionForFile(CmsObject cms, javax.servlet.http.HttpServletRequest request, java.lang.String configPath, java.lang.String fileName) Creates a new session for a given file.
static void	CmsUgcSessionFactory.setAdminCms(CmsObject adminCms) Sets the admin CmsObject instance.

Constructors in org.opencms.ugc with parameters of type CmsObject

Constructor and Description
CmsUgcConfigurationReader(CmsObject cms) Creates a new instance.
CmsUgcSession(CmsObject cms) Constructor.
CmsUgcSession(CmsObject adminCms, CmsObject cms, CmsUgcConfiguration configuration) Constructor.
CmsUgcSession(CmsObject cms, CmsUgcConfiguration configuration) Constructor.

Uses of CmsObject in org.opencms.ui

Methods in org.opencms.ui that return CmsObject

Modifier and Type	Method and Description
CmsObject	I_CmsDialogContext.getCms() Gets the CMS context to be used for dialog operations.
CmsObject	A_CmsDialogContext.getCms()
static CmsObject	A_CmsUI.getCmsObject() Returns the current cms context.

Methods in org.opencms.ui with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsUserIconHelper.deleteUserImage(CmsObject cms) Deletes the user image of the current user.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getAvailableGroupsContainerWithout(CmsObject cms, java.lang.String ouFqn, java.lang.String propCaption, java.lang.String propIcon, java.lang.String propOu, java.util.List<CmsGroup> blackList, java.util.function.Function<CmsGroup,CmsCssIcon> iconProvider) Get all groups with blacklist.
static java.util.List<CmsProject>	CmsVaadinUtils.getAvailableProjects(CmsObject cms) Returns the available projects.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getAvailableSitesContainer(CmsObject cms, java.lang.String captionPropertyName) Builds an IndexedContainer containing the sites selectable by the current user.
java.lang.String	CmsUserIconHelper.getBigIconPath(CmsObject cms, CmsUser user) Returns the big ident-icon path for the given user.
static java.lang.String	CmsVaadinUtils.getBootstrapScript(CmsObject cms, java.lang.String elementId, java.lang.String servicePath) Returns the Javascript code to use for initializing a Vaadin UI.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getGroupsOfUser(CmsObject cms, CmsUser user, java.lang.String caption, java.lang.String iconProp, java.lang.String ou, java.lang.String propStatus, com.google.common.base.Function<CmsGroup,CmsCssIcon> iconProvider) Gets container with alls groups of a certain user.
static com.vaadin.v7.ui.ComboBox	CmsVaadinUtils.getOUComboBox(CmsObject cms, java.lang.String baseOu, org.apache.commons.logging.Log log) Creates the ComboBox for OU selection.
static com.vaadin.v7.ui.ComboBox	CmsVaadinUtils.getOUComboBox(CmsObject cms, java.lang.String baseOu, org.apache.commons.logging.Log log, boolean includeWebOU) Creates the ComboBox for OU selection.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getPrincipalContainer(CmsObject cms, java.util.List<? extends I_CmsPrincipal> list, java.lang.String captionID, java.lang.String descID, java.lang.String iconID, java.lang.String ouID, java.lang.String icon, java.util.List<com.vaadin.server.FontIcon> iconList) Get container for principal.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getProjectsContainer(CmsObject cms, java.lang.String captionPropertyName) Returns the selectable projects container.
static com.vaadin.v7.data.util.IndexedContainer	CmsVaadinUtils.getRoleContainerForUser(CmsObject cms, CmsUser user, java.lang.String captionPropertyName) Returns the roles available for a given user.
java.lang.String	CmsUserIconHelper.getSmallIconPath(CmsObject cms, CmsUser user) Returns the small ident-icon path for the given user.
java.lang.String	CmsUserIconHelper.getTinyIconPath(CmsObject cms, CmsUser user) Returns the tiny ident-icon path for the given user.
boolean	CmsUserIconHelper.handleImageUpload(CmsObject cms, CmsUser user, java.lang.String uploadedFile) Handles a user image upload.
boolean	CmsUserIconHelper.handleImageUpload(CmsObject cms, java.util.List<java.lang.String> uploadedFiles) Handles a user image upload.
void	CmsUserIconHelper.setUserImage(CmsObject cms, CmsUser user, java.lang.String rootPath) Sets the user image for the given user.

Constructors in org.opencms.ui with parameters of type CmsObject

Constructor and Description
CmsUserIconHelper(CmsObject adminCms) Constructor.

Uses of CmsObject in org.opencms.ui.actions

Methods in org.opencms.ui.actions with parameters of type CmsObject

Modifier and Type	Method and Description
CmsMenuItemVisibilityMode	CmsUserInfoDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsFormEditDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSelectElementViewAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsRenameAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDirectPublishDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsWorkplaceAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsFavoriteDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	A_CmsEditFileAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsGalleryDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPropertiesDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPropertyAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsAvailabilityDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsResourceInfoAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPreviewAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLogoutAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsHistoryDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUndeleteDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSecureExportDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditSmallElementsAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsMoveDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUnlockAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsTouchDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCategoriesDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSeoAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyPageDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditCodeDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditUserDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsShowLocaleAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapEditConfigAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLinkLocaleVariantAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPermissionDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsReplaceDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsTemplateContextsAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPointerAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsCopyToProjectDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLockedResourcesAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapOpenParentAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDisplayAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsPublishScheduledDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapAliasAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	A_CmsToolbarAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsViewInExplorerAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsChangeTypeDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsEditPageAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsStealLockAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsRestoreDeletedAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsDeleteDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsViewOnlineAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUnlinkLocaleVariantAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsContextMenuActionItem.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsLockAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsUndoDialogAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSitemapRefreshAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)

Uses of CmsObject in org.opencms.ui.apps

Methods in org.opencms.ui.apps that return CmsObject

Modifier and Type	Method and Description
CmsObject	A_CmsWorkplaceApp.getOfflineCmsObject(CmsObject cms) Gets an offline version of the cms object.

Methods in org.opencms.ui.apps with parameters of type CmsObject

Modifier and Type	Method and Description
static com.vaadin.ui.Component	CmsDefaultAppButtonProvider.createAppButton(CmsObject cms, I_CmsWorkplaceAppConfiguration appConfig, java.util.Locale locale) Creates a properly styled button for the given app.
static com.vaadin.ui.Component	CmsDefaultAppButtonProvider.createAppFolderButton(CmsObject cms, CmsAppCategoryNode node, java.util.Locale locale) Creates a properly styled button for the given app.
<T extends I_CmsAppSettings> T	CmsWorkplaceAppManager.getAppSettings(CmsObject cms, java.lang.Class<T> type) Returns the user app setting of the given type.
static java.lang.String	CmsEditor.getEditStateForNew(CmsObject cms, I_CmsResourceType resourceType, java.lang.String contextPath, java.lang.String modelFilePath, boolean plainText, java.lang.String backLink) Returns the edit state for the given resource structure id.
CmsObject	A_CmsWorkplaceApp.getOfflineCmsObject(CmsObject cms) Gets an offline version of the cms object.
java.util.List<I_CmsWorkplaceAppConfiguration>	CmsWorkplaceAppManager.getQuickLaunchConfigurations(CmsObject cms) Gets the configured quick launch apps which are visible for the current user.
protected java.util.List<I_CmsWorkplaceAppConfiguration>	CmsWorkplaceAppManager.getUserQuickLauchConfigurations(CmsObject cms) Returns the quick launch apps set for the current user.
CmsAppVisibilityStatus	I_CmsFolderAppCategory.getVisibility(CmsObject cms) Returns the visibility status of the app for the given user context.
CmsAppVisibilityStatus	CmsSitemapEditorConfiguration.getVisibility(CmsObject cms)
CmsAppVisibilityStatus	I_CmsWorkplaceAppConfiguration.getVisibility(CmsObject cms) Returns the visibility status of the app for the given user context.
CmsAppVisibilityStatus	CmsLegacyAppConfiguration.getVisibility(CmsObject cms)
CmsAppVisibilityStatus	CmsPageEditorConfiguration.getVisibility(CmsObject cms)
CmsAppVisibilityStatus	CmsEditorConfiguration.getVisibility(CmsObject cms)
CmsAppVisibilityStatus	A_CmsWorkplaceAppConfiguration.getVisibility(CmsObject cms)
protected void	CmsWorkplaceAppManager.setUserQuickLaunchApps(CmsObject cms, java.util.List<java.lang.String> apps) Writes the user quick launch apps setting to the user additional info.
void	CmsWorkplaceAppManager.storeAppSettings(CmsObject cms, java.lang.Class<? extends I_CmsAppSettings> type, I_CmsAppSettings appSettings) Stores the given app setting within the users additional info.
void	CmsFileExplorer.updateResourceInTree(CmsObject cms, CmsUUID id) Updates the give tree item.

Constructors in org.opencms.ui.apps with parameters of type CmsObject

Constructor and Description
CmsWorkplaceAppManager(CmsObject adminCms) Constructor.

Uses of CmsObject in org.opencms.ui.apps.cacheadmin

Fields in org.opencms.ui.apps.cacheadmin declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsImageCacheHolder.m_clonedCms Cms Object.

Methods in org.opencms.ui.apps.cacheadmin with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsImageCacheHelper.getSingleSize(CmsObject cms, java.lang.String resPath) Reads the size of a single image.
CmsAppVisibilityStatus	CmsCacheFolder.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.cacheadmin with parameters of type CmsObject

Constructor and Description
CmsImageCacheHelper(CmsObject cms, boolean withVariations, boolean showSize, boolean statsOnly) Default constructor.

Uses of CmsObject in org.opencms.ui.apps.dbmanager

Fields in org.opencms.ui.apps.dbmanager declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsDbSynchronizationView.m_cms Root CmsObject.
protected CmsObject	CmsDbExportView.m_cms Copy of current CmsObject.

Methods in org.opencms.ui.apps.dbmanager that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsPropertyDeleteDialog.getCms() Gets a copy of the cms object set to root site.
protected CmsObject	CmsResourceTypeStatsView.getCmsObject() Sets the cms object to selected site and returns it.
protected CmsObject	A_CmsImportForm.getCmsObject() Returns a cms object set to the site corresponding to siteselector.

Methods in org.opencms.ui.apps.dbmanager with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsDbManagerFolder.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.dbmanager with parameters of type CmsObject

Constructor and Description
CmsRemovePropertyFromResourcesThread(CmsObject cms, java.lang.String propName) Public constructor.
CmsRemovePubLocksThread(CmsObject cms, java.util.List<java.lang.String> resources) Creates an Thread to remove the publish locks.
CmsStaticExportThread(CmsObject cms) Creates a static export Thread.
CmsSynchronizeThread(CmsObject cms) Creates the synchronize Thread.

Uses of CmsObject in org.opencms.ui.apps.filehistory

Methods in org.opencms.ui.apps.filehistory with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsFileHistoryFolder.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.filehistory with parameters of type CmsObject

Constructor and Description
CmsHistoryClearThread(CmsObject cms, int keepV, int keepD, long date) Creates the history clear Thread.

Uses of CmsObject in org.opencms.ui.apps.git

Methods in org.opencms.ui.apps.git that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsGitCheckin.getCmsObject() Gets the CMS context.

Methods in org.opencms.ui.apps.git with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsGitAppConfiguration.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.git with parameters of type CmsObject

Constructor and Description
CmsGitCheckin(CmsObject cms) Default constructor.

Uses of CmsObject in org.opencms.ui.apps.linkvalidation

Methods in org.opencms.ui.apps.linkvalidation with parameters of type CmsObject

Modifier and Type	Method and Description
void	A_CmsLinkValidator.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, java.util.Locale locale)
CmsAppVisibilityStatus	CmsLinkValidationFolder.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.linkvalidation with parameters of type CmsObject

Constructor and Description
CmsExternalLinksValidatorThread(CmsObject cms, java.lang.Runnable finRun) Constructor, creates a new CmsExternLinkValidationThread.

Uses of CmsObject in org.opencms.ui.apps.lists

Methods in org.opencms.ui.apps.lists with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsListManager.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, java.util.Locale locale)
protected void	CmsResultTable.fillItem(CmsObject cms, CmsResource resource, java.util.Locale locale)
static CmsListManager.ListConfigurationBean	CmsListManager.parseListConfiguration(CmsObject cms, CmsResource res) Parses the list configuration resource.

Uses of CmsObject in org.opencms.ui.apps.lists.daterestrictions

Fields in org.opencms.ui.apps.lists.daterestrictions declared as CmsObject

Modifier and Type	Field and Description
CmsObject	CmsDateRestrictionParser.m_cms The CMS context used.

Constructors in org.opencms.ui.apps.lists.daterestrictions with parameters of type CmsObject

Constructor and Description
CmsDateRestrictionParser(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.ui.apps.modules

Methods in org.opencms.ui.apps.modules with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsModuleAppConfiguration.getVisibility(CmsObject cms)

Constructors in org.opencms.ui.apps.modules with parameters of type CmsObject

Constructor and Description
CmsModuleImportThread(CmsObject cms, CmsModule module, java.lang.String path) Creates a new instance.

Uses of CmsObject in org.opencms.ui.apps.modules.edit

Methods in org.opencms.ui.apps.modules.edit with parameters of type CmsObject

Modifier and Type	Method and Description
static com.vaadin.v7.data.util.IndexedContainer	CmsEditModuleForm.getModuleSiteContainer(CmsObject cms, java.lang.String captionPropertyName, java.lang.String prevValue) Builds the container used for the module site selector.
void	CmsModuleResourceSelectField.setCmsObject(CmsObject cms)

Uses of CmsObject in org.opencms.ui.apps.projects

Methods in org.opencms.ui.apps.projects with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsProjectOverviewConfiguration.getVisibility(CmsObject cms)

Uses of CmsObject in org.opencms.ui.apps.publishqueue

Methods in org.opencms.ui.apps.publishqueue with parameters of type CmsObject

Modifier and Type	Method and Description
CmsAppVisibilityStatus	CmsPublishQueueConfiguration.getVisibility(CmsObject cms)

Uses of CmsObject in org.opencms.ui.apps.search

Constructors in org.opencms.ui.apps.search with parameters of type CmsObject

Constructor and Description
CmsSearchReplaceThread(javax.servlet.http.HttpSession session, CmsObject cms, CmsSearchReplaceSettings settings) Creates a replace html tag Thread.
CmsSearchReplaceThread(javax.servlet.http.HttpSession session, CmsObject cms, CmsSearchReplaceSettings settings, I_CmsReport report) Creates a replace html tag Thread.

Uses of CmsObject in org.opencms.ui.apps.searchindex

Constructors in org.opencms.ui.apps.searchindex with parameters of type CmsObject

Constructor and Description
CmsIndexingReportThread(CmsObject cms, java.util.List<java.lang.String> indexNames) Creates an indexing Thread for full update.

Uses of CmsObject in org.opencms.ui.apps.sessions

Fields in org.opencms.ui.apps.sessions declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsUserInfoDialog.m_cms CmsObject.

Uses of CmsObject in org.opencms.ui.apps.shell

Methods in org.opencms.ui.apps.shell with parameters of type CmsObject

Modifier and Type	Method and Description
protected void	CmsShellScriptLayout.setupCms(CmsObject cms) Sets up given CmsObject with currently set Project and Site.

Constructors in org.opencms.ui.apps.shell with parameters of type CmsObject

Constructor and Description
CmsShellScriptThread(CmsObject cms, java.lang.String script) public constructor.

Uses of CmsObject in org.opencms.ui.apps.sitemanager

Methods in org.opencms.ui.apps.sitemanager that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsSiteManager.getRootCmsObject() Returns the root cms object.

Methods in org.opencms.ui.apps.sitemanager with parameters of type CmsObject

Modifier and Type	Method and Description
static boolean	CmsSiteManager.isFolderWithMacros(CmsObject cms, java.lang.String folderPathRoot) Method to check if a folder under given path contains a bundle for macro resolving.

Constructors in org.opencms.ui.apps.sitemanager with parameters of type CmsObject

Constructor and Description
CmsCreateSiteThread(CmsObject cms, I_CmsCRUDApp<CmsSite> manager, CmsSite site, CmsSite oldSite, java.lang.String source, java.lang.String template, boolean createOU, java.lang.String parentOU, java.lang.String selectedOU, java.io.ByteArrayOutputStream os, java.util.Map<java.lang.String,java.lang.String> bundle, java.lang.Runnable finished) Constructor for Class.
CmsEditSiteForm(CmsObject cms, CmsSite site, CmsSiteManager manager, boolean editable) Public constructor.
CmsEditSiteForm(CmsObject cms, CmsSiteManager manager) Constructor.
CmsEditSiteForm(CmsObject cms, CmsSiteManager manager, java.lang.String siteRoot) Constructor.
CmsSitesWebserverThread(CmsObject cms, java.lang.String targetPath, java.lang.String templatePath, java.lang.String scriptPath, java.lang.String filePrefix, java.lang.String loggingDir, java.lang.String secureTemplate) Public constructor.

Uses of CmsObject in org.opencms.ui.apps.user

Fields in org.opencms.ui.apps.user declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsEditUserGroupRoleDialog.m_cms CmsObject.
protected CmsObject	CmsMoveUserToOU.m_cms CmsObject.
protected CmsObject	CmsOUEditDialog.m_cms CmsObject.
protected CmsObject	CmsAccountsApp.m_cms CmsObject.

Methods in org.opencms.ui.apps.user that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsShowResourceTable.getCms() Gets CmsObject.

Methods in org.opencms.ui.apps.user with parameters of type CmsObject

Modifier and Type	Method and Description
static java.util.Map<CmsUUID,CmsUser>	CmsImportExportUserDialog.addExportAllUsers(CmsObject cms, java.lang.String ou, java.util.Map<CmsUUID,CmsUser> exportUsers) Returns a map with the users to export added.
static java.util.Map<CmsUUID,CmsUser>	CmsImportExportUserDialog.addExportUsersFromGroups(CmsObject cms, java.util.List<java.lang.String> groups, java.util.Map<CmsUUID,CmsUser> exportUsers) Returns a map with the users to export added.
static java.util.Map<CmsUUID,CmsUser>	CmsImportExportUserDialog.addExportUsersFromRoles(CmsObject cms, java.lang.String ou, java.util.List<java.lang.String> roles, java.util.Map<CmsUUID,CmsUser> exportUsers) Returns a map with the users to export added.
com.vaadin.v7.data.util.IndexedContainer	CmsAccountsApp.getAvailableGroupsContainerWithout(CmsObject cms, java.lang.String ouFqn, java.lang.String propCaption, java.lang.String propIcon, java.lang.String propOu, java.util.List<CmsGroup> groupsOfUser, java.util.function.Function<CmsGroup,CmsCssIcon> iconProvider) Gets a data container for the groups available to be added to a user, excluding some groups.
static java.util.List<java.lang.String>	CmsOUHandler.getManagableOUs(CmsObject cms) Gets List of managable OU names for the current user.
java.util.List<CmsUser>	CmsAccountsApp.getUsersWithoutAdditionalInfo(CmsObject cms, I_CmsOuTreeType type, java.lang.String ou, boolean recursive) Gets list of users for organizational unit.
protected static void	CmsUserEditDialog.iniRole(CmsObject cms, java.lang.String ou, com.vaadin.ui.ComboBox<CmsRole> roleComboBox, org.apache.commons.logging.Log log) Initialized the role ComboBox.
protected static void	CmsUserEditDialog.iniRole(CmsObject cms, java.lang.String ou, com.vaadin.v7.ui.ComboBox roleComboBox, org.apache.commons.logging.Log log) Initialized the role ComboBox.
void	CmsGroupsOfUserTable.init(CmsAccountsApp app, CmsObject cms, CmsUser user, java.util.List<CmsGroup> groups) Init method.
boolean	I_CmsOuTreeType.isValidForOu(CmsObject cms, java.lang.String ou) Checks if the tree type is available for a given OU.
boolean	CmsOuTreeType.isValidForOu(CmsObject cms, java.lang.String ou)
java.util.List<CmsGroup>	CmsAccountsApp.readGroupsForOu(CmsObject cms, java.lang.String ou, I_CmsOuTreeType type, boolean subOus) Reads the list of groups for an organizational unit.
protected static void	CmsUserEditDialog.sendMail(CmsObject cms, java.lang.String password, CmsUser user, boolean newUser, boolean changePassword) Sends an email to the user.
protected static void	CmsUserEditDialog.sendMail(CmsObject cms, java.lang.String password, CmsUser user, java.lang.String ou, boolean newUser, boolean changePassword)

Constructors in org.opencms.ui.apps.user with parameters of type CmsObject

Constructor and Description
A_CmsEditUserGroupRoleDialog(CmsObject cms, CmsUUID userId, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsAdditionalInfosDialog(CmsObject cms, CmsUUID userID, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsCurrentRoleOrPrincipalTable(A_CmsEditUserGroupRoleDialog dialog, CmsObject cms, CmsPrincipal principal) public constructor.
CmsDeleteMultiplePrincipalDialog(CmsObject cms, java.util.Set<java.lang.String> context, com.vaadin.ui.Window window, CmsAccountsApp app) Public constructor.
CmsDeleteOUDialog(CmsObject cms, java.lang.String ouName, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor used for OUs.
CmsGroupEditDialog(CmsObject cms, CmsUUID groupId, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsGroupEditDialog(CmsObject cms, com.vaadin.ui.Window window, java.lang.String ou, CmsAccountsApp app) Constructor for dialog for new groups.
CmsImportUserThread(CmsObject cms, java.lang.String ou, java.util.List<CmsUser> userList, java.util.List<java.lang.String> groups, java.util.List<CmsRole> roles, boolean sendmail) public constructor.
CmsMoveUserToOU(CmsObject cms, CmsUUID userID, com.vaadin.ui.Window window, CmsAccountsApp app) Public constructor.
CmsNewElementDialog(CmsObject cms, java.lang.String ou, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsOUEditDialog(CmsObject cms, java.lang.String ou, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsOUEditDialog(CmsObject cms, com.vaadin.ui.Window window, java.lang.String ou, CmsAccountsApp app) public constructor.
CmsOUHandler(CmsObject cms) Public constructor.
CmsOuTree(CmsObject cms, CmsAccountsApp app, java.lang.String baseOU) constructor.
CmsResourceInfoTable(CmsObject cms, java.util.Set<CmsUUID> userIDs, java.util.Set<CmsUUID> groupIDs) Public constructor.
CmsSendPasswordNotification(CmsObject cms, java.lang.String password, CmsUser receiver, java.lang.String ou, CmsUser adminUser, java.lang.String link, boolean newUser, boolean tempPassword) Public constructor.
CmsShowResourceTable(CmsObject cms, CmsUUID principalID, CmsShowResourcesDialog.DialogType type) public constructor.
CmsUserEditDialog(CmsObject cms, CmsUUID userId, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsUserEditDialog(CmsObject cms, com.vaadin.ui.Window window, java.lang.String ou, CmsAccountsApp app) public constructor for new user case.
CmsUserEditGroupsDialog(CmsObject cms, CmsUUID userId, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.
CmsUserEditRoleDialog(CmsObject cms, CmsUUID userId, com.vaadin.ui.Window window, CmsAccountsApp app) public constructor.

Uses of CmsObject in org.opencms.ui.components

Methods in org.opencms.ui.components with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsResourceTable.I_ResourcePropertyProvider.addItemProperties(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, java.util.Locale locale) Adds the property values to the given item.
protected void	CmsResourceTable.fillItem(CmsObject cms, CmsResource resource, java.util.Locale locale) Fills the file item data.
static void	CmsResourceTable.fillItemDefault(com.vaadin.v7.data.Item resourceItem, CmsObject cms, CmsResource resource, java.util.Locale locale) Static helper method to initialize the 'standard' properties of a data item from a given resource.
void	CmsResourceTable.fillTable(CmsObject cms, java.util.List<CmsResource> resources) Fills the resource table.
void	CmsResourceTable.fillTable(CmsObject cms, java.util.List<CmsResource> resources, boolean clearFilter) Fills the resource table.
void	CmsResourceTable.fillTable(CmsObject cms, java.util.List<CmsResource> resources, boolean clearFilter, boolean sort) Fills the resource table.
static java.lang.String	CmsResourceIcon.getDefaultFileOrDetailType(CmsObject cms, CmsResource resource) Returns the default file type or detail type for the given resource.
static java.lang.String	CmsResourceIcon.getDetailType(CmsObject cms, CmsResource detailPage, CmsResource parentFolder) Returns the detail content type for container pages that may be detail pages.
static com.vaadin.server.Resource	CmsResourceIcon.getSitemapResourceIcon(CmsObject cms, CmsResource resource, CmsResourceIcon.IconMode iconMode) Gets the resource icon for a resource for use in a CmsResourceInfo widget when used in a sitemap context.
void	CmsUserDataFormLayout.submit(CmsUser user, CmsObject cms, java.lang.Runnable afterWrite) Store fields to given user.
void	CmsUserDataFormLayout.submit(CmsUser user, CmsObject cms, java.lang.Runnable afterWrite, boolean force) Store fields to given user.

Constructors in org.opencms.ui.components with parameters of type CmsObject

Constructor and Description
CmsLockedResourcesList(CmsObject cms, java.util.List<CmsResource> resources, java.lang.String message, java.lang.Runnable nextAction, java.lang.Runnable cancelAction) Creates a new instance.

Uses of CmsObject in org.opencms.ui.components.categoryselect

Constructors in org.opencms.ui.components.categoryselect with parameters of type CmsObject

Constructor and Description
CmsCategoryTree(CmsObject cms, java.lang.String contextPath) Constructor.

Uses of CmsObject in org.opencms.ui.components.fileselect

Fields in org.opencms.ui.components.fileselect declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsFileSelectField.m_cms CmsObject instance, doesn't have to be set.
protected CmsObject	CmsResourceSelectDialog.m_currentCms The CMS context.

Methods in org.opencms.ui.components.fileselect with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsResourceTreeContainer.addTreeItem(CmsObject cms, CmsResource resource, CmsUUID parentId) Adds an item to the folder tree.
protected CmsResourceTreeTable	CmsResourceSelectDialog.createTree(CmsObject cms, CmsResource root) Creates the resource tree for the given root.
protected void	CmsResourceTreeContainer.fillProperties(CmsObject cms, com.vaadin.v7.data.Item resourceItem, CmsResource resource, CmsUUID parentId) Fills the properties of a tree item.
protected java.lang.String	CmsResourceTreeContainer.getName(CmsObject cms, CmsResource resource, CmsUUID parentId) Gets the name to display for the given resource.
void	CmsResourceTreeContainer.initRoot(CmsObject cms, CmsResource root) Initializes the root level of the tree.
void	CmsResourceTreeContainer.readTreeLevel(CmsObject cms, CmsUUID parentId) Reads the given tree level.
void	A_CmsFileSelectField.setCmsObject(CmsObject cms) Method to set cms object to make it possible to user other site context.
void	CmsResourceTreeContainer.update(CmsObject cms, CmsUUID id, CmsResourceFilter filter) Updates the item for the given structure id.
protected void	CmsResourceSelectDialog.updateRoot(CmsObject rootCms, CmsResource siteRootResource) Updates the current site root resource.

Constructors in org.opencms.ui.components.fileselect with parameters of type CmsObject

Constructor and Description
CmsNavigationFilter(CmsObject cms, CmsResource root) Creates a new instance.
CmsResourceSelectDialog(CmsResourceFilter filter, CmsObject cms) public constructor with given CmsObject.
CmsResourceSelectDialog(CmsResourceFilter filter, CmsObject cms, CmsResourceSelectDialog.Options options) public constructor.
CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceFilter filter) Creates a new instance.
CmsResourceTreeTable(CmsObject cms, CmsResource root, CmsResourceTreeContainer container) Creates a new instance.

Uses of CmsObject in org.opencms.ui.contextmenu

Methods in org.opencms.ui.contextmenu with parameters of type CmsObject

Modifier and Type	Method and Description
abstract CmsMenuItemVisibilityMode	A_CmsSimpleVisibilityCheck.getSingleVisibility(CmsObject cms, CmsResource resource) Computes visibility of the menu item for a single resource.
CmsMenuItemVisibilityMode	CmsStandardVisibilityCheck.getSingleVisibility(CmsObject cms, CmsResource resource)
CmsMenuItemVisibilityMode	A_CmsSimpleVisibilityCheck.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	CmsSubmenu.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
CmsMenuItemVisibilityMode	I_CmsContextMenuItem.getVisibility(CmsObject cms, java.util.List<CmsResource> resources) Computes the visibility for this context menu items with the given CMS context and resources.
CmsMenuItemVisibilityMode	I_CmsHasMenuItemVisibility.getVisibility(CmsObject cms, java.util.List<CmsResource> resources) Gets the visibility for the current resource and CMS context.
CmsMenuItemVisibilityMode	CmsMenuItemVisibilitySingleOnly.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)

Uses of CmsObject in org.opencms.ui.dialogs

Methods in org.opencms.ui.dialogs that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsEmbeddedDialogContext.getCms()

Methods in org.opencms.ui.dialogs with parameters of type CmsObject

Modifier and Type	Method and Description
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, java.util.List<CmsResource> selectedResources, boolean includeSiblings) Gets the broken links.
static com.google.common.collect.Multimap<CmsResource,CmsResource>	CmsDeleteDialog.getBrokenLinks(CmsObject cms, java.util.List<CmsResource> selectedResources, boolean includeSiblings, boolean reverse) Gets the broken links.

Uses of CmsObject in org.opencms.ui.dialogs.embedded

Methods in org.opencms.ui.dialogs.embedded with parameters of type CmsObject

Modifier and Type	Method and Description
I_CmsDataView	CmsDataViewParams.createViewInstance(CmsObject cms, java.util.Locale locale) Creates the data view instance.
CmsMenuItemVisibilityMode	CmsDataViewAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)

Uses of CmsObject in org.opencms.ui.dialogs.history

Methods in org.opencms.ui.dialogs.history with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsHistoryDialog.actionRestore(CmsObject cms, CmsUUID structureId, java.lang.Integer version) Restores a resource's state to the given version, but asks the user for confirmation beforehand.

Uses of CmsObject in org.opencms.ui.dialogs.history.diff

Methods in org.opencms.ui.dialogs.history.diff with parameters of type CmsObject

Modifier and Type	Method and Description
com.vaadin.ui.Button	CmsShowVersionButtons.createButton(CmsObject cms, CmsHistoryResourceBean version) Creates a 'show version' button.
com.google.common.base.Optional<com.vaadin.ui.Component>	CmsImageDiff.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
com.google.common.base.Optional<com.vaadin.ui.Component>	I_CmsDiffProvider.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2) Optionally returns a comparison component to display for the given resource versions.
com.google.common.base.Optional<com.vaadin.ui.Component>	CmsTextDiff.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
com.google.common.base.Optional<com.vaadin.ui.Component>	A_CmsAttributeDiff.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
com.google.common.base.Optional<com.vaadin.ui.Component>	CmsShowVersionButtons.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
com.google.common.base.Optional<com.vaadin.ui.Component>	CmsValueDiff.diff(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
static java.lang.String	CmsValueCompareBean.formatContentValueForDiffTable(CmsObject cms, CmsElementComparison comparison, java.lang.String origValue) Formats an xml content value string for display in the value comparison table.
abstract java.util.List<CmsAttributeComparison>	A_CmsAttributeDiff.getDifferences(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2) Gets the attribute comparison beans representing the differences.
java.util.List<CmsAttributeComparison>	CmsAttributeDiff.getDifferences(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
java.util.List<CmsAttributeComparison>	CmsPropertyDiff.getDifferences(CmsObject cms, CmsHistoryResourceBean v1, CmsHistoryResourceBean v2)
static CmsResource	A_CmsAttributeDiff.readResource(CmsObject cms, CmsHistoryResourceBean bean) Reads a historical resource for a history resource bean.

Constructors in org.opencms.ui.dialogs.history.diff with parameters of type CmsObject

Constructor and Description
CmsValueCompareBean(CmsObject cms, CmsElementComparison elemComp) Creates a new instance.

Uses of CmsObject in org.opencms.ui.dialogs.permissions

Methods in org.opencms.ui.dialogs.permissions with parameters of type CmsObject

Modifier and Type	Method and Description
static java.lang.String	CmsPermissionBean.getPrincipalNameFromACE(CmsObject cms, CmsAccessControlEntry entry) Get name of principal from ACE.
CmsAccessControlEntry	CmsPermissionBean.toAccessControlEntry(CmsObject cms, CmsUUID resID) Creates ACE from bean.

Constructors in org.opencms.ui.dialogs.permissions with parameters of type CmsObject

Constructor and Description
CmsPermissionViewTable(CmsObject cms, java.util.List<CmsAccessControlEntry> entries, boolean editable, boolean showRes, java.util.Map<CmsUUID,java.lang.String> parents, CmsPermissionDialog dialog) public constructor.

Uses of CmsObject in org.opencms.ui.editors.messagebundle

Methods in org.opencms.ui.editors.messagebundle with parameters of type CmsObject

Modifier and Type	Method and Description
static CmsResource	CmsMessageBundleEditorTypes.getDescriptor(CmsObject cms, java.lang.String basename) Returns the bundle descriptor for the bundle with the provided base name.

Constructors in org.opencms.ui.editors.messagebundle with parameters of type CmsObject

Constructor and Description
CmsMessageBundleEditorModel(CmsObject cms, CmsResource resource)

Uses of CmsObject in org.opencms.ui.error

Methods in org.opencms.ui.error with parameters of type CmsObject

Modifier and Type	Method and Description
static java.lang.String	CmsErrorUI.getBootstrapPage(CmsObject cms, java.lang.Throwable throwable, javax.servlet.http.HttpServletRequest request) Returns the error bootstrap page HTML.

Uses of CmsObject in org.opencms.ui.favorites

Methods in org.opencms.ui.favorites with parameters of type CmsObject

Modifier and Type	Method and Description
java.lang.String	CmsFavoriteEntry.updateContextAndGetFavoriteUrl(CmsObject cms) Prepares the CmsObject for jumping to this favorite location, and returns the appropriate URL.

Constructors in org.opencms.ui.favorites with parameters of type CmsObject

Constructor and Description
CmsExplorerFavoriteContext(CmsObject cms, CmsFileExplorer explorer) Creates a new instance.
CmsFavoriteDAO(CmsObject cms) Creates a new instance.
CmsFavoriteDAO(CmsObject cms, java.lang.String userName) Creates a new instance.

Uses of CmsObject in org.opencms.ui.login

Methods in org.opencms.ui.login that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsLoginController.UserAgreementHelper.getCms()

Methods in org.opencms.ui.login with parameters of type CmsObject

Modifier and Type	Method and Description
static void	CmsTokenValidator.clearToken(CmsObject cms, CmsUser user) Removes an authorization token from the user's additional information.
static java.lang.String	CmsTokenValidator.createToken(CmsObject cms, CmsUser user, long currentTime) Creates a new token for the given user and stores it in the user's additional info.
static java.lang.String	CmsLoginUI.generateLoginHtmlFragment(CmsObject cms, com.vaadin.server.VaadinRequest request) Returns the bootstrap html fragment required to display the login dialog.
static java.lang.String	CmsLoginHelper.getDirectEditPath(CmsObject cms, CmsUserSettings userSettings, boolean forceDirectEdit) Returns the direct edit path from the user settings, or null if not set.
static java.lang.String	CmsLoginController.getFormLink(CmsObject cms) Returns the link to the login form.
static CmsLoginHelper.LoginParameters	CmsLoginHelper.getLoginParameters(CmsObject cms, javax.servlet.http.HttpServletRequest request, boolean workplaceUiRequest) Returns the login parameters for the current request.
static java.lang.String	CmsLoginController.getLoginTarget(CmsObject currentCms, CmsWorkplaceSettings settings, java.lang.String requestedResource) Gets the login target link.
static java.util.List<CmsOrganizationalUnit>	CmsLoginHelper.getOrgUnitsForLoginDialog(CmsObject cms, java.lang.String predefOu) Gets the list of OUs which should be selectable in the login dialog.
static java.lang.String	CmsLoginHelper.getStartView(CmsObject cms) Returns the start view.
static CmsWorkplaceSettings	CmsLoginHelper.initSiteAndProject(CmsObject cms) Initializes the site and project for a CMS context after login, and returns the workplace settings for the corresponding user.
java.lang.String	CmsLockInactiveAccountsJob.launch(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> parameters)
static void	CmsLoginController.logout(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Logs out the current user redirecting to the login form afterwards.
static boolean	CmsForgotPasswordDialog.sendPasswordResetLink(CmsObject cms, java.lang.String fullUserName, java.lang.String email) Tries to find a user with the given email address, and if one is found, sends a mail with the password reset link to them.
static void	CmsLoginUI.setAdminCmsObject(CmsObject cms) Sets the admin CMS object.
java.lang.String	CmsTokenValidator.validateToken(CmsObject cms, java.lang.String token, long maxAgeMillis) Validates the authentication token against the token stored in the user's additional info.

Constructors in org.opencms.ui.login with parameters of type CmsObject

Constructor and Description
CmsChangePasswordDialog(CmsObject cms, CmsUser user, java.util.Locale locale) Creates a new instance.
CmsLoginController(CmsObject adminCms, CmsLoginHelper.LoginParameters params) Creates a new instance.
CmsPasswordChangeNotification(CmsObject cms, CmsUser receiver, java.lang.String link, java.lang.String expiration) Creates a new instance.
CmsSetPasswordDialog(CmsObject cms, CmsUser user, java.util.Locale locale) Creates a new instance.
UserAgreementHelper(CmsObject cms, CmsWorkplaceSettings wpSettings) Creates a new instance.

Uses of CmsObject in org.opencms.ui.sitemap

Methods in org.opencms.ui.sitemap that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsSitemapTreeController.DialogContext.getCms()

Methods in org.opencms.ui.sitemap with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsSitemapTreeNodeData.initialize(CmsObject cms) Initializes the bean.

Constructors in org.opencms.ui.sitemap with parameters of type CmsObject

Constructor and Description
CmsSitemapTreeController(CmsObject cms, CmsResource root, I_CmsLocaleCompareContext context, com.vaadin.ui.Component parent) Creates a new instance.
CmsSitemapTreeDataProvider(CmsObject cms, CmsResource root, I_CmsLocaleCompareContext context) Creates a new instance.
TargetInfo(CmsObject cms, java.lang.String path) Creates a new instance.

Uses of CmsObject in org.opencms.ui.util

Constructors in org.opencms.ui.util with parameters of type CmsObject

Constructor and Description
CmsNewResourceBuilder(CmsObject cms) Creates a new instance.
PropertyEditorHelper(CmsObject cms) Creates a new instance.

Uses of CmsObject in org.opencms.util

Fields in org.opencms.util declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	CmsMacroResolver.m_cms The OpenCms user context to use for resolving macros.

Methods in org.opencms.util with parameters of type CmsObject

Modifier and Type	Method and Description
static void	CmsFileUtil.checkResources(CmsObject cms, java.util.List<java.lang.String> resources) Checks if all resources are present.
static void	CmsMacroResolver.copyAndResolveMacro(CmsObject cms, java.lang.String source, java.lang.String destination, java.util.Map<java.lang.String,java.lang.String> keyValue, boolean adjustLinks) Copies resources, adjust internal links (if adjustLinks==true) and resolves macros (if keyValue map is set).
static void	CmsMacroResolver.copyAndResolveMacro(CmsObject cms, java.lang.String source, java.lang.String destination, java.util.Map<java.lang.String,java.lang.String> keyValue, boolean adjustLinks, CmsResource.CmsResourceCopyMode copyMode) Copies resources, adjust internal links (if adjustLinks==true) and resolves macros (if keyValue map is set).
static void	CmsMacroResolver.copyAndResolveMacro(CmsObject cms, java.lang.String source, java.lang.String destination, java.util.Map<java.lang.String,java.lang.String> keyValue, boolean adjustLinks, CmsResource.CmsResourceCopyMode copyMode, I_CmsReport report) Copies resources, adjust internal links (if adjustLinks==true) and resolves macros (if keyValue map is set).
org.owasp.validator.html.AntiSamy	CmsParameterEscaper.createAntiSamy(CmsObject cms, java.lang.String policyPath) Creates a new AntiSamy instance for a given policy path.
static void	CmsVfsUtil.createFolder(CmsObject cms, java.lang.String rootPath) Creates a folder and its parent folders if they don't exist.
void	CmsParameterEscaper.enableAntiSamy(CmsObject cms, java.lang.String policyPath, java.util.Set<java.lang.String> params) Enables the AntiSamy HTML cleaning for some parameters.
static java.util.Map<java.lang.String,java.lang.String[]>	CmsMacroResolver.getBundleMapFromResources(java.util.Properties resourceBundle, CmsResource descriptor, CmsObject clonedCms) Reads a bundle (key, value, descriptor) from Descriptor Resource and property resource.
static java.lang.String	CmsHtmlConverter.getConversionSettings(CmsObject cms, CmsResource resource) Reads the content conversion property of a given resource and returns its value.
static java.lang.String	CmsFileUtil.getEncoding(CmsObject cms, CmsResource file) Returns the encoding of the file.
static I_CmsMacroResolver	CmsMacroResolver.newWorkplaceLocaleResolver(CmsObject cms) Returns a new macro resolver that loads message keys from the workplace bundle in the user setting's language.
static org.owasp.validator.html.Policy	CmsParameterEscaper.readPolicy(CmsObject cms, java.lang.String sitePath) Helper method for reading an AntiSamy policy file from the VFS.
static java.lang.String	CmsMacroResolver.resolveMacros(java.lang.String input, CmsObject cms, CmsMessages messages) Resolves the macros in the given input using the provided parameters.
CmsMacroResolver	CmsMacroResolver.setCmsObject(CmsObject cms) Provides an OpenCms user context to this macro resolver, required to resolve certain macros.
static java.lang.String	CmsXsltUtil.transformCsvContent(CmsObject cms, java.lang.String xsltFile, java.lang.String csvContent, java.lang.String delimiter) Changes content from CSV to xml/html.
static java.lang.String	CmsXsltUtil.transformXmlContent(CmsObject cms, java.lang.String xsltFile, java.lang.String xmlContent) Applies a XSLT Transformation to the content.

Uses of CmsObject in org.opencms.widgets

Methods in org.opencms.widgets with parameters of type CmsObject

Modifier and Type	Method and Description
protected void	CmsHtmlWidget.addEmbeddedGalleryOptions(JSONObject result, CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Adds the configuration for embedded gallery widgets the the JSON object.
protected JSONObject	CmsAdeImageGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
protected JSONObject	CmsAdeDownloadGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
protected abstract JSONObject	A_CmsAdeGalleryWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param) Returns additional widget information encapsulated in a JSON object.
protected JSONObject	CmsVfsImageWidget.getAdditionalGalleryInfo(CmsObject cms, java.lang.String resource, CmsMessages messages, I_CmsWidgetParameter param)
java.lang.String	CmsSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsPrincipalWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsColorpickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsPasswordWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	I_CmsADEWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the configuration string for the ADE content editor widget.
java.lang.String	CmsLocalizationWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsHtmlWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDisplayWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsTypeComboWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCategoryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsMultiSelectGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsTextareaWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsGroupWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsFormatterWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsAdeGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsSerialDateWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue contentValue, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsLocationPickerWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsOrgUnitWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	A_CmsGalleryWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCheckboxWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsVfsFileWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDisplayTypeSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsDependentSelectWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsInputWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.lang.String	CmsCalendarWidget.getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
java.util.List<java.lang.String>	CmsSelectGroupWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsPrincipalWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsSelectWidget.getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
java.util.List<java.lang.String>	CmsColorpickerWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsPasswordWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	I_CmsADEWidget.getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
java.util.List<java.lang.String>	CmsLocalizationWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsHtmlWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsDisplayWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsTypeComboWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCategoryWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsTextareaWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsGroupWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsAdeGalleryWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsSerialDateWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsLocationPickerWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsOrgUnitWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsGalleryWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCheckboxWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsAddFormatterWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsVfsFileWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsInputWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCalendarWidget.getCssResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsRemoveFormatterWidget.getCssResourceLinks(CmsObject cms)
java.lang.String	I_CmsWidgetParameter.getDefault(CmsObject cms) Returns the default value of this parameter.
protected java.util.Locale	CmsCategoryWidget.getDefaultLocale(CmsObject cms, java.lang.String resource) Returns the default locale in the content of the given resource.
static java.lang.String	CmsVfsFileWidget.getDefaultSearchTypes(CmsObject cms, CmsResource resource) Returns a comma separated list of the default search type names.
java.lang.String	CmsComboWidget.getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	I_CmsWidget.getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the html to include at the end of the dialog for this widget.
java.lang.String	A_CmsWidget.getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter value)
java.lang.String	CmsPrincipalWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsColorpickerWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsHtmlWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsCategoryWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsMultiSelectGroupWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsGroupWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsOrgUnitWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	A_CmsGalleryWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsVfsImageWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsComboWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	I_CmsWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
java.lang.String	A_CmsWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsVfsFileWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsUserWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsCalendarWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsMultiSelectWidget.getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsColorpickerWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsHtmlWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	A_CmsGalleryWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsComboWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	I_CmsWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialisation method JavaScript code for this widget.
java.lang.String	A_CmsWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsVfsFileWidget.getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsColorpickerWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsHtmlWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	A_CmsGalleryWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	I_CmsWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialization method JavaScript code for this widget.
java.lang.String	A_CmsWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsVfsFileWidget.getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
java.lang.String	CmsSelectOnChangeReloadWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsPrincipalWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsColorpickerWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsPasswordWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsLocalizationWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsHtmlWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsDisplayWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsCategoryWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsMultiSelectGroupWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsTextareaWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsGroupWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsHttpUploadWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	A_CmsAdeGalleryWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsSerialDateWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsLocationPickerWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsSelectWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsOrgUnitWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	A_CmsGalleryWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsVfsImageWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsComboWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsRadioSelectWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	I_CmsWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	CmsCheckboxWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsVfsFileWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsInputWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsUserWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsCalendarWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsMultiSelectWidget.getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected abstract java.util.List<CmsSelectWidgetOption>	A_CmsFormatterWidget.getFormatterOptions(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved) Gets the options corresponding to external (non-schema) formatters.
protected java.util.List<CmsSelectWidgetOption>	CmsAddFormatterWidget.getFormatterOptions(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved)
protected java.util.List<CmsSelectWidgetOption>	CmsRemoveFormatterWidget.getFormatterOptions(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved)
protected static java.util.List<CmsSelectWidgetOption>	CmsAddFormatterWidget.getFormatterOptionsStatic(CmsObject cms, CmsADEConfigData config, java.lang.String rootPath, boolean allRemoved) Gets the options corresponding to external (non-schema) formatters.
java.util.List<java.lang.String>	I_CmsImageWidgetDynamicConfiguration.getFormatValues(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.util.List<CmsSelectWidgetOption> selectFormat, java.util.List<java.lang.String> formatValues) Returns the matching format values for the given format select options.
protected java.util.Map<java.lang.String,java.lang.String>	A_CmsAdeGalleryWidget.getGalleryOpenParams(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String resource, long hashId) Returns the required gallery open parameters.
protected java.util.Map<java.lang.String,java.lang.String>	CmsVfsImageWidget.getGalleryOpenParams(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String resource, long hashId)
java.lang.String	CmsDisplayWidget.getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsLocationPickerWidget.getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	I_CmsWidget.getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Creates the HTML code for the help bubble for this widget.
java.lang.String	A_CmsWidget.getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.util.List<java.lang.String>	CmsSelectGroupWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsPrincipalWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsSelectWidget.getJavaScriptResourceLinks(CmsObject cms) Returns a list of java script resources required by the widget.
java.util.List<java.lang.String>	CmsColorpickerWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsPasswordWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	I_CmsADEWidget.getJavaScriptResourceLinks(CmsObject cms) Returns a list of java script resources required by the widget.
java.util.List<java.lang.String>	CmsLocalizationWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsHtmlWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsDisplayWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsTypeComboWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCategoryWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsTextareaWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsGroupWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsAdeGalleryWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsSerialDateWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsLocationPickerWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsOrgUnitWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	A_CmsGalleryWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCheckboxWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsAddFormatterWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsVfsFileWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsInputWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsCalendarWidget.getJavaScriptResourceLinks(CmsObject cms)
java.util.List<java.lang.String>	CmsRemoveFormatterWidget.getJavaScriptResourceLinks(CmsObject cms)
protected JSONObject	CmsVfsFileWidget.getJsonConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Gets the JSON configuration.
protected JSONObject	A_CmsAdeGalleryWidget.getJSONConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the gallery widget configuration as a JSON object.
static JSONObject	CmsHtmlWidget.getJSONConfiguration(CmsHtmlWidgetOption widgetOptions, CmsObject cms, CmsResource resource, java.util.Locale contentLocale) Returns the WYSIWYG editor configuration as a JSON object.
protected JSONObject	CmsHtmlWidget.getJSONConfiguration(CmsObject cms, CmsResource resource, java.util.Locale contentLocale) Returns the WYSIWYG editor configuration as a JSON object.
protected java.lang.String	A_CmsAdeGalleryWidget.getOpenGalleryCall(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, long hashId) Returns the javascript call to open the gallery widget dialog.
protected CmsResource	CmsCategoryWidget.getResource(CmsObject cms, I_CmsWidgetParameter param) Returns the right resource, depending on the locale.
protected java.lang.String	A_CmsSelectWidget.getResourcePath(CmsObject cms, I_CmsWidgetDialog dialog) Gets the resource path for the given dialog.
abstract java.util.List<java.lang.String>	A_CmsNativeComplexWidget.getScripts(CmsObject cms) Gets the list of URLs of scripts which the widget reuires.
protected java.lang.String	A_CmsSelectWidget.getSelectedValue(CmsObject cms, I_CmsWidgetParameter param) Returns the currently selected value of the select widget.
protected java.lang.String	CmsVfsImageWidget.getSelectedValue(CmsObject cms, java.util.List<CmsSelectWidgetOption> selectOptions, java.lang.String currentValue) Returns the currently selected value of the select widget.
protected java.util.List<java.lang.String>	A_CmsSelectWidget.getSelectedValues(CmsObject cms, I_CmsWidgetParameter param) Returns the currently selected values of the select widget.
static java.util.List<java.lang.String>	CmsAddFormatterWidget.getSelectOptionValues(CmsObject cms, java.lang.String rootPath, boolean allRemoved) Returns all values that can be selected in the widget.
java.lang.String	CmsCategoryWidget.getStartingCategory(CmsObject cms, java.lang.String referencePath) Returns the starting category depending on the configuration options.
java.lang.String	I_CmsImageWidgetDynamicConfiguration.getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the required information for the initial image list to load.
java.lang.String	I_CmsGalleryWidgetDynamicConfiguration.getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the required information for the initial item list to load.
java.lang.String	I_CmsWidgetParameter.getStringValue(CmsObject cms) Returns the value of this parameter.
abstract java.util.List<java.lang.String>	A_CmsNativeComplexWidget.getStyleSheets(CmsObject cms) Gets the list of URLs of stylesheets which are required by the widget.
protected java.lang.String	CmsVfsFileWidget.getTreeToken(CmsObject cms, A_CmsXmlContentValue value, CmsResource resource, java.util.Locale contentLocale) Computes the tree token, which is used to decide which preloaded tree, if any, to load for the VFS/sitemap tabs.
java.lang.String	I_CmsImageWidgetDynamicConfiguration.getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the type of the initial image list to load, either gallery or category.
java.lang.String	I_CmsGalleryWidgetDynamicConfiguration.getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the type of the initial item list to load, either gallery or category.
protected abstract java.util.List<CmsSelectWidgetOption>	A_CmsFormatterWidget.getTypeOptions(CmsObject cms, CmsADEConfigData config, boolean allRemoved) Gets the options corresponding to the schemas which define formatters.
protected java.util.List<CmsSelectWidgetOption>	CmsAddFormatterWidget.getTypeOptions(CmsObject cms, CmsADEConfigData adeConfig, boolean allRemoved)
protected java.util.List<CmsSelectWidgetOption>	CmsRemoveFormatterWidget.getTypeOptions(CmsObject cms, CmsADEConfigData adeConfig, boolean allRemoved)
protected static java.util.List<CmsSelectWidgetOption>	CmsAddFormatterWidget.getTypeOptionsStatic(CmsObject cms, CmsADEConfigData adeConfig, boolean allRemoved) Gets the options corresponding to the schemas which define formatters.
protected CmsVfsImageWidgetConfiguration	CmsAdeImageGalleryWidget.getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
protected CmsGalleryWidgetConfiguration	A_CmsAdeGalleryWidget.getWidgetConfiguration(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the widget configuration.
CmsComplexWidgetData	CmsDefaultComplexWidget.getWidgetData(CmsObject cms)
CmsComplexWidgetData	CmsDataViewWidget.getWidgetData(CmsObject cms)
CmsComplexWidgetData	I_CmsComplexWidget.getWidgetData(CmsObject cms) Gets the data needed for the editor to render the complex widget.
CmsComplexWidgetData	A_CmsNativeComplexWidget.getWidgetData(CmsObject cms)
static CmsSelectWidgetOption	A_CmsFormatterWidget.getWidgetOptionForFormatter(CmsObject cms, I_CmsFormatterBean formatter) Creates a widget option corresponding to a formatter bean for an external formatter.
static CmsSelectWidgetOption	A_CmsFormatterWidget.getWidgetOptionForType(CmsObject cms, java.lang.String typeName) Creates a widget option for a resource type.
java.lang.String	CmsSelectWidget.getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsVfsImageWidget.getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	I_CmsWidget.getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.
java.lang.String	A_CmsWidget.getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
java.lang.String	CmsCalendarWidget.getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected void	CmsVfsImageWidgetConfiguration.init(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Initializes the widget configuration using the given configuration string.
protected void	CmsGalleryWidgetConfiguration.init(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param, java.lang.String configuration) Initializes the widget configuration using the given configuration string.
protected void	CmsLocalizationWidget.initConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType) Initializes the localized bundle to get the value from, the optional key name and the optional locale.
protected void	CmsLocalizationWidget.initConfiguration(CmsObject cms, I_CmsWidgetParameter param) Initializes the localized bundle to get the value from, the optional key name and the optional locale.
protected java.util.List<CmsSelectWidgetOption>	CmsSelectGroupWidget.parseSelectOptions(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
protected java.util.List<CmsSelectWidgetOption>	CmsMultiSelectGroupWidget.parseSelectOptions(CmsObject cms, CmsMessages messages, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	CmsSelectGroupWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	CmsElementViewSelectWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	A_CmsSelectWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Returns the list of configured select options, parsing the configuration String if required.
protected java.util.List<CmsSelectWidgetOption>	CmsMultiSelectGroupWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	A_CmsFormatterWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	CmsDisplayTypeSelectWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	CmsUserWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
protected java.util.List<CmsSelectWidgetOption>	A_CmsFormatterWidget.parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param, boolean allRemoved) Returns the list of configured select options, parsing the configuration String if required.
void	A_CmsHtmlWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsColorpickerWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsLocalizationWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsHtmlWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsCategoryWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsMultiSelectGroupWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsTextareaWidgetPlaintext.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsVfsImageWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	I_CmsWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.
void	A_CmsWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsCheckboxWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsCalendarWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsMultiSelectWidget.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
void	CmsInputWidgetPlaintext.setEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
static void	CmsMultiSelectWidget.setMultiSelectEditorValue(CmsObject cms, java.util.Map<java.lang.String,java.lang.String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of the widget parameter from the provided form parameters.
void	I_CmsWidgetParameter.setStringValue(CmsObject cms, java.lang.String value) Sets the value of this parameter.

Constructors in org.opencms.widgets with parameters of type CmsObject

Constructor and Description
CmsGalleryWidgetConfiguration(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Generates an initialized configuration for the gallery item widget using the given configuration string.
CmsVfsImageWidgetConfiguration(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.lang.String configuration) Generates an initialized configuration for the image widget using the given configuration string.
SearchTypesFactory(CmsObject cms, CmsResource resource) Constructor.

Uses of CmsObject in org.opencms.widgets.dataview

Methods in org.opencms.widgets.dataview with parameters of type CmsObject

Modifier and Type	Method and Description
void	I_CmsDataView.initialize(CmsObject cms, java.lang.String configData, java.util.Locale locale) Initializes this data view instance.

Uses of CmsObject in org.opencms.workflow

Fields in org.opencms.workflow declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsWorkflowManager.m_adminCms The CMS context with admin privileges.

Methods in org.opencms.workflow with parameters of type CmsObject

Modifier and Type	Method and Description
protected CmsWorkflowResponse	CmsDefaultWorkflowManager.actionForcePublish(CmsObject userCms, CmsPublishOptions options, java.util.List<CmsResource> resources) The implementation of the "forcepublish" workflow action.
protected CmsWorkflowResponse	CmsDefaultWorkflowManager.actionPublish(CmsObject userCms, CmsPublishOptions options, java.util.List<CmsResource> resources) The implementation of the "publish" workflow action.
protected CmsWorkflowResponse	CmsExtendedWorkflowManager.actionRelease(CmsObject userCms, java.util.List<CmsResource> resources) Implementation of the 'release' workflow action.
protected void	CmsExtendedWorkflowManager.checkNewParentsInList(CmsObject userCms, java.util.List<CmsResource> resources) Checks that the parent folders of new resources which are released are either not new or are also released.
I_CmsPublishResourceFormatter	CmsDefaultWorkflowManager.createFormatter(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options)
I_CmsPublishResourceFormatter	I_CmsWorkflowManager.createFormatter(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Creates the formatter for formatting the resources to be displayed to the user.
I_CmsPublishResourceFormatter	CmsExtendedWorkflowManager.createFormatter(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options)
static CmsProjectBean	CmsDefaultWorkflowManager.createProjectBeanFromProject(CmsObject cms, CmsProject project) Creates a project bean from a real project.
CmsWorkflowResponse	CmsDefaultWorkflowManager.executeAction(CmsObject cms, CmsWorkflowAction action, CmsPublishListToken token)
CmsWorkflowResponse	I_CmsWorkflowManager.executeAction(CmsObject cms, CmsWorkflowAction action, CmsPublishListToken token) Executes a workflow action for a publish list token instead of a resource list.
CmsWorkflowResponse	CmsDefaultWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, java.util.List<CmsResource> resources)
CmsWorkflowResponse	I_CmsWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, java.util.List<CmsResource> resources) Executes a workflow action in the context of the current user.
CmsWorkflowResponse	CmsExtendedWorkflowManager.executeAction(CmsObject userCms, CmsWorkflowAction action, CmsPublishOptions options, java.util.List<CmsResource> resources)
protected java.lang.String	CmsExtendedWorkflowManager.generateProjectDescription(CmsObject userCms) Generates the description for a new workflow project based on the user for whom it is created.
protected java.lang.String	CmsExtendedWorkflowManager.generateProjectName(CmsObject userCms) Generates the name for a new workflow project based on the user for whom it is created.
protected java.lang.String	CmsExtendedWorkflowManager.generateProjectName(CmsObject userCms, boolean shortTime) Generates the name for a new workflow project based on the user for whom it is created.
java.lang.String	CmsDefaultWorkflowManager.getLabel(CmsObject cms, java.lang.String key) Gets the localized label for a given CMS context and key.
protected java.util.Locale	A_CmsWorkflowManager.getLocale(CmsObject userCms) Gets the locale to use for a given CMS context.
java.util.List<CmsProjectBean>	CmsDefaultWorkflowManager.getManageableProjects(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params)
java.util.List<CmsProjectBean>	I_CmsWorkflowManager.getManageableProjects(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params) Returns the current user's manageable projects.
protected java.lang.String	CmsExtendedWorkflowManager.getNotificationResource(CmsObject cms) Gets the resource notification content path.
protected static java.lang.String	CmsDefaultWorkflowManager.getOuAwareName(CmsObject cms, java.lang.String name) Returns the simple name if the ou is the same as the current user's ou.
static java.lang.String	CmsDefaultPublishResourceFormatter.getOuAwareName(CmsObject cms, java.lang.String name) Returns the simple name if the ou is the same as the current user's ou.
protected CmsWorkflowResponse	CmsExtendedWorkflowManager.getPublishBrokenRelationsResponse(CmsObject userCms, java.util.List<CmsPublishResource> publishResources) Helper method for generating the workflow response which should be sent when publishing the resources would break relations.
CmsPublishListToken	CmsDefaultWorkflowManager.getPublishListToken(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options)
CmsPublishListToken	I_CmsWorkflowManager.getPublishListToken(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options) Gets a publish list token for the given parameters which can be used later to reconstruct the publish list.
java.util.List<CmsResource>	CmsExtendedRealProjectWrapper.getResources(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String workflowId)
CmsWorkflowResources	CmsDefaultWorkflowManager.getWorkflowResources(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options, boolean canOverride, boolean ignoreLimit)
CmsWorkflowResources	I_CmsWorkflowManager.getWorkflowResources(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options, boolean canOverride, boolean ignoreLimit) Returns the resources for the given workflow and project.
CmsWorkflowResources	CmsExtendedWorkflowManager.getWorkflowResources(CmsObject cms, CmsWorkflow workflow, CmsPublishOptions options, boolean canOverrideWorkflow, boolean ignoreLimit)
java.util.Map<java.lang.String,CmsWorkflow>	CmsDefaultWorkflowManager.getWorkflows(CmsObject cms)
java.util.Map<java.lang.String,CmsWorkflow>	I_CmsWorkflowManager.getWorkflows(CmsObject cms) Returns the available workflows for the current user.
java.util.Map<java.lang.String,CmsWorkflow>	CmsExtendedWorkflowManager.getWorkflows(CmsObject cms)
void	CmsDefaultWorkflowManager.initialize(CmsObject adminCms)
void	A_CmsWorkflowManager.initialize(CmsObject adminCms)
void	I_CmsWorkflowManager.initialize(CmsObject adminCms) Initializes this workflow manager instance.
void	CmsExtendedWorkflowManager.initialize(CmsObject adminCms)
protected boolean	CmsExtendedWorkflowManager.isProjectManager(CmsObject userCms) Checks whether the user for a given CMS context can manage workflow projects.
protected void	CmsExtendedWorkflowManager.sendNotification(CmsObject userCms, CmsUser recipient, CmsProject workflowProject, java.util.List<CmsResource> resources) Sends the notification for released resources.

Constructors in org.opencms.workflow with parameters of type CmsObject

Constructor and Description
CmsDefaultPublishResourceFormatter(CmsObject cms) Constructor.
CmsExtendedPublishResourceFormatter(CmsObject cms) Constructor.
CmsWorkflowNotification(CmsObject adminCms, CmsObject userCms, CmsUser receiver, java.lang.String notificationContent, CmsProject project, java.util.List<CmsResource> resources, java.lang.String link) Creates a new workflow notification mail object.

Uses of CmsObject in org.opencms.workplace

Methods in org.opencms.workplace that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsWorkplace.getCms() Returns the initialized cms object for the current user.
CmsObject	CmsWorkplaceAction.getCmsAdminObject() Gets the admin cmsObject.

Methods in org.opencms.workplace with parameters of type CmsObject

Modifier and Type	Method and Description
static boolean	CmsWorkplace.canEditPermissionsForRoles(CmsObject cms, java.lang.String path) Checks if permissions for roles should be editable for the current user on the resource with the given path.
void	CmsWorkplaceManager.checkWorkplaceRequest(javax.servlet.http.HttpServletRequest request, CmsObject cms) Checks whether the workplace is accessed through the workplace server, and sends an error message otherwise.
java.lang.String	CmsWorkplaceManager.createTempFile(CmsObject cms, java.lang.String resourceName, CmsUUID currentProjectId) Creates a temporary file which is needed while working in an editor with preview option.
static java.lang.String	CmsWorkplace.generateCssStyle(CmsObject cms) Returns the style sheets for the report.
static java.lang.String	CmsWorkplace.generatePageStartExtended(CmsObject cms, java.lang.String encoding) Generates the header for the extended report view.
long	CmsWorkplaceManager.getFileBytesMaxUploadSize(CmsObject cms) Returns the value (in bytes) for the maximum file upload size of the current user.
java.lang.String	CmsRepositoryFolderHandler.getRepositoryFolder(CmsObject cms, java.lang.String reference, java.lang.String type)
java.lang.String	I_CmsRepositoryFolderHandler.getRepositoryFolder(CmsObject cms, java.lang.String reference, java.lang.String type) Returns the repository folder to store new contents in.
static java.lang.String	CmsWorkplace.getStartSiteRoot(CmsObject cms, CmsUserSettings userSettings) Returns the start site from the given user settings.
static java.lang.String	CmsWorkplace.getStartSiteRoot(CmsObject cms, CmsWorkplaceSettings settings) Returns the start site from the given workplace settings.
java.lang.String	CmsWorkplaceManager.getUploadHook(CmsObject cms, java.lang.String uploadFolder) Gets the upload hook URI which should be opened for an upload to a given folder.
java.lang.String	I_CmsPostUploadDialogHandler.getUploadHook(CmsObject cms, java.lang.String uploadFolderSitePath) Gets the upload hook URI.
static java.lang.String	CmsWorkplace.getWorkplaceExplorerLink(CmsObject cms, java.lang.String explorerRootPath) Creates a link for the OpenCms workplace that will reload the whole workplace, switch to the explorer view, the site of the given explorerRootPath and show the folder given in the explorerRootPath.
java.util.Locale	CmsWorkplaceManager.getWorkplaceLocale(CmsObject cms) Returns the workplace locale from the current user's settings.
static CmsWorkplaceSettings	CmsWorkplace.getWorkplaceSettings(CmsObject cms, javax.servlet.http.HttpServletRequest req) Returns the workplace settings of the current user.
void	CmsWorkplaceManager.initHandler(CmsObject cms)
void	CmsWorkplaceManager.initialize(CmsObject cms) Initializes the workplace manager with the OpenCms system configuration.
void	CmsWorkplaceAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)
CmsResource	CmsWorkplaceLoginHandler.initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
static CmsWorkplaceSettings	CmsWorkplace.initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.
protected void	CmsWorkplace.initWorkplaceMembers(CmsObject cms, javax.servlet.http.HttpSession session) Initializes this workplace class instance.
static CmsWorkplaceSettings	CmsWorkplace.initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project).
void	CmsWorkplaceSettings.setExplorerResource(java.lang.String value, CmsObject cms) Sets the current resource to be displayed in the explorer.
void	CmsWorkplaceManager.setFileViewSettings(CmsObject cms, CmsRfsFileViewer fileViewSettings) Sets the system-wide file view settings for the workplace.
static void	CmsWorkplace.updateUserPreferences(CmsObject cms, javax.servlet.http.HttpServletRequest req) Updates the user preferences after changes have been made.

Constructors in org.opencms.workplace with parameters of type CmsObject

Constructor and Description
CmsWorkplace(CmsObject cms, javax.servlet.http.HttpSession session) Constructor in case no page context is available.

Uses of CmsObject in org.opencms.workplace.comparison

Methods in org.opencms.workplace.comparison with parameters of type CmsObject

Modifier and Type	Method and Description
static java.util.List<CmsAttributeComparison>	CmsResourceComparison.compareAttributes(CmsObject cms, CmsResource resource1, CmsResource resource2) Helper method that collects all meta attributes of the two file versions and finds out, which of the attributes were added, removed, modified or remain unchanged.
static java.util.List<CmsAttributeComparison>	CmsResourceComparison.compareProperties(CmsObject cms, CmsResource resource1, java.lang.String version1, CmsResource resource2, java.lang.String version2) Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.
static java.lang.String	CmsHistoryListUtil.getHistoryLink(CmsObject cms, CmsUUID structureId, java.lang.String version) Returns the link to an historical file.

Constructors in org.opencms.workplace.comparison with parameters of type CmsObject

Constructor and Description
CmsXmlDocumentComparison(CmsObject cms, CmsFile res1, CmsFile res2) Creates a new xml document comparison.

Uses of CmsObject in org.opencms.workplace.editors

Methods in org.opencms.workplace.editors that return CmsObject

Modifier and Type	Method and Description
protected CmsObject	CmsEditor.getCloneCms() Returns a cloned cms instance that prevents the time range resource filter check.

Methods in org.opencms.workplace.editors with parameters of type CmsObject

Modifier and Type	Method and Description
static boolean	CmsWorkplaceEditorManager.checkAcaciaEditorAvailable(CmsObject cms, CmsResource resource) Checks whether GWT widgets are available for all fields of a content.
static java.util.List<CmsDialogElement>	CmsDialogElements.computeElements(CmsObject cms, CmsXmlPage xmlPage, java.lang.String xmlPageUri, java.util.Locale locale) Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided xmlPage.
static java.util.List<CmsDialogElement>	CmsDialogElements.computeElements(CmsObject cms, java.lang.String xmlPageUri, java.util.Locale locale) Creates a list of possible elements of a template from the template property "template-elements" and the elements available in the provided resource file.
java.util.Properties	CmsEditorDisplayOptions.getDisplayOptions(CmsObject cms) Reads the editor configuration file valid for the current user and caches the result in a Map.
java.lang.String	CmsWorkplaceEditorManager.getEditorParameter(CmsObject cms, java.lang.String editor, java.lang.String param) Gets the value of a global editor configuration parameter.
java.lang.String	CmsEditorHandler.getEditorUri(CmsObject cms, java.lang.String resourceType, java.lang.String userAgent, boolean loadDefault)
java.lang.String	I_CmsEditorHandler.getEditorUri(CmsObject cms, java.lang.String resourceType, java.lang.String userAgent, boolean loadDefault) Returns the editor URI which will be used for the selected resource type.
protected java.lang.String	CmsEditor.getFileEncoding(CmsObject cms, java.lang.String filename) Helper method to determine the encoding of the given file in the VFS, which must be set using the "content-encoding" property.
java.lang.String	CmsEditorCssHandlerDefault.getUriStyleSheet(CmsObject cms, java.lang.String editedResourcePath)
java.lang.String	I_CmsEditorCssHandler.getUriStyleSheet(CmsObject cms, java.lang.String editedResourcePath) Returns the absolute VFS path of the CSS style sheet to use.
boolean	CmsEditorCssHandlerDefault.matches(CmsObject cms, java.lang.String editedResourcePath)
boolean	I_CmsEditorCssHandler.matches(CmsObject cms, java.lang.String editedResourcePath) Checks if the handler can be used to determine the CSS style sheet based on the edited resource.

Constructors in org.opencms.workplace.editors with parameters of type CmsObject

Constructor and Description
CmsWorkplaceEditorManager(CmsObject cms) Creates a new editor manager.

Uses of CmsObject in org.opencms.workplace.editors.directedit

Fields in org.opencms.workplace.editors.directedit declared as CmsObject

Modifier and Type	Field and Description
protected CmsObject	A_CmsDirectEditProvider.m_cms The current users OpenCms context.

Methods in org.opencms.workplace.editors.directedit with parameters of type CmsObject

Modifier and Type	Method and Description
CmsDialogOptions	CmsDateSeriesEditHandler.getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
CmsDialogOptions	I_CmsEditHandler.getDeleteOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams) Returns a map of delete options.
CmsDialogOptions	CmsDateSeriesEditHandler.getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement)
CmsDialogOptions	I_CmsEditHandler.getEditOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, boolean isListElement) Returns a map of edit options.
static java.lang.String	Messages.getLocalizedMessage(CmsMessageContainer container, CmsObject cms) Returns the String for the given CmsMessageContainer localized to the current user's locale if available or to the default locale else.
CmsDialogOptions	CmsDateSeriesEditHandler.getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam)
CmsDialogOptions	I_CmsEditHandler.getNewOptions(CmsObject cms, CmsContainerElementBean elementBean, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParam) Gets the options for the 'New' (plus) operation in the page editor.
void	CmsDateSeriesEditHandler.handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
void	I_CmsEditHandler.handleDelete(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String deleteOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams) Executes the actual delete.
java.lang.String	CmsDateSeriesEditHandler.handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice)
java.lang.String	I_CmsEditHandler.handleNew(CmsObject cms, java.lang.String newLink, java.util.Locale locale, java.lang.String referenceSitePath, java.lang.String modelFileSitePath, java.lang.String postCreateHandler, CmsContainerElementBean element, CmsUUID pageId, java.util.Map<java.lang.String,java.lang.String[]> requestParams, java.lang.String choice) Creates a new resource to edit.
void	I_CmsDirectEditProvider.init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName) Initialize method for a new instance of the direct edit provider.
void	CmsDirectEditJspIncludeProvider.init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
void	CmsDirectEditJQueryProvider.init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
void	CmsDirectEditDefaultProvider.init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
void	A_CmsDirectEditProvider.init(CmsObject cms, CmsDirectEditMode mode, java.lang.String fileName)
CmsUUID	CmsDateSeriesEditHandler.prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams)
CmsUUID	I_CmsEditHandler.prepareForEdit(CmsObject cms, CmsContainerElementBean elementBean, java.lang.String editOption, CmsUUID pageContextId, java.util.Map<java.lang.String,java.lang.String[]> requestParams) Prepares the resource to be edited.

Uses of CmsObject in org.opencms.workplace.explorer

Methods in org.opencms.workplace.explorer that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsResourceUtil.getCms() Returns the cms context.

Methods in org.opencms.workplace.explorer with parameters of type CmsObject

Modifier and Type	Method and Description
CmsPermissionSet	CmsExplorerTypeAccess.getPermissions(CmsObject cms, CmsResource resource) Calculates the permissions for this explorer type settings for the user in the given OpenCms user context.
boolean	CmsExplorerTypeSettings.isEditable(CmsObject cms, CmsResource resource) Checks if the current user has write permissions on the given resource.
void	CmsResourceUtil.setCms(CmsObject cms) Sets the cms context.

Constructors in org.opencms.workplace.explorer with parameters of type CmsObject

Constructor and Description
CmsResourceUtil(CmsObject cms) Creates a new CmsResourceUtil object.
CmsResourceUtil(CmsObject cms, CmsResource resource) Creates a new CmsResourceUtil object.

Uses of CmsObject in org.opencms.workplace.galleries

Methods in org.opencms.workplace.galleries with parameters of type CmsObject

Modifier and Type	Method and Description
static java.util.List<CmsResource>	A_CmsAjaxGallery.getGalleries(int galleryTypeId, CmsObject cms) Returns a list of galleries which have the required gallery type id.

Uses of CmsObject in org.opencms.workplace.threads

Constructors in org.opencms.workplace.threads with parameters of type CmsObject

Constructor and Description
CmsDatabaseImportThread(CmsObject cms, java.lang.String importFile, boolean keepPermissions) Imports an OpenCms export file into the VFS.
CmsExportThread(CmsObject cms, I_CmsImportExportHandler handler, boolean old) Creates a new data export thread.
CmsExternalLinksValidatorThread(CmsObject cms) Constructor, creates a new CmsExternLinkValidationThread.
CmsModuleDeleteThread(CmsObject cms, java.util.List<java.lang.String> moduleNames, boolean replaceMode) Creates the module delete thread.
CmsModuleReplaceThread(CmsObject cms, java.lang.String moduleName, java.lang.String zipName) Creates the module replace thread.
CmsProjectDeleteThread(CmsObject cms, CmsUUID projectId) Creates the project delete thread.
CmsRelationsValidatorThread(CmsObject cms) Creates a thread that validates the relations for all files of the current project.
CmsRelationsValidatorThread(CmsObject cms, CmsPublishList publishList, CmsWorkplaceSettings settings) Creates a thread that validates the relations in the list of unpublished file(s) of the current (offline) project.
CmsSynchronizeThread(CmsObject cms) Creates the synchronize Thread.
CmsXmlContentRepairSettings(CmsObject cms) Default constructor with cms object that is used for VFS path validation.
CmsXmlContentRepairThread(CmsObject cms, CmsXmlContentRepairSettings settings) Creates a repair XML content resources thread.

Uses of CmsObject in org.opencms.workplace.tools

Methods in org.opencms.workplace.tools with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsToolManager.configure(CmsObject cms) Called by the CmsWorkplaceManager.initialize(CmsObject) method.
boolean	CmsToolRootHandler.isEnabled(CmsObject cms)
boolean	CmsDefaultToolHandler.isEnabled(CmsObject cms)
boolean	CmsOnlyAdminToolHandler.isEnabled(CmsObject cms)
boolean	CmsOfflineToolHandler.isEnabled(CmsObject cms)
boolean	CmsInvisibleToolHandler.isEnabled(CmsObject cms)
boolean	I_CmsToolHandler.isEnabled(CmsObject cms) Returns the state of the admin tool for a given cms context.
boolean	CmsToolRootHandler.isVisible(CmsObject cms)
boolean	CmsDefaultToolHandler.isVisible(CmsObject cms)
boolean	CmsOnlyAdminToolHandler.isVisible(CmsObject cms)
boolean	CmsInvisibleToolHandler.isVisible(CmsObject cms)
boolean	I_CmsToolHandler.isVisible(CmsObject cms) Returns the visibility flag for a given cms context.
protected void	A_CmsToolHandler.setLink(CmsObject cms, java.lang.String resourcePath) Sets the link for the given resource.
protected void	A_CmsToolHandler.setParameters(CmsObject cms, java.lang.String resourcePath) Sets the needed properties from the A_CmsToolHandler.ARGS_PROPERTY_DEFINITION property of the given resource.
boolean	A_CmsToolHandler.setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath) Default implementation.
boolean	CmsToolRootHandler.setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath)
boolean	I_CmsToolHandler.setup(CmsObject cms, CmsToolRootHandler root, java.lang.String resourcePath) Main method that somehow setups the admin tool handler.

Uses of CmsObject in org.opencms.xml

Methods in org.opencms.xml with parameters of type CmsObject

Modifier and Type	Method and Description
org.dom4j.Element	CmsXmlContentDefinition.addDefaultXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale) Adds the missing default XML according to this content definition to the given document element.
void	I_CmsXmlDocument.addLocale(CmsObject cms, java.util.Locale locale) Adds the given locale to this XML document.
CmsFile	A_CmsXmlDocument.correctXmlStructure(CmsObject cms) Corrects the structure of this XML document.
org.dom4j.Element	CmsXmlContentDefinition.createDefaultXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale) Generates the default XML content for this content definition, and append it to the given root element.
org.dom4j.Document	CmsXmlContentDefinition.createDocument(CmsObject cms, I_CmsXmlDocument document, java.util.Locale locale) Generates a valid XML document according to the XML schema of this content definition.
org.dom4j.Element	CmsXmlContentDefinition.createLocale(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale) Generates a valid locale (language) element for the XML schema of this content definition.
static CmsXmlContentDefinition	CmsXmlContentDefinition.getContentDefinitionForResource(CmsObject cms, CmsResource resource) Factory method that returns the XML content definition instance for a given resource.
static CmsXmlContentDefinition	CmsXmlContentDefinition.getContentDefinitionForType(CmsObject cms, java.lang.String typeName) Reads the content definition which is configured for a resource type.
static I_CmsXmlContentHandler	CmsXmlContentDefinition.getContentHandlerForResource(CmsObject cms, CmsResource resource) Returns a content handler instance for the given resource.
CmsLinkProcessor	I_CmsXmlDocument.getLinkProcessor(CmsObject cms, CmsLinkTable linkTable) Returns a link processor for the values of this XML document.
java.lang.String	I_CmsXmlDocument.getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale) Returns the first content value for the given path as a String, or null if no such value exists.
java.lang.String	A_CmsXmlDocument.getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale)
java.lang.String	I_CmsXmlDocument.getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale, int index) Returns the content value for the given path and the selected index as a String, or null if no such value exists.
java.lang.String	A_CmsXmlDocument.getStringValue(CmsObject cms, java.lang.String path, java.util.Locale locale, int index)
void	CmsXmlContentTypeManager.initialize(CmsObject cms) Initializes XML content types managed in this XML content type manager.
protected static void	CmsXmlEntityResolver.initialize(CmsObject adminCms, byte[] typeSchemaBytes) Initialize the OpenCms XML entity resolver.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(CmsObject cms, java.lang.String resourcename) Factory method to unmarshal (read) a XML content definition instance from the OpenCms VFS resource name.
CmsXmlContentErrorHandler	I_CmsXmlDocument.validate(CmsObject cms) Validates the content of this XML document.

Constructors in org.opencms.xml with parameters of type CmsObject

Constructor and Description
CmsXmlEntityResolver(CmsObject cms) Creates a new XML entity resolver based on the provided CmsObject.

Uses of CmsObject in org.opencms.xml.containerpage

Methods in org.opencms.xml.containerpage with parameters of type CmsObject

Modifier and Type	Method and Description
protected void	CmsXmlContainerPage.checkLinkConcistency(CmsObject cms) Checks the link consistency for a given locale and reinitializes the document afterwards.
protected CmsContainerPageBean	CmsXmlContainerPage.cleanupContainersContainers(CmsObject cms, CmsContainerPageBean cntPage) Removes all empty containers and merges the containers of the current document that are not used in the given container page with it.
static CmsFormatterConfiguration	CmsFormatterConfiguration.create(CmsObject cms, java.util.List<I_CmsFormatterBean> formatters) Returns the formatter configuration for the current project based on the given list of formatters.
byte[]	CmsXmlContainerPage.createContainerPageXml(CmsObject cms, CmsContainerPageBean cntPage) Saves a container page bean to the in-memory XML structure and returns the changed content.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new instance of an group container based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new instance of an container page based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new instance of a group container based on the given content definition, that will have one language node for the given locale all initialized with default values.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new instance of a container page based on the given content definition, that will have one language node for the given locale all initialized with default values.
static CmsContainerElementBean	CmsContainerElementBean.createElementForResourceType(CmsObject cms, I_CmsResourceType resourceType, java.lang.String targetFolder, java.util.Map<java.lang.String,java.lang.String> individualSettings, boolean isCopyModels, java.util.Locale locale) Creates an element bean for the given resource type.
CmsResource	CmsLazyFolder.createFolder(CmsObject cms) Creates the folder with the given name if it doesn't already exist, and returns it.
CmsResource	I_CmsADEConfiguration.createNewElement(CmsObject cms, java.lang.String cntPageUri, javax.servlet.ServletRequest request, java.lang.String type, java.util.Locale locale) Creates a new element of a given type at the configured location.
protected void	CmsXmlGroupContainer.fillResource(CmsObject cms, org.dom4j.Element element, CmsResource res) Fills a CmsXmlVfsFileValue with the resource identified by the given id.
protected CmsResource	CmsXmlContainerPage.fillResource(CmsObject cms, org.dom4j.Element element, CmsUUID resourceId) Fills a CmsXmlVfsFileValue with the resource identified by the given id.
protected java.util.List<CmsDynamicFunctionBean.Format>	CmsDynamicFunctionParser.getAdditionalFormats(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes) Parses all the additional formats from the XML content.
static CmsADESessionCache	CmsADESessionCache.getCache(javax.servlet.http.HttpServletRequest request, CmsObject cms) Gets the session cache for the current session.
CmsResource	CmsConfigurationFileFinder.getConfigurationFile(CmsObject cms, java.lang.String containerPageUri) Returns the configuration file to use.
CmsContainerPageBean	CmsXmlContainerPage.getContainerPage(CmsObject cms) Gets the container page content as a bean.
java.util.Collection<CmsResource>	I_CmsADEConfiguration.getCreatableElements(CmsObject cms, java.lang.String cntPageUri, javax.servlet.ServletRequest request) Returns the list of creatable elements.
java.util.Set<java.lang.String>	CmsXmlInheritGroupContainerHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
java.util.Set<java.lang.String>	CmsXmlGroupContainerHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
int	I_CmsADEConfiguration.getFavoriteListMaxSize(CmsObject cms) Returns the maximal size of the favorite list.
CmsResource	CmsLazyFolder.getFolder(CmsObject cms) Returns the folder if it already exists, or null if it doesn't.
CmsDynamicFunctionBean.Format	CmsDynamicFunctionBean.getFormatForContainer(CmsObject cms, java.lang.String type, int width) Finds the correct format for a given container type and width.
CmsFormatterConfiguration	CmsXmlDynamicFunctionHandler.getFormatterConfiguration(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	I_CmsADEConfiguration.getFormattersForResource(CmsObject cms, java.lang.String containerPageRootPath, CmsResource res) Returns the formatter configuration for a given resource.
protected CmsResource	CmsDynamicFunctionParser.getFunctionFormatter(CmsObject cms) Gets the function formatter resource, possibly from the cache.
CmsGroupContainerBean	CmsXmlGroupContainer.getGroupContainer(CmsObject cms) Returns the group container bean for the given locale.
java.util.Set<java.lang.String>	CmsXmlInheritGroupContainerHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
java.util.Set<java.lang.String>	CmsXmlGroupContainerHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
protected java.util.Locale	CmsDynamicFunctionParser.getLocaleToUse(CmsObject cms, CmsXmlContent xmlContent) Gets the locale to use for parsing the dynamic function.
protected CmsDynamicFunctionBean.Format	CmsDynamicFunctionParser.getMainFormat(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes) Parses the main format from the XML content.
java.lang.String	I_CmsADEConfiguration.getNextNewFileName(CmsObject cms, java.lang.String cntPageUri, javax.servlet.ServletRequest request, java.lang.String type) Returns the name of the next new file of the given type to be created.
CmsResource	CmsLazyFolder.getOrCreateFolder(CmsObject cms) Returns the folder if it already exists, or creates and returns it if it doesn't.
CmsResource	CmsLazyFolder.getPermissionCheckFolder(CmsObject cms) Returns the folder to check for permissions, which is either the folder itself if it already exists, or the parent folder if it doesn't.
int	I_CmsADEConfiguration.getRecentListMaxSize(CmsObject cms) Returns the maximal size of the recent list.
java.util.Collection<CmsResource>	I_CmsADEConfiguration.getSearchableResourceTypes(CmsObject cms, java.lang.String cntPageUri, javax.servlet.ServletRequest request) Returns the list of searchable resource types.
java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsXmlDynamicFunctionHandler.getSettings(CmsObject cms, CmsResource res)
java.lang.String	CmsLazyFolder.getSitePath(CmsObject cms) Computes the site path of the folder, which is either the original path constructor argument, or the site path of the original resource constructor argument.
protected java.lang.String	CmsDynamicFunctionParser.getString(CmsObject cms, I_CmsXmlContentValueLocation location) Gets the string value of an XML content location.
protected java.lang.String	CmsDynamicFunctionParser.getStringValue(CmsObject cms, I_CmsXmlContentValueLocation location, java.lang.String defaultValue) Converts a (possibly null) content value location to a string.
void	I_CmsADEConfiguration.init(CmsObject cms) Initializes the configuration.
protected void	CmsXmlContainerPage.initDocument(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, CmsXmlContentDefinition definition)
static void	CmsFormatterConfiguration.initialize(CmsObject cms) Initialize the formatter configuration.
void	CmsContainerElementBean.initResource(CmsObject cms) Initializes the resource and the site path of this element.
void	CmsContainerElementBean.initSettings(CmsObject cms, I_CmsFormatterBean formatterBean, java.util.Locale locale, javax.servlet.ServletRequest request, java.util.Map<java.lang.String,java.lang.String> presets) Initializes the element settings.
boolean	I_CmsADEConfiguration.isCreatableType(CmsObject cms, java.lang.String currentUri, java.lang.String typeName) Returns if the given type has a valid configuration to be created.
boolean	CmsContainerElementBean.isGroupContainer(CmsObject cms) Tests whether this element refers to a group container.
boolean	CmsContainerElementBean.isInheritedContainer(CmsObject cms) Returns whether this element refers to an inherited container element.
protected static java.util.List<CmsContainerElementBean>	CmsXmlGroupContainerHandler.loadGroupContainerElements(CmsObject cms, CmsResource resource) Helper method to load and prepare the elements of a group container.
static java.util.List<CmsContainerElementBean>	CmsXmlInheritGroupContainerHandler.loadInheritContainerElements(CmsObject cms, CmsResource resource) Returns the elements of the given inheritance group for the request context URI.
protected CmsDynamicFunctionBean.Format	CmsDynamicFunctionParser.parseAdditionalFormat(CmsObject cms, I_CmsXmlContentValueLocation location, CmsResource functionRes) Parses an additional format from the XML content.
CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, CmsResource res) Parses a dynamic function bean given a resource.
CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, CmsXmlContent content) Parses a dynamic function bean from an in-memory XML content object.
protected CmsDynamicFunctionBean	CmsDynamicFunctionParser.parseFunctionBean(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionRes, CmsResource functionFormatter) Parses a dynamic function bean.
protected CmsPair<java.lang.String,java.lang.String>	CmsDynamicFunctionParser.parseParameter(CmsObject cms, I_CmsXmlContentValueLocation valueLocation) Parses a request parameter for the JSP from the XML content.
protected java.util.Map<java.lang.String,java.lang.String>	CmsDynamicFunctionParser.parseParameters(CmsObject cms, I_CmsXmlContentLocation location, java.lang.String name) Parses all parameters for the JSP from the XML content.
protected CmsXmlContentProperty	CmsDynamicFunctionParser.parseProperty(CmsObject cms, I_CmsXmlContentLocation field) Helper method for parsing a settings definition.
protected java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsDynamicFunctionParser.parseSettings(CmsObject cms, I_CmsXmlContentLocation location, CmsResource functionResource) Parses the settings for the dynamic function from the XML content.
CmsFile	CmsHtmlRedirectHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
CmsXmlContentErrorHandler	CmsXmlContainerPageHandler.resolveValidation(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler)
void	CmsXmlContainerPage.save(CmsObject cms, CmsContainerPageBean cntPage) Saves given container page in the current locale, and not only in memory but also to VFS.
void	CmsXmlContainerPage.save(CmsObject cms, CmsContainerPageBean cntPage, boolean ifChangedOnly) Saves given container page in the current locale, and not only in memory but also to VFS.
void	CmsXmlGroupContainer.save(CmsObject cms, CmsGroupContainerBean groupContainer, java.util.Locale locale) Saves given container page in the current locale, and not only in memory but also to VFS.
protected void	CmsXmlContainerPage.saveContainerPage(CmsObject cms, org.dom4j.Element parent, CmsContainerPageBean cntPage) Adds the given container page to the given element.
protected void	CmsXmlGroupContainer.saveGroupContainer(CmsObject cms, org.dom4j.Element parent, CmsGroupContainerBean groupContainer) Adds the given container page to the given element.
void	CmsADESessionCache.setLastPage(CmsObject cms, CmsUUID pageId, CmsUUID detailId) Stores information about the last edited container page.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, byte[] xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a group container instance from a byte array that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, byte[] xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a container page instance from a byte array that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding, boolean noCache) Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsResource resource) Factory method to unmarshal (read) a group container instance from a OpenCms VFS resource that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsResource resource) Factory method to unmarshal (read) a container page instance from a OpenCms VFS resource that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a group container instance from a resource, using the request attributes as cache.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a container page instance from a resource, using the request attributes as cache.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a group container instance from a XML document.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a container page instance from a XML document.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, java.lang.String xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a group container instance from a String that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, java.lang.String xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a container page instance from a String that contains XML data.
protected boolean	CmsXmlContainerPageHandler.validateLink(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler)
protected void	CmsXmlContainerPageHandler.validateNames(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContent content) Validates container names, so that they are unique in the page.
void	CmsXmlContainerPage.writeContainerPage(CmsObject cms, CmsContainerPageBean cntPage) Saves a container page in in-memory XML structure.

Constructors in org.opencms.xml.containerpage with parameters of type CmsObject

Constructor and Description
CmsADESessionCache(CmsObject cms, javax.servlet.http.HttpServletRequest request) Initializes the session cache.
CmsSchemaFormatterBeanWrapper(CmsObject cms, I_CmsFormatterBean wrappedBean, I_CmsXmlContentHandler contentHandler, CmsResource resource) Creates a new wrapper instance.
CmsXmlContainerPage(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Creates a new container page based on the provided XML document.
CmsXmlContainerPage(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new container page based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
CmsXmlContainerPage(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.
CmsXmlGroupContainer(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Creates a new group container based on the provided XML document.
CmsXmlGroupContainer(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new group container based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
CmsXmlGroupContainer(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new container page based on the given content definition, that will have one language node for the given locale all initialized with default values.

Uses of CmsObject in org.opencms.xml.content

Methods in org.opencms.xml.content that return CmsObject

Modifier and Type	Method and Description
CmsObject	CmsDefaultXmlContentHandler.createRootCms(CmsObject cms) Copies a given CMS context and set the copy's site root to '/'.

Methods in org.opencms.xml.content with parameters of type CmsObject

Modifier and Type	Method and Description
protected static void	CmsXmlContentPropertyHelper.addFileListPropertyValue(CmsObject cms, org.dom4j.Element valueElement, java.lang.String propValue) Adds the XML for a property value of a property of type 'vfslist' to the DOM.
void	CmsXmlContent.addLocale(CmsObject cms, java.util.Locale locale)
protected I_CmsXmlContentValue	CmsXmlContent.addValue(CmsObject cms, org.dom4j.Element parent, I_CmsXmlSchemaType type, java.util.Locale locale, int insertIndex) Adds a new XML schema type with the default value to the given parent node.
I_CmsXmlContentValue	CmsXmlContentValueSequence.addValue(CmsObject cms, I_CmsXmlSchemaType type, int index) Adds a value element of the given type at the selected index to the XML content document.
I_CmsXmlContentValue	CmsXmlContentValueSequence.addValue(CmsObject cms, int index) Adds a value element of the type the original xpath indicates at the selected index to the XML content document.
I_CmsXmlContentValue	CmsXmlContentValueSequence.addValue(CmsObject cms, java.lang.String xpath, int index) Adds a value element of the type indicated by the given xpath at the selected index to the XML content document.
I_CmsXmlContentValue	CmsXmlContent.addValue(CmsObject cms, java.lang.String path, java.util.Locale locale, int index) Adds a new XML content value for the given element name and locale at the given index position to this XML content document.
CmsUUID	I_CmsXmlContentValueLocation.asId(CmsObject cms) Returns the structure id of the content value (only valid for VfsFile values!).
CmsUUID	CmsXmlContentValueLocation.asId(CmsObject cms)
java.lang.String	I_CmsXmlContentValueLocation.asString(CmsObject cms) Returns the string value of the content value.
java.lang.String	CmsXmlContentValueLocation.asString(CmsObject cms)
protected static java.lang.String	CmsXmlContentPropertyHelper.convertIdsToPaths(CmsObject cms, java.lang.String value) Converts a string containing zero or more structure ids into a string containing the corresponding VFS paths.
protected static java.lang.String	CmsXmlContentPropertyHelper.convertPathsToIds(CmsObject cms, java.lang.String value) Converts a string containing zero or more VFS paths into a string containing the corresponding structure ids.
protected static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.convertProperties(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,CmsXmlContentProperty> propConfig, boolean toClient) Helper method for converting a map of properties from client format to server format or vice versa.
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.convertPropertiesToClientFormat(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,CmsXmlContentProperty> propConfig) Converts a map of properties from server format to client format.
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.convertPropertiesToServerFormat(CmsObject cms, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,CmsXmlContentProperty> propConfig) Converts a map of properties from client format to server format.
protected static java.lang.String	CmsXmlContentPropertyHelper.convertStringPropertyValue(CmsObject cms, java.lang.String propValue, java.lang.String type, boolean toClient) Converts a property value given as a string between server format and client format.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, CmsResourceTypeXmlContent resourceType) Creates a new XML content based on a resource type.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new instance of an XML content based on the given default content, hat will have all language nodes of the default content and ensures the presence of the given locale.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new instance of an XML content based on the given content definiton, that will have one language node for the given locale all initialized with default values.
CmsObject	CmsDefaultXmlContentHandler.createRootCms(CmsObject cms) Copies a given CMS context and set the copy's site root to '/'.
java.util.Set<java.lang.String>	CmsDefaultXmlContentHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource)
java.util.Set<java.lang.String>	I_CmsXmlContentHandler.getCSSHeadIncludes(CmsObject cms, CmsResource resource) Returns all the CSS resources to include into the html-page head.
java.lang.String	CmsDefaultXmlContentHandler.getDefault(CmsObject cms, CmsResource resource, I_CmsXmlSchemaType type, java.lang.String path, java.util.Locale locale)
java.lang.String	I_CmsXmlContentHandler.getDefault(CmsObject cms, CmsResource resource, I_CmsXmlSchemaType type, java.lang.String path, java.util.Locale locale) Returns the default String value for the given XML content schema type object in the given XML content.
java.lang.String	CmsDefaultXmlContentHandler.getDefault(CmsObject cms, I_CmsXmlContentValue value, java.util.Locale locale)
java.lang.String	I_CmsXmlContentHandler.getDefault(CmsObject cms, I_CmsXmlContentValue value, java.util.Locale locale) Returns the default String value for the given XML content schema type object in the given XML content.
protected static CmsVfsFileValueBean	CmsXmlContentPropertyHelper.getFileValueForIdOrUri(CmsObject cms, java.lang.String idOrUri) Given a string which might be a id or a (sitemap or VFS) URI, this method will return a bean containing the right (sitemap or vfs) root path and (sitemap entry or structure) id.
CmsFormatterConfiguration	CmsDefaultXmlContentHandler.getFormatterConfiguration(CmsObject cms, CmsResource resource)
CmsFormatterConfiguration	I_CmsXmlContentHandler.getFormatterConfiguration(CmsObject cms, CmsResource res) Returns the container page element formatter configuration for a given resource.
static CmsUUID	CmsXmlContentPropertyHelper.getIdForUri(CmsObject cms, java.lang.String uri) Looks up an URI in the sitemap and returns either a sitemap entry id (if the URI is a sitemap URI) or the structure id of a resource (if the URI is a VFS path).
java.util.Set<java.lang.String>	CmsDefaultXmlContentHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource)
java.util.Set<java.lang.String>	I_CmsXmlContentHandler.getJSHeadIncludes(CmsObject cms, CmsResource resource) Returns all the javascript resources to include into the html-page head.
CmsLinkProcessor	CmsXmlContent.getLinkProcessor(CmsObject cms, CmsLinkTable linkTable)
protected java.util.List<java.util.Locale>	CmsDefaultXmlContentHandler.getLocalesForResource(CmsObject cms, java.lang.String resource) Returns the configured default locales for the content of the given resource.
static CmsMacroResolver	CmsXmlContentPropertyHelper.getMacroResolverForProperties(CmsObject cms, I_CmsXmlContentHandler contentHandler, CmsXmlContent content, java.util.function.Function<java.lang.String,java.lang.String> stringtemplateSource, CmsResource containerPage) Creates and configures a new macro resolver for resolving macros which occur in property definitions.
java.util.List<CmsUUID>	CmsDefaultXmlContentHandler.getNestedFormatters(CmsObject cms, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req)
java.util.List<CmsUUID>	I_CmsXmlContentHandler.getNestedFormatters(CmsObject cms, CmsResource res, java.util.Locale locale, javax.servlet.ServletRequest req) Returns the nested formatters for the given resource.
java.lang.String	CmsDefaultXmlContentHandler.getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename)
java.lang.String	I_CmsXmlContentHandler.getPreview(CmsObject cms, CmsXmlContent content, java.lang.String resourcename) Returns the preview URI for the given XML content value object to be displayed in the editor.
static java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsXmlContentPropertyHelper.getPropertyInfo(CmsObject cms, CmsResource page, CmsResource resource) Returns the property information for the given resource (type) AND the current user.
static java.lang.String	CmsXmlContentPropertyHelper.getPropValueIds(CmsObject cms, java.lang.String type, java.lang.String value) Returns a converted property value depending on the given type.
static java.lang.String	CmsXmlContentPropertyHelper.getPropValuePaths(CmsObject cms, java.lang.String type, java.lang.String value) Returns a converted property value depending on the given type.
protected java.lang.String	CmsDefaultXmlContentHandler.getReferencePath(CmsObject cms, I_CmsXmlContentValue value) Returns the category reference path for the given value.
java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsDefaultXmlContentHandler.getSettings(CmsObject cms, CmsResource resource)
java.util.Map<java.lang.String,CmsXmlContentProperty>	I_CmsXmlContentHandler.getSettings(CmsObject cms, CmsResource resource) Returns the element settings defined for the container page formatters.
java.lang.String	CmsDefaultXmlContentHandler.getTitleMapping(CmsObject cms, CmsXmlContent document, java.util.Locale locale)
java.lang.String	I_CmsXmlContentHandler.getTitleMapping(CmsObject cms, CmsXmlContent document, java.util.Locale locale) Returns the "Title" mapping set for the given XML content document in the given Locale.
static java.lang.String	CmsXmlContentPropertyHelper.getUriForId(CmsObject cms, CmsUUID id) Returns a sitemap or VFS path given a sitemap entry id or structure id.
protected java.lang.String	CmsDefaultXmlContentHandler.getValidationMessage(CmsObject cms, I_CmsXmlContentValue value, java.lang.String regex, java.lang.String valueStr, boolean matchResult, boolean isWarning) Returns the validation message to be displayed if a certain rule was violated.
CmsXmlContent	I_CmsXmlContentEditorChangeHandler.handleChange(CmsObject cms, CmsXmlContent content, java.util.Locale locale, java.util.Collection<java.lang.String> changedPaths) Handles the content change.
protected void	CmsXmlContent.initDocument(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, CmsXmlContentDefinition definition) Initializes an XML document based on the provided document, encoding and content definition.
void	CmsDefaultXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document)
void	I_CmsXmlContentHandler.invalidateBrokenLinks(CmsObject cms, CmsXmlContent document) Performs a check of the given XML document.
boolean	CmsDefaultXmlContentHandler.isValueVisible(CmsObject cms, I_CmsXmlSchemaType value, java.lang.String elementName, java.lang.String params, CmsResource resource, java.util.Locale contentLocale) Returns the content field visibilty.
boolean	I_CmsXmlContentVisibilityHandler.isValueVisible(CmsObject cms, I_CmsXmlSchemaType value, java.lang.String elementPath, java.lang.String params, CmsResource resource, java.util.Locale contentLocale) Returns if the given content value field should be visible to the current user.
boolean	CmsDefaultXmlContentHandler.isVisible(CmsObject cms, I_CmsXmlSchemaType contentValue, java.lang.String valuePath, CmsResource resource, java.util.Locale contentLocale)
boolean	I_CmsXmlContentHandler.isVisible(CmsObject cms, I_CmsXmlSchemaType schemaType, java.lang.String valuePath, CmsResource resource, java.util.Locale contentLocale) Returns if the given content field should be visible to the current user.
java.util.Map<java.util.Locale,java.util.Map<java.lang.String,java.lang.String>>	CmsVfsBundleLoaderXml.loadData(CmsObject cms, CmsVfsBundleParameters params)
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.mergeDefaults(CmsObject cms, CmsResource resource, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Locale locale, javax.servlet.ServletRequest request) Extends the given properties with the default values from the resource's property configuration.
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.mergeDefaults(CmsObject cms, java.util.Map<java.lang.String,CmsXmlContentProperty> propertyConfig, java.util.Map<java.lang.String,java.lang.String> properties) Extends the given properties with the default values from property configuration.
CmsXmlContent	CmsDefaultXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content)
CmsXmlContent	I_CmsXmlContentHandler.prepareForUse(CmsObject cms, CmsXmlContent content) Prepares the given XML content to be used after it was read from the OpenCms VFS.
CmsFile	CmsDefaultXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file)
CmsFile	I_CmsXmlContentHandler.prepareForWrite(CmsObject cms, CmsXmlContent content, CmsFile file) Prepares the given XML content to be written to the OpenCms VFS.
static java.util.Map<java.lang.String,java.lang.String>	CmsXmlContentPropertyHelper.readProperties(CmsObject cms, I_CmsXmlContentLocation baseLocation) Reads property nodes from the given location.
protected void	CmsDefaultXmlContentHandler.removeEmptyMappings(CmsObject cms, CmsFile file, CmsXmlContent content) Removes property values on resources for non-existing, optional elements.
protected void	CmsDefaultXmlContentHandler.resolveDefaultMappings(CmsObject cms, CmsFile file, CmsXmlContent content) Resolves those mappings for which no content value exists and useDefault is set to true.
static java.util.Map<java.lang.String,CmsXmlContentProperty>	CmsXmlContentPropertyHelper.resolveMacrosForPropertyInfo(CmsObject cms, CmsResource page, CmsResource resource, com.google.common.base.Supplier<CmsXmlContent> contentGetter, java.util.function.Function<java.lang.String,java.lang.String> stringtemplateSource, java.util.Map<java.lang.String,CmsXmlContentProperty> propertiesConf) Resolves macros in the given property information for the given resource (type) AND the current user.
void	CmsDefaultXmlContentHandler.resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value)
void	I_CmsXmlContentHandler.resolveMapping(CmsObject cms, CmsXmlContent content, I_CmsXmlContentValue value) Resolves the value mappings of the given XML content value, according to the rules of this XML content handler.
void	CmsXmlContent.resolveMappings(CmsObject cms) Resolves the mappings for all values of this XML content.
CmsXmlContentErrorHandler	CmsDefaultXmlContentHandler.resolveValidation(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler)
CmsXmlContentErrorHandler	I_CmsXmlContentHandler.resolveValidation(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler) Performs a validation of the given XML content value, and saves all errors or warnings found in the provided XML content error handler.
static void	CmsXmlContentPropertyHelper.saveProperties(CmsObject cms, org.dom4j.Element parentElement, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,CmsXmlContentProperty> propertiesConf) Saves the given properties to the given xml element.
void	CmsMappingResolutionContext.setCmsObject(CmsObject cms) Sets the CMS context to use.
void	CmsXmlContent.synchronizeLocaleIndependentValues(CmsObject cms, java.util.Collection<java.lang.String> skipPaths, java.util.Locale sourceLocale) Synchronizes the locale independent fields for the given locale.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, byte[] xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a byte array that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a XML content instance from a resource, using the request attributes as cache.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a XML document.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, java.lang.String xmlData, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Factory method to unmarshal (generate) a XML content instance from a String that contains XML data.
CmsXmlContentErrorHandler	CmsXmlContent.validate(CmsObject cms)
protected CmsXmlContentErrorHandler	CmsDefaultXmlContentHandler.validateCategories(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler) The errorHandler parameter is optional, if null is given a new error handler instance must be created.
protected boolean	CmsDefaultXmlContentHandler.validateLink(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler) Validates the given rules against the given value.
protected CmsXmlContentErrorHandler	CmsDefaultXmlContentHandler.validateValue(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContentErrorHandler errorHandler, java.util.Map<java.lang.String,java.lang.String> rules, boolean isWarning) Validates the given rules against the given value.
protected CmsXmlContentErrorHandler	CmsDefaultXmlContentHandler.validateValue(CmsObject cms, I_CmsXmlContentValue value, java.lang.String valueStr, CmsXmlContentErrorHandler errorHandler, boolean isWarning) Checks the default XML schema validation rules.
protected CmsFile	CmsDefaultXmlContentHandler.writeCategories(CmsObject cms, CmsFile file, CmsXmlContent content) Writes the categories if a category widget is present.

Constructors in org.opencms.xml.content with parameters of type CmsObject

Constructor and Description
CmsXmlContent(CmsObject cms, org.dom4j.Document document, java.lang.String encoding, org.xml.sax.EntityResolver resolver) Creates a new XML content based on the provided XML document.
CmsXmlContent(CmsObject cms, java.util.Locale locale, java.lang.String modelUri) Create a new XML content based on the given default content, that will have all language nodes of the default content and ensures the presence of the given locale.
CmsXmlContent(CmsObject cms, java.util.Locale locale, java.lang.String encoding, CmsXmlContentDefinition contentDefinition) Create a new XML content based on the given content definiton, that will have one language node for the given locale all initialized with default values.
CmsXmlContentMacroVisitor(CmsObject cms, CmsMacroResolver resolver) Creates a new validation node visitor.

Uses of CmsObject in org.opencms.xml.page

Methods in org.opencms.xml.page with parameters of type CmsObject

Modifier and Type	Method and Description
void	CmsXmlPage.addLocale(CmsObject cms, java.util.Locale locale)
CmsLinkProcessor	CmsXmlPage.getLinkProcessor(CmsObject cms, CmsLinkTable linkTable)
void	CmsXmlPage.setStringValue(CmsObject cms, java.lang.String name, java.util.Locale locale, java.lang.String content) Sets the data of an already existing value.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file) Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding) Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a XML page instance from a resource, using the request attributes as cache.
static I_CmsXmlDocument	CmsXmlPageFactory.unmarshal(CmsObject cms, java.lang.String filename, javax.servlet.ServletRequest req) Factory method to unmarshal (read) a XML document instance from a filename in the VFS, using the request attributes as cache.
CmsXmlContentErrorHandler	CmsXmlPage.validate(CmsObject cms)

Uses of CmsObject in org.opencms.xml.templatemapper

Methods in org.opencms.xml.templatemapper with parameters of type CmsObject

Modifier and Type	Method and Description
CmsMenuItemVisibilityMode	CmsTemplateMapperAction.getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
protected CmsContainerElementBean	CmsTemplateMapper.transformContainerElement(CmsObject cms, CmsTemplateMapperConfiguration config, CmsContainerElementBean element) Helper method to transform a single container element.
CmsContainerPageBean	CmsTemplateMapper.transformContainerpageBean(CmsObject cms, CmsContainerPageBean input, java.lang.String rootPath) Transforms a container page bean.
CmsContainerElementBean	CmsTemplateMapper.transformDetailElement(CmsObject cms, CmsContainerElementBean input, java.lang.String rootPath) Transforms a container element bean used for detail elements.
CmsGroupContainerBean	CmsTemplateMapper.transformGroupContainer(CmsObject cms, CmsGroupContainerBean input, java.lang.String rootPath) Transforms a group container bean.

Constructors in org.opencms.xml.templatemapper with parameters of type CmsObject

Constructor and Description
CmsTemplateMapperConfiguration(CmsObject cms, org.dom4j.Document doc) Parses a template mapper configuration from an XML document.
CmsTemplateMappingContentRewriter(CmsObject cms, CmsResource folder) Creates a new instance.

Uses of CmsObject in org.opencms.xml.types

Methods in org.opencms.xml.types with parameters of type CmsObject

Modifier and Type	Method and Description
org.dom4j.Element	CmsXmlNestedContentDefinition.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlVfsFileValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlVarLinkValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	A_CmsXmlContentValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlHtmlValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	I_CmsXmlSchemaType.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale) Appends an XML for a new, empty node of this schema type to the given root element.
org.dom4j.Element	CmsXmlCategoryValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
org.dom4j.Element	CmsXmlDynamicCategoryValue.generateXml(CmsObject cms, I_CmsXmlDocument document, org.dom4j.Element root, java.util.Locale locale)
static boolean	CmsXmlBooleanValue.getBooleanValue(CmsObject cms, I_CmsWidgetParameter value) Returns the boolean value of the given widget parameter.
java.lang.String	A_CmsXmlContentValue.getDefault(CmsObject cms)
java.lang.String	CmsXmlVfsImageValue.getDescription(CmsObject cms) Returns the description of the image.
java.lang.String	CmsXmlVfsImageValue.getFormat(CmsObject cms) Returns the format information of the image.
CmsLink	CmsXmlVfsFileValue.getLink(CmsObject cms) Returns the link object represented by this XML content value.
CmsLink	CmsXmlVarLinkValue.getLink(CmsObject cms) Returns the link object represented by this XML content value.
java.util.List<CmsLink>	CmsXmlCategoryValue.getLinks(CmsObject cms) Returns the link objects represented by this XML content value.
java.lang.String	CmsXmlPlainTextStringValue.getPlainText(CmsObject cms)
java.lang.String	A_CmsXmlValueCdataBase.getPlainText(CmsObject cms)
java.lang.String	CmsXmlVfsFileValue.getPlainText(CmsObject cms)
java.lang.String	CmsXmlVarLinkValue.getPlainText(CmsObject cms)
java.lang.String	A_CmsXmlValueTextBase.getPlainText(CmsObject cms)
java.lang.String	A_CmsXmlContentValue.getPlainText(CmsObject cms)
java.lang.String	CmsXmlHtmlValue.getPlainText(CmsObject cms)
java.lang.String	CmsXmlCategoryValue.getPlainText(CmsObject cms)
java.lang.String	CmsXmlDynamicCategoryValue.getPlainText(CmsObject cms)
java.lang.String	I_CmsXmlContentValue.getPlainText(CmsObject cms) Returns the value of this XML content node as a plain text String.
java.lang.String	CmsXmlVfsImageValue.getRequestLink(CmsObject cms) Returns the link without parameters from the string value.
java.lang.String	CmsXmlVfsImageValue.getScaleOptions(CmsObject cms) Returns the scale options of the image.
java.lang.String	A_CmsXmlValueCdataBase.getStringValue(CmsObject cms)
java.lang.String	CmsXmlNestedContentDefinition.getStringValue(CmsObject cms)
java.lang.String	CmsXmlVfsFileValue.getStringValue(CmsObject cms)
java.lang.String	CmsXmlVarLinkValue.getStringValue(CmsObject cms)
java.lang.String	A_CmsXmlValueTextBase.getStringValue(CmsObject cms)
java.lang.String	CmsXmlHtmlValue.getStringValue(CmsObject cms)
java.lang.String	CmsXmlCategoryValue.getStringValue(CmsObject cms)
java.lang.String	CmsXmlDynamicCategoryValue.getStringValue(CmsObject cms)
java.lang.String	I_CmsXmlContentValue.getStringValue(CmsObject cms) Returns the value of this XML content node as a String.
void	CmsXmlVfsImageValue.setDescription(CmsObject cms, java.lang.String description) Sets the description of the image.
void	CmsXmlVfsImageValue.setFormat(CmsObject cms, java.lang.String format) Sets the format information of the image.
void	CmsXmlVfsFileValue.setIdValue(CmsObject cms, CmsUUID id) Sets the value as a structure id.
void	CmsXmlCategoryValue.setIdValue(CmsObject cms, CmsUUID id) Sets the value as a structure id.
void	CmsXmlVfsImageValue.setScaleOptions(CmsObject cms, java.lang.String scaleOptions) Sets the scale options of the image.
void	A_CmsXmlValueCdataBase.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlNestedContentDefinition.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlVfsFileValue.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlVarLinkValue.setStringValue(CmsObject cms, java.lang.String value)
void	A_CmsXmlValueTextBase.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlHtmlValue.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlBooleanValue.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlCategoryValue.setStringValue(CmsObject cms, java.lang.String value)
void	CmsXmlDynamicCategoryValue.setStringValue(CmsObject cms, java.lang.String value)
void	I_CmsXmlContentValue.setStringValue(CmsObject cms, java.lang.String value) Sets the provided String as value of this XML content node.
void	CmsXmlVfsImageValue.setStringValue(CmsObject cms, java.lang.String value)