| 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.cmis | |
| org.opencms.configuration |
Reads and writes the XML based OpenCms configuration files.
|
| org.opencms.db |
Low-level database connection and access functionality.
|
| org.opencms.db.generic |
Generic (ANSI-SQL) implementation of the OpenCms database connector.
|
| 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.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.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.repository |
Package contains all classes and interfaces needed to create or use a repository to
access the resources in the VFS.
|
| org.opencms.rmi |
The CmsRemoteShell allows to manipulate a running server using OpenCms shell commands.
|
| 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.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.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.apps |
Contains code for workplace apps
|
| org.opencms.ui.apps.cacheadmin |
Contains classes of the cache admin app.
|
| org.opencms.ui.apps.search |
Contains classes of the source search app.
|
| org.opencms.ui.apps.sessions |
Contains classes of the site manager app.
|
| org.opencms.ui.apps.user |
Contains classes of the user manager app.
|
| org.opencms.ui.components.fileselect |
Contains components for selecting resources
|
| org.opencms.ui.dialogs |
Contains code for workplace dialogs
|
| org.opencms.ui.dialogs.availability |
Contains code for the availability dialog
|
| 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.editors.messagebundle |
The data bindings and logic for the translator editor.
|
| 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.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.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 |
| Modifier and Type | Method and Description |
|---|---|
boolean |
CmsResourceTypeConfig.checkCreatable(CmsObject cms,
java.lang.String pageFolderRootPath)
Checks if this resource type is creatable.
|
java.util.Map<java.lang.String,java.lang.String> |
CmsADEConfigCacheState.computeFolderTypes()
Computes the map from folder paths to content types for this ADE configuration state.
|
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.
|
protected void |
CmsADEConfigData.createContentDirectory()
Creates the content directory for this configuration node if possible.
|
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.
|
java.util.List<CmsResourceTypeConfig> |
CmsADEConfigData.getCreatableTypes(CmsObject cms,
java.lang.String pageFolderRootPath)
Returns a list of the creatable resource types.
|
CmsContainerElementBean |
CmsADEManager.getCurrentElement(javax.servlet.ServletRequest req)
Reads the current element bean from the request.
|
java.util.Map<java.lang.String,CmsXmlContentProperty> |
CmsADEManager.getElementSettings(CmsObject cms,
CmsResource resource)
Returns the element settings for a given resource.
|
java.util.List<CmsContainerElementBean> |
CmsADEManager.getFavoriteList(CmsObject cms)
Returns the favorite list, or creates it if not available.
|
protected java.util.Map<java.lang.String,java.lang.String> |
CmsADEConfigData.getFolderTypes()
Collects the folder types in a map.
|
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.
|
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.
|
protected java.lang.String |
CmsADEManager.getRootPath(CmsUUID structureId,
boolean online)
Gets the root path for a given resource structure id.
|
protected CmsProject |
CmsADEManager.getTempfileProject(CmsObject cms)
Gets a tempfile project, creating one if it doesn't exist already.
|
I_CmsResourceType |
CmsResourceTypeConfig.getType()
Gets the actual resource type for which this is a configuration.
|
void |
CmsADEManager.handleHtmlRedirect(CmsObject userCms,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
java.lang.String htmlRedirect)
Processes a HTML redirect content.
|
CmsADEConfigDataInternal |
CmsConfigurationReader.parseConfiguration(java.lang.String basePath,
CmsXmlContent content)
Parses a configuration XML content and creates a configuration object from it.
|
protected void |
CmsConfigurationReader.parseDetailPage(I_CmsXmlContentLocation node)
Parses the detail pages from an XML content node.
|
CmsContentFolderDescriptor |
CmsConfigurationReader.parseFolderOrName(java.lang.String basePath,
I_CmsXmlContentLocation location)
Parses a folder which may either be given as a path or as a folder name.
|
void |
CmsConfigurationReader.parseModelPage(I_CmsXmlContentLocation node)
Parses model page data from the XML content.
|
void |
CmsConfigurationReader.parseResourceTypeConfig(java.lang.String basePath,
I_CmsXmlContentLocation node)
Parses a resource type configuration element from the XML content.
|
CmsADEConfigDataInternal |
CmsConfigurationReader.parseSitemapConfiguration(java.lang.String basePath,
CmsResource configRes)
Parses the sitemap configuration given the configuration file and base path.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsFormatterBean |
CmsFormatterBeanParser.parse(CmsXmlContent content,
java.lang.String location,
java.lang.String id)
Reads the formatter bean from the given XML content.
|
| Constructor and Description |
|---|
CmsFormatterConfigurationCache(CmsObject cms,
java.lang.String name)
Creates a new formatter configuration cache instance.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
CmsContainerElementBean |
CmsContainerpageService.getCachedElement(java.lang.String clientId,
java.lang.String pageRootPath)
Reads the cached element-bean for the given client-side-id from cache.
|
CmsContainerElementData |
CmsElementUtil.getElementData(CmsResource page,
CmsContainerElementBean element,
java.util.Collection<CmsContainer> containers)
Returns the data for an element.
|
CmsElementSettingsConfig |
CmsElementUtil.getElementSettingsConfig(CmsResource page,
CmsContainerElementBean element,
java.lang.String containerId,
java.util.Collection<CmsContainer> containers)
Returns the formatter and settings config data for an element.
|
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.
|
CmsRemovedElementStatus |
CmsContainerpageService.internalGetRemovedElementStatus(CmsUUID structureId,
CmsUUID containerpageId)
Internal helper method to get the status of a removed element.
|
CmsContainerPageBean |
CmsModelGroupHelper.prepareforModelGroupContent(java.util.Map<java.lang.String,CmsContainerElementBean> elements,
java.util.List<java.lang.String> foundGroups,
CmsContainerPageBean page,
boolean alwaysCopy,
java.util.Locale locale)
Adds the model group elements to the page.
|
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.
|
CmsContainerPageBean |
CmsModelGroupHelper.saveModelGroups(CmsContainerPageBean page,
CmsResource pageResource)
Saves the model groups of the given container page.
|
CmsContainerElement |
CmsElementUtil.setElementInfo(CmsContainerElementBean elementBean,
CmsContainerElement result)
Sets the data to the given container element.
|
| Constructor and Description |
|---|
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.
|
| 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.
|
void |
CmsContainerConfigurationParser.parse(CmsFile file)
Parses the contents of a file.
|
void |
CmsContainerConfigurationParser.parse(CmsResource resource)
Parses the contents of a resource.
|
void |
CmsInheritanceReferenceParser.parse(CmsResource resource)
Parses a given resource.
|
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.
|
| Constructor and Description |
|---|
CmsContainerConfigurationCache(CmsObject cms,
java.lang.String name)
Creates a new cache instance for inherited containers.
|
| 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.
|
| 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 |
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.
|
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).
|
void |
CmsDetailPageConfigurationWriter.updateAndSave(java.util.List<CmsDetailPageInfo> infos,
CmsUUID newId)
Writes the new detail page information to the configuration file.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract T |
A_CmsTreeTabDataPreloader.createEntry(CmsObject cms,
CmsResource resource)
Creates a tree entry bean from a resource.
|
protected void |
A_CmsTreeTabDataPreloader.findRoot(java.util.Collection<CmsResource> resources)
Finds the common root folder for a collection of resources.
|
protected java.util.List<CmsResource> |
A_CmsTreeTabDataPreloader.getChildren(CmsResource resource)
Gets the children of a resource.
|
protected CmsObject |
CmsGalleryService.getSearchCms(CmsGallerySearchBean searchObj)
Gets an initialized CmsObject to be used for the actual search for a given search bean.
|
protected java.util.List<CmsResource> |
CmsGalleryService.getSitemapSubEntryResources(java.lang.String rootPath)
Gets the sitemap sub entries for a given path as resources.
|
protected java.util.List<CmsSitemapEntryBean> |
CmsGalleryService.getSubEntriesInternal(java.lang.String rootPath,
boolean isRoot,
java.lang.String filter)
Internal method for getting sitemap sub entries for a given root path.
|
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.
|
| 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.
|
protected java.util.List<CmsResource> |
CmsCollectorPublishListHelper.computeCollectorResults(boolean online)
Computes the collector results.
|
java.util.Set<CmsResource> |
I_CmsPublishRelatedResourceProvider.getAdditionalRelatedResources(CmsObject cms,
CmsResource res)
Gets the set of additional related resources.
|
CmsObject |
CmsCollectorPublishListHelper.getCmsObject(boolean online)
Initializes a CmsObject.
|
java.util.Set<CmsResource> |
CmsCollectorPublishListHelper.getPublishListFiles()
Gets the list to add to the publish list for the collector list.
|
java.util.Set<CmsResource> |
CmsDefaultCollectorPublishListProvider.getPublishResources(CmsObject cms,
I_CmsContentLoadCollectorInfo info) |
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> |
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> |
CmsRealProjectVirtualWrapper.getResources(CmsObject cms,
java.util.Map<java.lang.String,java.lang.String> params,
java.lang.String workflowId) |
void |
CmsPublish.publishResources(java.util.List<CmsResource> resources)
Publishes the given list of resources.
|
void |
CmsPublish.removeResourcesFromPublishList(java.util.Collection<CmsUUID> idsToRemove)
Removes the given resources from the user's publish list.
|
protected CmsPublishResource |
CmsPublish.resourceToBean(CmsResource resource,
CmsPublishResourceInfo info,
boolean removable,
java.util.List<CmsPublishResource> related)
Creates a publish resource bean instance from the given parameters.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsModelPageHelper.addModelPageToSitemapConfiguration(CmsResource sitemapConfig,
CmsResource modelPage,
boolean disabled)
Adds a model page to the sitemap config.
|
CmsResource |
CmsModelPageHelper.createModelGroupPage(java.lang.String name,
java.lang.String description,
CmsUUID copyId)
Creates a new model group page.
|
CmsResource |
CmsModelPageHelper.createPageInModelFolder(java.lang.String name,
java.lang.String description,
CmsUUID copyId)
Creates a new potential model page in the default folder for new model pages.
|
protected CmsBrokenLinkBean |
CmsVfsSitemapService.createSitemapBrokenLinkBean(CmsResource resource)
Creates a "broken link" bean based on a resource.
|
void |
CmsModelPageHelper.disableModelPage(CmsResource sitemapConfig,
CmsUUID structureId,
boolean disabled)
Disables the given model page.
|
protected CmsVfsSitemapService.LockInfo |
CmsVfsSitemapService.ensureLockAndGetInfo(CmsResource resource)
Locks the given resource with a temporary, if not already locked by the current user.
|
CmsResource |
CmsModelPageHelper.ensureModelFolder(CmsResource rootResource)
Tries to either read or create the default folder for model pages in the current sitemap, and returns it.
|
void |
CmsModelPageHelper.removeModelPage(CmsResource sitemapConfig,
CmsUUID structureId)
Removes a model page from the sitemap configuration.
|
CmsAliasEditValidationReply |
CmsAliasBulkEditHelper.saveAliases(CmsAliasSaveValidationRequest saveRequest)
Saves alias changes to the database.
|
protected CmsSitemapChange |
CmsVfsSitemapService.saveInternal(java.lang.String entryPoint,
CmsSitemapChange change)
Internal method for saving a sitemap.
|
| Constructor and Description |
|---|
CmsModelPageHelper(CmsObject cms,
CmsResource rootResource)
Creates a new instance.
|
| Constructor and Description |
|---|
CmsUploadBean(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Constructor, with parameters.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
CmsCmisUtil.handleCmsException(CmsException e)
Wrap OpenCms into OpenCMIS exceptions and rethrow them.
|
| Modifier and Type | Method and Description |
|---|---|
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.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.
|
static boolean |
CmsCmisUtil.ensureLock(CmsObject cms,
CmsResource resource)
Tries to lock a resource and throws an exception if it can't be locked.
|
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.
|
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.
|
| Constructor and Description |
|---|
CmsCmisTypeManager(CmsObject adminCms,
java.util.List<I_CmsPropertyProvider> propertyProviders)
Creates a new type manager instance.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsConfigurationException
Exceptions that occur during the XML configuration process.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsConfigurationException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsDbConsistencyException
Signals that a data source consistency problem has been detected.
|
class |
CmsDbEntryAlreadyExistsException
Signals that an attempt to create an object was not successfull because it already exists.
|
class |
CmsDbEntryNotFoundException
Signals that an attempt to read an object from a data source, that
is supposed to exist, was not successfull.
|
class |
CmsDbException
Signals that a low-level exception occurred when accessing the OpenCms database.
|
class |
CmsDbIoException
Signals that an IO exception occurred when reading from or writing to the OpenCms database.
|
class |
CmsDbKeyException
Signals that a foreign key in the VFS STRUCTURE, RESOURCES or FILES database tables is either
invalid or empty.
|
class |
CmsDbSqlException
Used to signal sql related issues.
|
class |
CmsVfsOnlineResourceAlreadyExistsException
Signals that an attempt to create a resource was not successfull
since at the given location another online resource with a different
structure id has been found.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsDbConsistencyException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbIoException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbEntryNotFoundException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbSqlException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbKeyException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDbEntryAlreadyExistsException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsVfsOnlineResourceAlreadyExistsException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsDriverManager.addAlias(CmsDbContext dbc,
CmsProject project,
CmsAlias alias)
Adds an alias entry.
|
void |
CmsSecurityManager.addAlias(CmsRequestContext context,
CmsAlias alias)
Adds an alias.
|
void |
CmsDriverManager.addRelationToResource(CmsDbContext dbc,
CmsResource resource,
CmsResource target,
CmsRelationType type,
boolean importCase)
Adds a new relation to the given resource.
|
void |
CmsSecurityManager.addRelationToResource(CmsRequestContext context,
CmsResource resource,
CmsResource target,
CmsRelationType type,
boolean importCase)
Adds a new relation to a given resource.
|
void |
CmsDriverManager.addResourceToOrgUnit(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
CmsResource resource)
Adds a resource to the given organizational unit.
|
void |
CmsSecurityManager.addResourceToOrgUnit(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
CmsResource resource)
Adds a resource to the given organizational unit.
|
void |
CmsDriverManager.addUserToGroup(CmsDbContext dbc,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Adds a user to a group.
|
void |
CmsSecurityManager.addUserToGroup(CmsRequestContext context,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Adds a user to a group.
|
void |
CmsDriverManager.changeLock(CmsDbContext dbc,
CmsResource resource,
CmsLockType lockType)
Changes the lock of a resource to the current user,
that is "steals" the lock from another user.
|
void |
CmsSecurityManager.changeLock(CmsRequestContext context,
CmsResource resource)
Changes the lock of a resource to the current user, that is "steals" the lock from another user.
|
java.util.List<CmsResource> |
CmsDriverManager.changeResourcesInFolderWithProperty(CmsDbContext dbc,
CmsResource resource,
java.lang.String propertyDefinition,
java.lang.String oldValue,
java.lang.String newValue,
boolean recursive)
Returns a list with all sub resources of a given folder that have set the given property,
matching the current property's value with the given old value and replacing it by a given new value.
|
java.util.List<CmsResource> |
CmsSecurityManager.changeResourcesInFolderWithProperty(CmsRequestContext context,
CmsResource resource,
java.lang.String propertyDefinition,
java.lang.String oldValue,
java.lang.String newValue,
boolean recursive)
Returns a list with all sub resources of a given folder that have set the given property,
matching the current property's value with the given old value and replacing it by a given new value.
|
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 |
CmsSecurityManager.checkPermissions(CmsDbContext dbc,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Performs a blocking permission check on a resource.
|
void |
CmsSecurityManager.checkPermissions(CmsRequestContext context,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Performs a blocking permission check on a resource.
|
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.
|
void |
CmsSecurityManager.checkPublishPermissions(CmsDbContext dbc,
CmsPublishList publishList)
Checks if the current user has the permissions to publish the given publish list
(which contains the information about the resources / project to publish).
|
protected void |
CmsSecurityManager.checkSystemLocks(CmsDbContext dbc,
CmsResource resource)
Checks if the given resource contains a resource that has a system lock.
|
void |
CmsDriverManager.chflags(CmsDbContext dbc,
CmsResource resource,
int flags)
Changes the resource flags of a resource.
|
void |
CmsSecurityManager.chflags(CmsRequestContext context,
CmsResource resource,
int flags)
Changes the resource flags of a resource.
|
void |
CmsDriverManager.chtype(CmsDbContext dbc,
CmsResource resource,
int type)
Changes the resource type of a resource.
|
void |
CmsSecurityManager.chtype(CmsRequestContext context,
CmsResource resource,
int type)
Changes the resource type of a resource.
|
protected boolean |
CmsPublishList.containsSubResources(CmsObject cms,
CmsResource folder)
Checks if the publish list contains all sub-resources of a given folder.
|
void |
CmsDriverManager.copyAccessControlEntries(CmsDbContext dbc,
CmsResource source,
CmsResource destination,
boolean updateLastModifiedInfo)
Copies the access control entries of a given resource to a destination resource.
|
void |
CmsSecurityManager.copyAccessControlEntries(CmsRequestContext context,
CmsResource source,
CmsResource destination)
Copies the access control entries of a given resource to a destination resource.
|
void |
CmsDriverManager.copyResource(CmsDbContext dbc,
CmsResource source,
java.lang.String destination,
CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
void |
CmsSecurityManager.copyResource(CmsRequestContext context,
CmsResource source,
java.lang.String destination,
CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
void |
CmsDriverManager.copyResourceToProject(CmsDbContext dbc,
CmsResource resource)
Copies a resource to the current project of the user.
|
void |
CmsSecurityManager.copyResourceToProject(CmsRequestContext context,
CmsResource resource)
Copies a resource to the current project of the user.
|
int |
CmsSecurityManager.countLockedResources(CmsRequestContext context,
CmsUUID id)
Counts the locked resources in this project.
|
long |
CmsSecurityManager.countUsers(CmsRequestContext requestContext,
CmsUserSearchParameters searchParams)
Counts the total number of users which match the given search criteria.
|
CmsGroup |
CmsDriverManager.createGroup(CmsDbContext dbc,
CmsUUID id,
java.lang.String name,
java.lang.String description,
int flags,
java.lang.String parent)
Add a new group to the Cms.
|
CmsGroup |
CmsSecurityManager.createGroup(CmsRequestContext context,
java.lang.String name,
java.lang.String description,
int flags,
java.lang.String parent)
Creates a new user group.
|
CmsOrganizationalUnit |
CmsDriverManager.createOrganizationalUnit(CmsDbContext dbc,
java.lang.String ouFqn,
java.lang.String description,
int flags,
CmsResource resource)
Creates a new organizational unit.
|
CmsOrganizationalUnit |
CmsSecurityManager.createOrganizationalUnit(CmsRequestContext context,
java.lang.String ouFqn,
java.lang.String description,
int flags,
CmsResource resource)
Creates a new organizational unit.
|
CmsProject |
CmsDriverManager.createProject(CmsDbContext dbc,
java.lang.String name,
java.lang.String description,
java.lang.String groupname,
java.lang.String managergroupname,
CmsProject.CmsProjectType projecttype)
Creates a project.
|
CmsProject |
CmsSecurityManager.createProject(CmsRequestContext context,
java.lang.String name,
java.lang.String description,
java.lang.String groupname,
java.lang.String managergroupname,
CmsProject.CmsProjectType projecttype)
Creates a project.
|
CmsPropertyDefinition |
CmsDriverManager.createPropertyDefinition(CmsDbContext dbc,
java.lang.String name)
Creates a property definition.
|
CmsPropertyDefinition |
CmsSecurityManager.createPropertyDefinition(CmsRequestContext context,
java.lang.String name)
Creates a property definition.
|
void |
CmsDriverManager.createPublishJob(CmsDbContext dbc,
CmsPublishJobInfoBean publishJob)
Creates a new publish job.
|
CmsResource |
CmsDriverManager.createResource(CmsDbContext dbc,
java.lang.String resourcePath,
CmsResource resource,
byte[] content,
java.util.List<CmsProperty> properties,
boolean importCase)
Creates a new resource with the provided content and properties.
|
CmsResource |
CmsDriverManager.createResource(CmsDbContext dbc,
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.
|
CmsResource |
CmsSecurityManager.createResource(CmsRequestContext context,
java.lang.String resourcePath,
CmsResource resource,
byte[] content,
java.util.List<CmsProperty> properties)
Creates a new resource with the provided content and properties.
|
CmsResource |
CmsSecurityManager.createResource(CmsRequestContext context,
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.
|
CmsResource |
CmsDriverManager.createSibling(CmsDbContext dbc,
CmsResource source,
java.lang.String destination,
java.util.List<CmsProperty> properties)
Creates a new sibling of the source resource.
|
CmsResource |
CmsSecurityManager.createSibling(CmsRequestContext context,
CmsResource source,
java.lang.String destination,
java.util.List<CmsProperty> properties)
Creates a new sibling of the source resource.
|
CmsProject |
CmsDriverManager.createTempfileProject(CmsDbContext dbc)
Creates the project for the temporary workplace files.
|
CmsProject |
CmsSecurityManager.createTempfileProject(CmsRequestContext context)
Creates the project for the temporary workplace files.
|
CmsUser |
CmsDriverManager.createUser(CmsDbContext dbc,
java.lang.String name,
java.lang.String password,
java.lang.String description,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user.
|
CmsUser |
CmsSecurityManager.createUser(CmsRequestContext context,
java.lang.String name,
java.lang.String password,
java.lang.String description,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user.
|
void |
CmsDriverManager.deleteAliases(CmsDbContext dbc,
CmsProject project,
CmsAliasFilter filter)
Deletes aliases indicated by a filter.
|
void |
CmsSecurityManager.deleteAliases(CmsRequestContext context,
CmsAliasFilter filter)
Deletes alias entries matching a filter.
|
void |
CmsDriverManager.deleteAllProperties(CmsDbContext dbc,
java.lang.String resourcename)
Deletes all property values of a file or folder.
|
void |
CmsDriverManager.deleteAllStaticExportPublishedResources(CmsDbContext dbc,
int linkType)
Deletes all entries in the published resource table.
|
void |
CmsSecurityManager.deleteAllStaticExportPublishedResources(CmsRequestContext context,
int linkType)
Deletes all entries in the published resource table.
|
void |
CmsDriverManager.deleteGroup(CmsDbContext dbc,
CmsGroup group,
CmsUUID replacementId)
Deletes a group, where all permissions, users and children of the group
are transfered to a replacement group.
|
void |
CmsSecurityManager.deleteGroup(CmsRequestContext context,
CmsUUID groupId,
CmsUUID replacementId)
Deletes a group, where all permissions, users and children of the group
are transfered to a replacement group.
|
void |
CmsSecurityManager.deleteGroup(CmsRequestContext context,
java.lang.String name)
Delete a user group.
|
void |
CmsDriverManager.deleteHistoricalVersions(CmsDbContext dbc,
int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
void |
CmsSecurityManager.deleteHistoricalVersions(CmsRequestContext context,
int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
void |
CmsDriverManager.deleteLogEntries(CmsDbContext dbc,
CmsLogFilter filter)
Deletes all log entries matching the given filter.
|
void |
CmsSecurityManager.deleteLogEntries(CmsRequestContext context,
CmsLogFilter filter)
Deletes all log entries matching the given filter.
|
void |
CmsDriverManager.deleteOrganizationalUnit(CmsDbContext dbc,
CmsOrganizationalUnit organizationalUnit)
Deletes an organizational unit.
|
void |
CmsSecurityManager.deleteOrganizationalUnit(CmsRequestContext context,
CmsOrganizationalUnit organizationalUnit)
Deletes an organizational unit.
|
void |
CmsDriverManager.deleteProject(CmsDbContext dbc,
CmsProject deleteProject)
Deletes a project.
|
void |
CmsDriverManager.deleteProject(CmsDbContext dbc,
CmsProject deleteProject,
boolean resetResources)
Deletes a project.
|
void |
CmsSecurityManager.deleteProject(CmsRequestContext context,
CmsUUID projectId)
Deletes a project.
|
void |
CmsDriverManager.deletePropertyDefinition(CmsDbContext dbc,
java.lang.String name)
Deletes a property definition.
|
void |
CmsSecurityManager.deletePropertyDefinition(CmsRequestContext context,
java.lang.String name)
Deletes a property definition.
|
void |
CmsDriverManager.deletePublishJob(CmsDbContext dbc,
CmsUUID publishHistoryId)
Deletes a publish job identified by its history id.
|
void |
CmsDriverManager.deletePublishList(CmsDbContext dbc,
CmsUUID publishHistoryId)
Deletes the publish list assigned to a publish job.
|
void |
CmsDriverManager.deleteRelationsForResource(CmsDbContext dbc,
CmsResource resource,
CmsRelationFilter filter)
Deletes all relations for the given resource matching the given filter.
|
void |
CmsSecurityManager.deleteRelationsForResource(CmsRequestContext context,
CmsResource resource,
CmsRelationFilter filter)
Deletes all relations for the given resource matching the given filter.
|
protected void |
CmsDriverManager.deleteRelationsWithSiblings(CmsDbContext dbc,
CmsResource resource)
Deletes all relations for the given resource and all its siblings.
|
void |
CmsDriverManager.deleteResource(CmsDbContext dbc,
CmsResource resource,
CmsResource.CmsResourceDeleteMode siblingMode)
Deletes a resource.
|
protected void |
CmsSecurityManager.deleteResource(CmsDbContext dbc,
CmsResource resource,
CmsResource.CmsResourceDeleteMode siblingMode)
Internal recursive method for deleting a resource.
|
void |
CmsSecurityManager.deleteResource(CmsRequestContext context,
CmsResource resource,
CmsResource.CmsResourceDeleteMode siblingMode)
Deletes a resource given its name.
|
void |
CmsDriverManager.deleteStaticExportPublishedResource(CmsDbContext dbc,
java.lang.String resourceName,
int linkType,
java.lang.String linkParameter)
Deletes an entry in the published resource table.
|
void |
CmsSecurityManager.deleteStaticExportPublishedResource(CmsRequestContext context,
java.lang.String resourceName,
int linkType,
java.lang.String linkParameter)
Deletes an entry in the published resource table.
|
void |
CmsDriverManager.deleteUser(CmsDbContext dbc,
CmsProject project,
java.lang.String username,
java.lang.String replacementUsername)
Deletes a user, where all permissions and resources attributes of the user
were transfered to a replacement user, if given.
|
protected void |
CmsSecurityManager.deleteUser(CmsRequestContext context,
CmsUser user,
CmsUser replacement)
Deletes a user, where all permissions and resources attributes of the user
were transfered to a replacement user, if given.
|
void |
CmsSecurityManager.deleteUser(CmsRequestContext context,
CmsUUID userId)
Deletes a user.
|
void |
CmsSecurityManager.deleteUser(CmsRequestContext context,
CmsUUID userId,
CmsUUID replacementId)
Deletes a user, where all permissions and resources attributes of the user
were transfered to a replacement user.
|
void |
CmsSecurityManager.deleteUser(CmsRequestContext context,
java.lang.String username)
Deletes a user.
|
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.
|
boolean |
CmsDriverManager.existsResourceId(CmsDbContext dbc,
CmsUUID resourceId)
Tests if a resource with the given resourceId does already exist in the Database.
|
void |
CmsDriverManager.fillPublishList(CmsDbContext dbc,
CmsPublishList publishList)
Fills the given publish list with the the VFS resources that actually get published.
|
CmsPublishList |
CmsSecurityManager.fillPublishList(CmsRequestContext context,
CmsPublishList publishList)
Fills the given publish list with the the VFS resources that actually get published.
|
java.util.List<CmsAccessControlEntry> |
CmsDriverManager.getAccessControlEntries(CmsDbContext dbc,
CmsResource resource,
boolean getInherited)
Returns the list of access control entries of a resource given its name.
|
java.util.List<CmsAccessControlEntry> |
CmsSecurityManager.getAccessControlEntries(CmsRequestContext context,
CmsResource resource,
boolean getInherited)
Returns the list of access control entries of a resource given its name.
|
CmsAccessControlList |
CmsDriverManager.getAccessControlList(CmsDbContext dbc,
CmsResource resource)
Returns the full access control list of a given resource.
|
CmsAccessControlList |
CmsDriverManager.getAccessControlList(CmsDbContext dbc,
CmsResource resource,
boolean inheritedOnly)
Returns the access control list of a given resource.
|
CmsAccessControlList |
CmsSecurityManager.getAccessControlList(CmsRequestContext context,
CmsResource resource,
boolean inheritedOnly)
Returns the access control list (summarized access control entries) of a given resource.
|
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> |
CmsSecurityManager.getAliasesForSite(CmsRequestContext requestContext,
java.lang.String siteRoot)
Gets the aliases for a given site.
|
java.util.List<CmsAlias> |
CmsAliasManager.getAliasesForStructureId(CmsObject cms,
CmsUUID structureId)
Gets the aliases for a given structure id.
|
java.util.List<CmsAccessControlEntry> |
CmsDriverManager.getAllAccessControlEntries(CmsDbContext dbc)
Reads all access control entries.
|
java.util.List<CmsAccessControlEntry> |
CmsSecurityManager.getAllAccessControlEntries(CmsRequestContext context)
Gets all access control entries.
|
java.util.List<CmsProject> |
CmsDriverManager.getAllAccessibleProjects(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus)
Returns all projects which are owned by the current user or which are
accessible by the current user.
|
java.util.List<CmsProject> |
CmsSecurityManager.getAllAccessibleProjects(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus)
Returns all projects which are owned by the current user or which are
accessible for the group of the user.
|
java.util.List<CmsHistoryProject> |
CmsDriverManager.getAllHistoricalProjects(CmsDbContext dbc)
Returns a list with all projects from history.
|
java.util.List<CmsHistoryProject> |
CmsSecurityManager.getAllHistoricalProjects(CmsRequestContext context)
Returns a list with all projects from history.
|
java.util.List<CmsProject> |
CmsDriverManager.getAllManageableProjects(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus)
Returns all projects which are owned by the current user or which are manageable
for the group of the user.
|
java.util.List<CmsProject> |
CmsSecurityManager.getAllManageableProjects(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus)
Returns all projects which are owned by the current user or which are manageable
for the group of the user.
|
java.util.List<CmsGroup> |
CmsDriverManager.getChildren(CmsDbContext dbc,
CmsGroup group,
boolean includeSubChildren)
Returns all child groups of a group.
|
java.util.List<CmsGroup> |
CmsSecurityManager.getChildren(CmsRequestContext context,
java.lang.String groupname,
boolean includeSubChildren)
Returns all child groups of a group.
|
long |
CmsDriverManager.getDateLastVisitedBy(CmsDbContext dbc,
java.lang.String poolName,
CmsUser user,
CmsResource resource)
Returns the date when the resource was last visited by the user.
|
long |
I_CmsSubscriptionDriver.getDateLastVisitedBy(CmsDbContext dbc,
java.lang.String poolName,
CmsUser user,
CmsResource resource)
Returns the date when the resource was last visited by the user.
|
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.
|
long |
CmsSecurityManager.getDateLastVisitedBy(CmsRequestContext context,
java.lang.String poolName,
CmsUser user,
CmsResource resource)
Returns the date when the resource was last visited by the user.
|
java.util.List<CmsGroup> |
CmsDriverManager.getGroups(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus,
boolean readRoles)
Returns all groups of the given organizational unit.
|
java.util.List<CmsGroup> |
CmsSecurityManager.getGroups(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
boolean includeSubOus,
boolean readRoles)
Returns all groups of the given organizational unit.
|
java.util.List<CmsGroup> |
CmsDriverManager.getGroupsOfUser(CmsDbContext dbc,
java.lang.String username,
boolean readRoles)
Returns the groups of an user filtered by the specified IP address.
|
java.util.List<CmsGroup> |
CmsDriverManager.getGroupsOfUser(CmsDbContext dbc,
java.lang.String username,
java.lang.String ouFqn,
boolean includeChildOus,
boolean readRoles,
boolean directGroupsOnly,
java.lang.String remoteAddress)
Returns the groups of an user filtered by the specified IP address.
|
java.util.List<CmsGroup> |
CmsSecurityManager.getGroupsOfUser(CmsRequestContext context,
java.lang.String username,
java.lang.String ouFqn,
boolean includeChildOus,
boolean readRoles,
boolean directGroupsOnly,
java.lang.String remoteAddress)
Returns the list of groups to which the user directly belongs to.
|
CmsLock |
CmsDriverManager.getLock(CmsDbContext dbc,
CmsResource resource)
Returns the lock state of a resource.
|
CmsLock |
CmsSecurityManager.getLock(CmsRequestContext context,
CmsResource resource)
Returns the lock state of a resource.
|
java.util.List<java.lang.String> |
CmsDriverManager.getLockedResources(CmsDbContext dbc,
CmsResource resource,
CmsLockFilter filter)
Returns all locked resources in a given folder.
|
java.util.List<java.lang.String> |
CmsSecurityManager.getLockedResources(CmsRequestContext context,
CmsResource resource,
CmsLockFilter filter)
Returns all locked resources in a given folder.
|
java.util.List<CmsResource> |
CmsDriverManager.getLockedResourcesObjects(CmsDbContext dbc,
CmsResource resource,
CmsLockFilter filter)
Returns all locked resources in a given folder.
|
java.util.List<CmsResource> |
CmsSecurityManager.getLockedResourcesObjects(CmsRequestContext context,
CmsResource resource,
CmsLockFilter filter)
Returns all locked resources in a given folder.
|
java.util.List<CmsResource> |
CmsDriverManager.getLockedResourcesObjectsWithCache(CmsDbContext dbc,
CmsResource resource,
CmsLockFilter filter,
java.util.Map<java.lang.String,CmsResource> cache)
Returns all locked resources in a given folder, but uses a cache for resource lookups.
|
java.util.List<CmsResource> |
CmsSecurityManager.getLockedResourcesObjectsWithCache(CmsRequestContext context,
CmsResource resource,
CmsLockFilter filter,
java.util.Map<java.lang.String,CmsResource> cache)
Returns all locked resources in a given folder, but uses a cache for resource lookups.
|
java.util.List<CmsLogEntry> |
CmsDriverManager.getLogEntries(CmsDbContext dbc,
CmsLogFilter filter)
Returns all log entries matching the given filter.
|
java.util.List<CmsLogEntry> |
CmsSecurityManager.getLogEntries(CmsRequestContext context,
CmsLogFilter filter)
Returns all log entries matching the given filter.
|
protected java.util.List<CmsResource> |
CmsSecurityManager.getManageableResources(CmsDbContext dbc,
CmsRole role)
Returns all resources of organizational units for which the current user has
the given role role.
|
java.util.List<CmsResource> |
CmsSecurityManager.getManageableResources(CmsRequestContext context,
CmsRole role)
Returns all resources of organizational units for which the current user has
the given role role.
|
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<CmsOrganizationalUnit> |
CmsDriverManager.getOrganizationalUnits(CmsDbContext dbc,
CmsOrganizationalUnit parent,
boolean includeChildren)
Returns all child organizational units of the given parent organizational unit including
hierarchical deeper organization units if needed.
|
java.util.List<CmsOrganizationalUnit> |
CmsSecurityManager.getOrganizationalUnits(CmsRequestContext context,
CmsOrganizationalUnit parent,
boolean includeChildren)
Returns all child organizational units of the given parent organizational unit including
hierarchical deeper organization units if needed.
|
java.util.List<CmsOrganizationalUnit> |
CmsDriverManager.getOrgUnitsForRole(CmsDbContext dbc,
CmsRole role,
boolean includeSubOus)
Returns all the organizational units for which the current user has the given role.
|
java.util.List<CmsOrganizationalUnit> |
CmsSecurityManager.getOrgUnitsForRole(CmsRequestContext requestContext,
CmsRole role,
boolean includeSubOus)
Returns all the organizational units for which the current user has the given role.
|
CmsGroup |
CmsDriverManager.getParent(CmsDbContext dbc,
java.lang.String groupname)
Returns the parent group of a group.
|
CmsGroup |
CmsSecurityManager.getParent(CmsRequestContext context,
java.lang.String groupname)
Returns the parent group of a group.
|
CmsPermissionSetCustom |
CmsDriverManager.getPermissions(CmsDbContext dbc,
CmsResource resource,
CmsUser user)
Returns the set of permissions of the current user for a given resource.
|
CmsPermissionSetCustom |
CmsSecurityManager.getPermissions(CmsRequestContext context,
CmsResource resource,
CmsUser user)
Returns the set of permissions of the current user for a given resource.
|
CmsUUID |
CmsDriverManager.getProjectId(CmsDbContext dbc,
int id)
Returns the uuid id for the given id.
|
CmsUUID |
CmsSecurityManager.getProjectId(CmsRequestContext context,
int id)
Returns the uuid id for the given id,
remove this method as soon as possible.
|
CmsPublishList |
CmsDriverManager.getRelatedResourcesToPublish(CmsDbContext dbc,
CmsPublishList publishList,
CmsRelationFilter filter)
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.
|
CmsPublishList |
CmsSecurityManager.getRelatedResourcesToPublish(CmsRequestContext context,
CmsPublishList publishList,
CmsRelationFilter filter)
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.util.List<CmsRelation> |
CmsDriverManager.getRelationsForResource(CmsDbContext dbc,
CmsResource resource,
CmsRelationFilter filter)
Returns all relations for the given resource matching the given filter.
|
java.util.List<CmsRelation> |
CmsSecurityManager.getRelationsForResource(CmsRequestContext context,
CmsResource resource,
CmsRelationFilter filter)
Returns all relations for the given resource matching the given filter.
|
java.util.List<CmsOrganizationalUnit> |
CmsDriverManager.getResourceOrgUnits(CmsDbContext dbc,
CmsResource resource)
Returns the list of organizational units the given resource belongs to.
|
java.util.List<CmsResource> |
CmsDriverManager.getResourcesForOrganizationalUnit(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit)
Returns all resources of the given organizational unit.
|
java.util.List<CmsResource> |
CmsSecurityManager.getResourcesForOrganizationalUnit(CmsRequestContext context,
CmsOrganizationalUnit orgUnit)
Returns all resources of the given organizational unit.
|
java.util.Set<CmsResource> |
CmsDriverManager.getResourcesForPrincipal(CmsDbContext dbc,
CmsProject project,
CmsUUID principalId,
CmsPermissionSet permissions,
boolean includeAttr)
Returns all resources associated to a given principal via an ACE with the given permissions.
|
java.util.Set<CmsResource> |
CmsSecurityManager.getResourcesForPrincipal(CmsRequestContext context,
CmsUUID principalId,
CmsPermissionSet permissions,
boolean includeAttr)
Returns all resources associated to a given principal via an ACE with the given permissions.
|
java.util.List<CmsRewriteAlias> |
CmsDriverManager.getRewriteAliases(CmsDbContext dbc,
CmsRewriteAliasFilter filter)
Gets the rewrite aliases matching a given filter.
|
java.util.List<CmsRewriteAlias> |
CmsAliasManager.getRewriteAliases(CmsObject cms,
java.lang.String siteRoot)
Reads the rewrite aliases for a given site root.
|
java.util.List<CmsRewriteAlias> |
CmsSecurityManager.getRewriteAliases(CmsRequestContext requestContext,
CmsRewriteAliasFilter filter)
Gets the rewrite aliases matching a given filter.
|
CmsRewriteAliasMatcher |
CmsAliasManager.getRewriteAliasMatcher(CmsObject cms,
java.lang.String siteRoot)
Gets the rewrite alias matcher for the given site.
|
java.util.Set<CmsGroup> |
CmsDriverManager.getRoleGroups(CmsDbContext dbc,
java.lang.String roleGroupName,
boolean directUsersOnly)
Collects the groups which constitute a given role.
|
java.util.Set<CmsGroup> |
CmsSecurityManager.getRoleGroups(CmsRequestContext context,
CmsRole role,
boolean directUsersOnly)
Gets the groups which constitute a given role.
|
java.util.Set<CmsGroup> |
CmsDriverManager.getRoleGroupsImpl(CmsDbContext dbc,
java.lang.String roleGroupName,
boolean directUsersOnly,
java.util.Map<java.lang.String,java.util.Set<CmsGroup>> accumulator)
Collects the groups which constitute a given role.
|
java.util.List<CmsRole> |
CmsDriverManager.getRolesForResource(CmsDbContext dbc,
CmsUser user,
CmsResource resource)
Returns all roles the given user has for the given resource.
|
java.util.List<CmsRole> |
CmsSecurityManager.getRolesForResource(CmsRequestContext context,
CmsUser user,
CmsResource resource)
Returns all roles the given user has for the given resource.
|
java.util.List<CmsRole> |
CmsDriverManager.getRolesForUser(CmsDbContext dbc,
CmsUser user)
Returns all roles the given user has independent of the resource.
|
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.
|
java.util.List<CmsUser> |
CmsDriverManager.getUsers(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean recursive)
Returns all direct users of the given organizational unit.
|
java.util.List<CmsUser> |
CmsSecurityManager.getUsers(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
boolean recursive)
Returns all users of the given organizational unit.
|
java.util.List<CmsUser> |
CmsDriverManager.getUsersOfGroup(CmsDbContext dbc,
java.lang.String groupname,
boolean includeOtherOuUsers,
boolean directUsersOnly,
boolean readRoles)
Returns a list of users in a group.
|
java.util.List<CmsUser> |
CmsSecurityManager.getUsersOfGroup(CmsRequestContext context,
java.lang.String groupname,
boolean includeOtherOuUsers,
boolean directUsersOnly,
boolean readRoles)
Returns a list of users in a group.
|
java.util.List<CmsResource> |
CmsSecurityManager.getUsersPubList(CmsRequestContext context)
Returns the current user's publish list.
|
java.util.List<CmsUser> |
CmsDriverManager.getUsersWithoutAdditionalInfo(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
boolean recursive)
Returns all direct users of the given organizational unit, without their additional info.
|
java.util.List<CmsUser> |
CmsSecurityManager.getUsersWithoutAdditionalInfo(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
boolean recursive)
Returns all users of the given organizational unit.
|
protected I_CmsPermissionHandler.CmsPermissionCheckResult |
CmsSecurityManager.hasPermissions(CmsDbContext dbc,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Performs a non-blocking permission check on a resource.
|
I_CmsPermissionHandler.CmsPermissionCheckResult |
CmsSecurityManager.hasPermissions(CmsRequestContext context,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Performs a non-blocking permission check on a resource.
|
void |
CmsDriverManager.importAccessControlEntries(CmsDbContext dbc,
CmsResource resource,
java.util.List<CmsAccessControlEntry> acEntries)
Writes a vector of access control entries as new access control entries of a given resource.
|
void |
CmsSecurityManager.importAccessControlEntries(CmsRequestContext context,
CmsResource resource,
java.util.List<CmsAccessControlEntry> acEntries)
Writes a list of access control entries as new access control entries of a given resource.
|
protected CmsAliasImportResult |
CmsAliasManager.importAlias(CmsObject cms,
java.lang.String siteRoot,
java.lang.String aliasPath,
java.lang.String vfsPath,
CmsAliasMode mode)
Imports a single alias.
|
void |
CmsImportFolder.importFolder(java.lang.String importFolderName,
java.lang.String importPath,
CmsObject cms)
Import that will read from the real file system.
|
CmsResource |
CmsSecurityManager.importResource(CmsRequestContext context,
java.lang.String resourcePath,
CmsResource resource,
byte[] content,
java.util.List<CmsProperty> properties,
boolean importCase)
Creates a new resource with the provided content and properties.
|
CmsAliasImportResult |
CmsDriverManager.importRewriteAlias(CmsDbContext dbc,
java.lang.String siteRoot,
java.lang.String source,
java.lang.String target,
CmsAliasMode mode)
Imports a rewrite alias.
|
CmsAliasImportResult |
CmsSecurityManager.importRewriteAlias(CmsRequestContext requestContext,
java.lang.String siteRoot,
java.lang.String source,
java.lang.String target,
CmsAliasMode mode)
Imports a rewrite alias.
|
CmsUser |
CmsDriverManager.importUser(CmsDbContext dbc,
java.lang.String id,
java.lang.String name,
java.lang.String password,
java.lang.String firstname,
java.lang.String lastname,
java.lang.String email,
int flags,
long dateCreated,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user by import.
|
CmsUser |
CmsSecurityManager.importUser(CmsRequestContext context,
java.lang.String id,
java.lang.String name,
java.lang.String password,
java.lang.String firstname,
java.lang.String lastname,
java.lang.String email,
int flags,
long dateCreated,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user by import.
|
void |
CmsImportFolder.importZip(byte[] content,
java.lang.String importPath,
CmsObject cms,
boolean noSubFolder)
Import that will read from a ZIP file.
|
int |
CmsDriverManager.incrementCounter(CmsDbContext dbc,
java.lang.String name)
Increments a counter and returns its value before incrementing.
|
int |
CmsSecurityManager.incrementCounter(CmsRequestContext context,
java.lang.String name)
Increments a counter and returns its old value.
|
void |
CmsDriverManager.init(CmsConfigurationManager configurationManager,
I_CmsDbContextFactory dbContextFactory)
Initializes the driver and sets up all required modules and connections.
|
void |
I_CmsDriver.init(CmsDbContext dbc,
CmsConfigurationManager configurationManager,
java.util.List<java.lang.String> successiveDrivers,
CmsDriverManager driverManager)
Initializes the driver.
|
CmsUser |
CmsDriverManager.lockedBy(CmsDbContext dbc,
CmsResource resource)
Returns the user, who had locked the resource.
|
void |
CmsDriverManager.lockResource(CmsDbContext dbc,
CmsResource resource,
CmsLockType type)
Locks a resource.
|
void |
CmsSecurityManager.lockResource(CmsRequestContext context,
CmsResource resource,
CmsLockType type)
Locks a resource.
|
CmsUser |
CmsSecurityManager.loginUser(CmsRequestContext context,
java.lang.String username,
java.lang.String password,
java.lang.String remoteAddress)
Attempts to authenticate a user into OpenCms with the given password.
|
void |
CmsDriverManager.markResourceAsVisitedBy(CmsDbContext dbc,
java.lang.String poolName,
CmsResource resource,
CmsUser user)
Mark the given resource as visited by the user.
|
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.
|
void |
CmsSecurityManager.markResourceAsVisitedBy(CmsRequestContext context,
java.lang.String poolName,
CmsResource resource,
CmsUser user)
Mark the given resource as visited by the user.
|
CmsPublishList |
CmsSecurityManager.mergePublishLists(CmsRequestContext context,
CmsPublishList pubList1,
CmsPublishList pubList2)
Returns a new publish list that contains all resources of both given publish lists.
|
protected void |
CmsSecurityManager.moveResource(CmsDbContext dbc,
CmsResource source,
java.lang.String destination)
Internal recursive method to move a resource.
|
void |
CmsDriverManager.moveResource(CmsDbContext dbc,
CmsResource source,
java.lang.String destination,
boolean internal)
Moves a resource.
|
void |
CmsSecurityManager.moveResource(CmsRequestContext context,
CmsResource source,
java.lang.String destination)
Moves a resource.
|
java.lang.String |
CmsDriverManager.moveToLostAndFound(CmsDbContext dbc,
CmsResource resource,
boolean returnNameOnly)
Moves a resource to the "lost and found" folder.
|
java.lang.String |
CmsSecurityManager.moveToLostAndFound(CmsRequestContext context,
CmsResource resource,
boolean returnNameOnly)
Moves a resource to the "lost and found" folder.
|
java.lang.Object |
CmsDriverManager.newDriverInstance(CmsParameterConfiguration configuration,
java.lang.String driverName,
java.lang.String driverPoolUrl)
Method to create a new instance of a driver.
|
void |
CmsDbContext.pop()
Processes the current database context.
|
void |
CmsDriverManager.publishJob(CmsObject cms,
CmsDbContext dbc,
CmsPublishList publishList,
I_CmsReport report)
Publishes the given publish job.
|
void |
I_CmsProjectDriver.publishProject(CmsDbContext dbc,
I_CmsReport report,
CmsProject onlineProject,
CmsPublishList publishList,
int publishTag)
Publishes a specified project to the online project.
|
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.
|
CmsAccessControlEntry |
CmsDriverManager.readAccessControlEntry(CmsDbContext dbc,
CmsResource resource,
CmsUUID principal)
Reads an access control entry from the cms.
|
CmsAlias |
CmsDriverManager.readAliasByPath(CmsDbContext dbc,
CmsProject project,
java.lang.String siteRoot,
java.lang.String path)
Finds the alias with a given path.
|
CmsAlias |
CmsSecurityManager.readAliasByPath(CmsRequestContext context,
java.lang.String siteRoot,
java.lang.String path)
Reads the alias with a given path in a given site.
|
java.util.List<CmsAlias> |
CmsSecurityManager.readAliasesById(CmsRequestContext context,
CmsUUID structureId)
Reads the aliases for a resource with a given structure id.
|
java.util.List<CmsAlias> |
CmsDriverManager.readAliasesBySite(CmsDbContext dbc,
CmsProject currentProject,
java.lang.String siteRoot)
Reads the aliases for a given site root.
|
java.util.List<CmsAlias> |
CmsDriverManager.readAliasesByStructureId(CmsDbContext dbc,
CmsProject project,
CmsUUID structureId)
Reads the aliases which point to a given structure id.
|
java.util.List<I_CmsHistoryResource> |
CmsDriverManager.readAllAvailableVersions(CmsDbContext dbc,
CmsResource resource)
Reads all versions of the given resource.
|
java.util.List<I_CmsHistoryResource> |
CmsSecurityManager.readAllAvailableVersions(CmsRequestContext context,
CmsResource resource)
Reads all historical versions of a resource.
|
java.util.List<CmsPropertyDefinition> |
CmsDriverManager.readAllPropertyDefinitions(CmsDbContext dbc)
Reads all property definitions for the given mapping type.
|
java.util.List<CmsPropertyDefinition> |
CmsSecurityManager.readAllPropertyDefinitions(CmsRequestContext context)
Reads all property definitions for the given mapping type.
|
java.util.List<CmsResource> |
CmsDriverManager.readAllSubscribedResources(CmsDbContext dbc,
java.lang.String poolName,
CmsPrincipal principal)
Returns all resources subscribed by the given user or group.
|
java.util.List<CmsResource> |
CmsSubscriptionManager.readAllSubscribedResources(CmsObject cms,
CmsPrincipal principal)
Returns all resources subscribed by the given user or group.
|
java.util.List<CmsResource> |
CmsSecurityManager.readAllSubscribedResources(CmsRequestContext context,
java.lang.String poolName,
CmsPrincipal principal)
Returns all resources subscribed by the given user or group.
|
java.util.List<java.lang.String> |
CmsSecurityManager.readAllUrlNameMappingEntries(CmsRequestContext context,
CmsUUID id)
Reads all URL name mapping entries for a given structure id.
|
CmsFolder |
CmsSecurityManager.readAncestor(CmsRequestContext context,
CmsResource resource,
CmsResourceFilter filter)
Returns the first ancestor folder matching the filter criteria.
|
java.lang.String |
CmsSecurityManager.readBestUrlName(CmsRequestContext context,
CmsUUID id,
java.util.Locale locale,
java.util.List<java.util.Locale> defaultLocales)
Reads the newest URL name which is mapped to the given structure id.
|
java.util.List<CmsResource> |
CmsDriverManager.readChildResources(CmsDbContext dbc,
CmsResource resource,
CmsResourceFilter filter,
boolean getFolders,
boolean getFiles,
boolean checkPermissions)
Returns the child resources of a resource, that is the resources
contained in a folder.
|
java.util.List<CmsResource> |
CmsSecurityManager.readChildResources(CmsRequestContext context,
CmsResource resource,
CmsResourceFilter filter,
boolean getFolders,
boolean getFiles)
Returns the child resources of a resource, that is the resources
contained in a folder.
|
java.util.List<I_CmsHistoryResource> |
CmsDriverManager.readDeletedResources(CmsDbContext dbc,
CmsResource resource,
boolean readTree,
boolean isVfsManager)
Reads all deleted (historical) resources below the given path,
including the full tree below the path, if required.
|
java.util.List<I_CmsHistoryResource> |
CmsSecurityManager.readDeletedResources(CmsRequestContext context,
CmsResource resource,
boolean readTree)
Reads all deleted (historical) resources below the given path,
including the full tree below the path, if required.
|
CmsFile |
CmsDriverManager.readFile(CmsDbContext dbc,
CmsResource resource)
Reads a file resource (including it's binary content) from the VFS,
using the specified resource filter.
|
CmsFile |
CmsSecurityManager.readFile(CmsRequestContext context,
CmsResource resource)
Reads a file resource (including it's binary content) from the VFS.
|
protected CmsFolder |
CmsSecurityManager.readFolder(CmsDbContext dbc,
java.lang.String resourcename,
CmsResourceFilter filter)
Reads a folder from the VFS, using the specified resource filter.
|
CmsFolder |
CmsSecurityManager.readFolder(CmsRequestContext context,
java.lang.String resourcename,
CmsResourceFilter filter)
Reads a folder resource from the VFS,
using the specified resource filter.
|
CmsGroup |
CmsDriverManager.readGroup(CmsDbContext dbc,
CmsUUID groupId)
Reads a group based on its id.
|
CmsGroup |
CmsSecurityManager.readGroup(CmsRequestContext context,
CmsUUID groupId)
Reads a group based on its id.
|
CmsGroup |
CmsSecurityManager.readGroup(CmsRequestContext context,
java.lang.String groupname)
Reads a group based on its name.
|
CmsHistoryPrincipal |
CmsDriverManager.readHistoricalPrincipal(CmsDbContext dbc,
CmsUUID principalId)
Reads a principal (an user or group) from the historical archive based on its ID.
|
CmsHistoryPrincipal |
CmsSecurityManager.readHistoricalPrincipal(CmsRequestContext context,
CmsUUID principalId)
Reads a principal (an user or group) from the historical archive based on its ID.
|
CmsHistoryProject |
CmsDriverManager.readHistoryProject(CmsDbContext dbc,
CmsUUID projectId)
Returns the latest historical project entry with the given id.
|
CmsHistoryProject |
CmsDriverManager.readHistoryProject(CmsDbContext dbc,
int publishTag)
Returns a historical project entry.
|
CmsHistoryProject |
CmsSecurityManager.readHistoryProject(CmsRequestContext context,
CmsUUID projectId)
Returns the latest historical project entry with the given id.
|
CmsHistoryProject |
CmsSecurityManager.readHistoryProject(CmsRequestContext context,
int publishTag)
Returns a historical project entry.
|
java.util.List<CmsProperty> |
CmsDriverManager.readHistoryPropertyObjects(CmsDbContext dbc,
I_CmsHistoryResource historyResource)
Reads the list of all
objects that belongs to the given historical resource. |
java.util.List<CmsProperty> |
CmsSecurityManager.readHistoryPropertyObjects(CmsRequestContext context,
I_CmsHistoryResource resource)
Reads the list of all
objects that belong to the given historical resource. |
CmsUUID |
CmsSecurityManager.readIdForUrlName(CmsRequestContext context,
java.lang.String name)
Reads the structure id which is mapped to the given URL name, or null if the name is not
mapped to any structure IDs.
|
void |
CmsSecurityManager.readLocks()
Reads the locks that were saved to the database in the previous run of OpenCms.
|
void |
CmsDriverManager.readLocks(CmsDbContext dbc)
Reads the locks that were saved to the database in the previous run of OpenCms.
|
CmsOrganizationalUnit |
CmsDriverManager.readOrganizationalUnit(CmsDbContext dbc,
java.lang.String ouFqn)
Reads an organizational Unit based on its fully qualified name.
|
CmsOrganizationalUnit |
CmsSecurityManager.readOrganizationalUnit(CmsRequestContext context,
java.lang.String ouFqn)
Reads an organizational Unit based on its fully qualified name.
|
CmsUser |
CmsDriverManager.readOwner(CmsDbContext dbc,
CmsProject project)
Reads the owner of a project.
|
CmsUser |
CmsSecurityManager.readOwner(CmsRequestContext context,
CmsProject project)
Reads the owner of a project from the OpenCms.
|
CmsResource |
CmsSecurityManager.readParentFolder(CmsRequestContext context,
CmsUUID structureId)
Returns the parent folder to the given structure id.
|
java.util.List<CmsResource> |
CmsDriverManager.readPath(CmsDbContext dbc,
java.lang.String path,
CmsResourceFilter filter)
Builds a list of resources for a given path.
|
java.util.List<CmsResource> |
CmsSecurityManager.readPath(CmsRequestContext context,
java.lang.String path,
CmsResourceFilter filter)
Builds a list of resources for a given path.
|
CmsProject |
CmsDriverManager.readProject(CmsDbContext dbc,
java.lang.String name)
Reads a project.
|
CmsProject |
CmsSecurityManager.readProject(CmsUUID id)
Reads a project given the projects id.
|
CmsProject |
CmsSecurityManager.readProject(java.lang.String name)
Reads a project.
|
java.util.List<java.lang.String> |
CmsDriverManager.readProjectResources(CmsDbContext dbc,
CmsProject project)
Returns the list of all resource names that define the "view" of the given project.
|
java.util.List<java.lang.String> |
CmsSecurityManager.readProjectResources(CmsRequestContext context,
CmsProject project)
Returns the list of all resource names that define the "view" of the given project.
|
java.util.List<CmsResource> |
CmsDriverManager.readProjectView(CmsDbContext dbc,
CmsUUID projectId,
CmsResourceState state)
Reads all resources of a project that match a given state from the VFS.
|
java.util.List<CmsResource> |
CmsSecurityManager.readProjectView(CmsRequestContext context,
CmsUUID projectId,
CmsResourceState state)
Reads all resources of a project that match a given state from the VFS.
|
CmsPropertyDefinition |
CmsDriverManager.readPropertyDefinition(CmsDbContext dbc,
java.lang.String name)
Reads a property definition.
|
CmsPropertyDefinition |
CmsSecurityManager.readPropertyDefinition(CmsRequestContext context,
java.lang.String name)
Reads a property definition.
|
CmsProperty |
CmsDriverManager.readPropertyObject(CmsDbContext dbc,
CmsResource resource,
java.lang.String key,
boolean search)
Reads a property object from a resource specified by a property name.
|
CmsProperty |
CmsDriverManager.readPropertyObject(CmsDbContext dbc,
CmsResource resource,
java.lang.String key,
boolean search,
java.util.Locale locale)
Reads a property object from a resource specified by a property name.
|
CmsProperty |
CmsSecurityManager.readPropertyObject(CmsRequestContext context,
CmsResource resource,
java.lang.String key,
boolean search)
Reads a property object from a resource specified by a property name.
|
CmsProperty |
CmsSecurityManager.readPropertyObject(CmsRequestContext context,
CmsResource resource,
java.lang.String key,
boolean search,
java.util.Locale locale)
Reads a property object from a resource specified by a property name.
|
java.util.List<CmsProperty> |
CmsDriverManager.readPropertyObjects(CmsDbContext dbc,
CmsResource resource,
boolean search)
Reads all property objects mapped to a specified resource from the database.
|
java.util.List<CmsProperty> |
CmsSecurityManager.readPropertyObjects(CmsRequestContext context,
CmsResource resource,
boolean search)
Reads all property objects from a resource.
|
java.util.List<CmsPublishedResource> |
CmsDriverManager.readPublishedResources(CmsDbContext dbc,
CmsUUID publishHistoryId)
Reads the resources that were published in a publish task for a given publish history ID.
|
java.util.List<CmsPublishedResource> |
CmsSecurityManager.readPublishedResources(CmsRequestContext context,
CmsUUID publishHistoryId)
Reads the resources that were published in a publish task for a given publish history ID.
|
CmsPublishJobInfoBean |
CmsDriverManager.readPublishJob(CmsDbContext dbc,
CmsUUID publishHistoryId)
Reads a single publish job identified by its publish history id.
|
java.util.List<CmsPublishJobInfoBean> |
CmsDriverManager.readPublishJobs(CmsDbContext dbc,
long startTime,
long endTime)
Reads all available publish jobs.
|
CmsPublishList |
CmsDriverManager.readPublishList(CmsDbContext dbc,
CmsUUID publishHistoryId)
Reads the publish list assigned to a publish job.
|
byte[] |
CmsDriverManager.readPublishReportContents(CmsDbContext dbc,
CmsUUID publishHistoryId)
Reads the publish report assigned to a publish job.
|
I_CmsHistoryResource |
CmsDriverManager.readResource(CmsDbContext dbc,
CmsResource resource,
int version)
Reads an historical resource entry for the given resource and with the given version number.
|
protected CmsResource |
CmsSecurityManager.readResource(CmsDbContext dbc,
CmsUUID structureID,
CmsResourceFilter filter)
Reads a resource from the OpenCms VFS, using the specified resource filter.
|
protected CmsResource |
CmsSecurityManager.readResource(CmsDbContext dbc,
java.lang.String resourcePath,
CmsResourceFilter filter)
Reads a resource from the OpenCms VFS, using the specified resource filter.
|
I_CmsHistoryResource |
CmsSecurityManager.readResource(CmsRequestContext context,
CmsResource resource,
int version)
Reads the historical resource entry for the given resource with the given version number.
|
CmsResource |
CmsSecurityManager.readResource(CmsRequestContext context,
CmsUUID structureID,
CmsResourceFilter filter)
Reads a resource from the VFS,
using the specified resource filter.
|
CmsResource |
CmsSecurityManager.readResource(CmsRequestContext context,
java.lang.String resourcePath,
CmsResourceFilter filter)
Reads a resource from the VFS,
using the specified resource filter.
|
java.util.List<CmsResource> |
CmsDriverManager.readResources(CmsDbContext dbc,
CmsResource parent,
CmsResourceFilter filter,
boolean readTree)
Reads all resources below the given path matching the filter criteria,
including the full tree below the path only in case the
readTree
parameter is true. |
java.util.List<CmsResource> |
CmsSecurityManager.readResources(CmsRequestContext context,
CmsResource parent,
CmsResourceFilter filter,
boolean readTree)
Reads all resources below the given path matching the filter criteria,
including the full tree below the path only in case the
readTree
parameter is true. |
java.util.List<CmsResource> |
CmsDriverManager.readResourcesVisitedBy(CmsDbContext dbc,
java.lang.String poolName,
CmsVisitedByFilter filter)
Returns the resources that were visited by a user set in the filter.
|
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<CmsResource> |
CmsSecurityManager.readResourcesVisitedBy(CmsRequestContext context,
java.lang.String poolName,
CmsVisitedByFilter filter)
Returns the resources that were visited by a user set in the filter.
|
java.util.List<CmsResource> |
CmsDriverManager.readResourcesWithProperty(CmsDbContext dbc,
CmsResource folder,
java.lang.String propertyDefinition,
java.lang.String value,
CmsResourceFilter filter)
Reads all resources that have a value (containing the given value string) set
for the specified property (definition) in the given path.
|
java.util.List<CmsResource> |
CmsSecurityManager.readResourcesWithProperty(CmsRequestContext context,
CmsResource folder,
java.lang.String propertyDefinition,
java.lang.String value,
CmsResourceFilter filter)
Reads all resources that have a value (containing the specified value) set
for the specified property (definition) in the given path.
|
java.util.Set<I_CmsPrincipal> |
CmsDriverManager.readResponsiblePrincipals(CmsDbContext dbc,
CmsResource resource)
Returns the set of users that are responsible for a specific resource.
|
java.util.Set<I_CmsPrincipal> |
CmsSecurityManager.readResponsiblePrincipals(CmsRequestContext context,
CmsResource resource)
Returns a set of users that are responsible for a specific resource.
|
java.util.Set<CmsUser> |
CmsDriverManager.readResponsibleUsers(CmsDbContext dbc,
CmsResource resource)
Returns the set of users that are responsible for a specific resource.
|
java.util.Set<CmsUser> |
CmsSecurityManager.readResponsibleUsers(CmsRequestContext context,
CmsResource resource)
Returns a set of users that are responsible for a specific resource.
|
java.util.List<CmsResource> |
CmsDriverManager.readSiblings(CmsDbContext dbc,
CmsResource resource,
CmsResourceFilter filter)
Returns a List of all siblings of the specified resource,
the specified resource being always part of the result set.
|
java.util.List<CmsResource> |
CmsSecurityManager.readSiblings(CmsRequestContext context,
CmsResource resource,
CmsResourceFilter filter)
Returns a List of all siblings of the specified resource,
the specified resource being always part of the result set.
|
java.lang.String |
CmsDriverManager.readStaticExportPublishedResourceParameters(CmsDbContext dbc,
java.lang.String rfsName)
Returns the parameters of a resource in the table of all published template resources.
|
java.lang.String |
CmsSecurityManager.readStaticExportPublishedResourceParameters(CmsRequestContext context,
java.lang.String rfsName)
Returns the parameters of a resource in the table of all published template resources.
|
java.util.List<java.lang.String> |
CmsDriverManager.readStaticExportResources(CmsDbContext dbc,
int parameterResources,
long timestamp)
Returns a list of all template resources which must be processed during a static export.
|
java.util.List<java.lang.String> |
CmsSecurityManager.readStaticExportResources(CmsRequestContext context,
int parameterResources,
long timestamp)
Returns a list of all template resources which must be processed during a static export.
|
java.util.List<I_CmsHistoryResource> |
CmsDriverManager.readSubscribedDeletedResources(CmsDbContext dbc,
java.lang.String poolName,
CmsUser user,
java.util.List<CmsGroup> groups,
CmsResource parent,
boolean includeSubFolders,
long deletedFrom)
Returns the subscribed history resources that were deleted.
|
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<I_CmsHistoryResource> |
CmsSecurityManager.readSubscribedDeletedResources(CmsRequestContext context,
java.lang.String poolName,
CmsUser user,
java.util.List<CmsGroup> groups,
CmsResource parent,
boolean includeSubFolders,
long deletedFrom)
Returns the subscribed history resources that were deleted.
|
java.util.List<CmsResource> |
CmsDriverManager.readSubscribedResources(CmsDbContext dbc,
java.lang.String poolName,
CmsSubscriptionFilter filter)
Returns the resources that were subscribed by a user or group set in the filter.
|
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.
|
java.util.List<CmsResource> |
CmsSecurityManager.readSubscribedResources(CmsRequestContext context,
java.lang.String poolName,
CmsSubscriptionFilter filter)
Returns the resources that were subscribed by a user or group set in the filter.
|
java.util.List<CmsUrlNameMappingEntry> |
CmsSecurityManager.readUrlNameMappings(CmsRequestContext context,
CmsUrlNameMappingFilter filter)
Reads the URL name mappings matching a given filter.
|
java.util.List<java.lang.String> |
CmsSecurityManager.readUrlNamesForAllLocales(CmsRequestContext context,
CmsUUID id)
Reads the newest URL names of a structure id for all locales.
|
CmsUser |
CmsDriverManager.readUser(CmsDbContext dbc,
CmsUUID id)
Returns a user object based on the id of a user.
|
CmsUser |
CmsDriverManager.readUser(CmsDbContext dbc,
java.lang.String username,
java.lang.String password)
Returns a user object if the password for the user is correct.
|
CmsUser |
CmsSecurityManager.readUser(CmsRequestContext context,
CmsUUID id)
Returns a user object based on the id of a user.
|
CmsUser |
CmsSecurityManager.readUser(CmsRequestContext context,
java.lang.String username)
Returns a user object.
|
CmsUser |
CmsSecurityManager.readUser(CmsRequestContext context,
java.lang.String username,
java.lang.String password)
Returns a user object if the password for the user is correct.
|
void |
CmsDriverManager.removeAccessControlEntry(CmsDbContext dbc,
CmsResource resource,
CmsUUID principal)
Removes an access control entry for a given resource and principal.
|
void |
CmsSecurityManager.removeAccessControlEntry(CmsRequestContext context,
CmsResource resource,
CmsUUID principal)
Removes an access control entry for a given resource and principal.
|
void |
CmsDriverManager.removeResourceFromOrgUnit(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
CmsResource resource)
Removes a resource from the given organizational unit.
|
void |
CmsSecurityManager.removeResourceFromOrgUnit(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
CmsResource resource)
Removes a resource from the given organizational unit.
|
void |
CmsDriverManager.removeResourceFromProject(CmsDbContext dbc,
CmsResource resource)
Removes a resource from the current project of the user.
|
void |
CmsSecurityManager.removeResourceFromProject(CmsRequestContext context,
CmsResource resource)
Removes a resource from the current project of the user.
|
void |
CmsSecurityManager.removeResourceFromUsersPubList(CmsRequestContext context,
java.util.Collection<CmsUUID> structureIds)
Removes the given resource to the given user's publish list.
|
void |
CmsDriverManager.removeUserFromGroup(CmsDbContext dbc,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Removes a user from a group.
|
void |
CmsSecurityManager.removeUserFromGroup(CmsRequestContext context,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Removes a user from a group.
|
void |
CmsDriverManager.repairCategories(CmsDbContext dbc,
CmsUUID projectId,
CmsResource resource)
Repairs broken categories.
|
void |
CmsDriverManager.replaceResource(CmsDbContext dbc,
CmsResource resource,
int type,
byte[] content,
java.util.List<CmsProperty> properties)
Replaces the content, type and properties of a resource.
|
void |
CmsSecurityManager.replaceResource(CmsRequestContext context,
CmsResource resource,
int type,
byte[] content,
java.util.List<CmsProperty> properties)
Replaces the content, type and properties of a resource.
|
void |
CmsDbContext.report(I_CmsReport report,
CmsMessageContainer message,
java.lang.Throwable throwable)
Reports an error to the given report (if available) and to the OpenCms log file.
|
void |
CmsDriverManager.resetPassword(CmsDbContext dbc,
java.lang.String username,
java.lang.String oldPassword,
java.lang.String newPassword)
Resets the password for a specified user.
|
void |
CmsSecurityManager.resetPassword(CmsRequestContext context,
java.lang.String username,
java.lang.String oldPassword,
java.lang.String newPassword)
Resets the password for a specified user.
|
protected void |
CmsDriverManager.resetResourcesInProject(CmsDbContext dbc,
CmsUUID projectId,
java.util.List<CmsResource> modifiedFiles,
java.util.List<CmsResource> modifiedFolders)
Resets the resources in a project to their online state.
|
java.lang.String |
CmsSecurityManager.resourceOriginalPath(CmsRequestContext context,
CmsResource resource)
Returns the original path of given resource, that is the online path for the resource.
|
void |
CmsDriverManager.restoreDeletedResource(CmsDbContext dbc,
CmsUUID structureId)
Restores a deleted resource identified by its structure id from the historical archive.
|
void |
CmsSecurityManager.restoreDeletedResource(CmsRequestContext context,
CmsUUID structureId)
Restores a deleted resource identified by its structure id from the historical archive.
|
void |
CmsDriverManager.restoreResource(CmsDbContext dbc,
CmsResource resource,
int version)
Restores a resource in the current project with a version from the historical archive.
|
void |
CmsSecurityManager.restoreResource(CmsRequestContext context,
CmsResource resource,
int version)
Restores a resource in the current project with the given version from the historical archive.
|
void |
CmsUserSettings.save(CmsObject cms)
Saves the changed settings of the user to the users
CmsUser.getAdditionalInfo() map. |
void |
CmsDriverManager.saveAliases(CmsDbContext dbc,
CmsProject project,
CmsUUID structureId,
java.util.List<CmsAlias> aliases)
Saves a list of aliases for the same structure id, replacing any aliases for the same structure id.
|
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 |
CmsSecurityManager.saveAliases(CmsRequestContext context,
CmsResource resource,
java.util.List<CmsAlias> aliases)
Saves the aliases for a given resource.
|
void |
CmsDriverManager.saveRewriteAliases(CmsDbContext dbc,
java.lang.String siteRoot,
java.util.List<CmsRewriteAlias> newAliases)
Replaces the complete list of rewrite aliases for a given site root.
|
void |
CmsAliasManager.saveRewriteAliases(CmsObject cms,
java.lang.String siteRoot,
java.util.List<CmsRewriteAlias> newAliases)
Saves the rewrite alias for a given site root.
|
void |
CmsSecurityManager.saveRewriteAliases(CmsRequestContext requestContext,
java.lang.String siteRoot,
java.util.List<CmsRewriteAlias> newAliases)
Replaces the rewrite aliases for a given site root.
|
java.util.List<CmsUser> |
CmsSecurityManager.searchUsers(CmsRequestContext requestContext,
CmsUserSearchParameters searchParams)
Searches users by search criteria.
|
void |
CmsSecurityManager.setDateExpired(CmsRequestContext context,
CmsResource resource,
long dateExpired)
Changes the "expire" date of a resource.
|
void |
CmsSecurityManager.setDateLastModified(CmsRequestContext context,
CmsResource resource,
long dateLastModified)
Changes the "last modified" time stamp of a resource.
|
void |
CmsSecurityManager.setDateReleased(CmsRequestContext context,
CmsResource resource,
long dateReleased)
Changes the "release" date of a resource.
|
void |
CmsDriverManager.setParentGroup(CmsDbContext dbc,
java.lang.String groupName,
java.lang.String parentGroupName)
Sets a new parent group for an already existing group.
|
void |
CmsSecurityManager.setParentGroup(CmsRequestContext context,
java.lang.String groupName,
java.lang.String parentGroupName)
Sets a new parent-group for an already existing group.
|
void |
CmsDriverManager.setPassword(CmsDbContext dbc,
java.lang.String username,
java.lang.String newPassword)
Sets the password for a user.
|
void |
CmsSecurityManager.setPassword(CmsRequestContext context,
java.lang.String username,
java.lang.String newPassword)
Sets the password for a user.
|
void |
CmsDriverManager.setSubscribedResourceAsDeleted(CmsDbContext dbc,
java.lang.String poolName,
CmsResource resource)
Marks a subscribed resource as deleted.
|
void |
CmsSubscriptionManager.setSubscribedResourceAsDeleted(CmsObject cms,
CmsResource resource)
Marks a subscribed resource as deleted.
|
void |
CmsSecurityManager.setSubscribedResourceAsDeleted(CmsRequestContext context,
java.lang.String poolName,
CmsResource resource)
Marks a subscribed resource as deleted.
|
void |
CmsDriverManager.setUsersOrganizationalUnit(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
CmsUser user)
Moves an user to the given organizational unit.
|
void |
CmsSecurityManager.setUsersOrganizationalUnit(CmsRequestContext context,
CmsOrganizationalUnit orgUnit,
CmsUser user)
Moves an user to the given organizational unit.
|
void |
CmsDriverManager.subscribeResourceFor(CmsDbContext dbc,
java.lang.String poolName,
CmsPrincipal principal,
CmsResource resource)
Subscribes the user or group to the resource.
|
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 |
CmsSecurityManager.subscribeResourceFor(CmsRequestContext context,
java.lang.String poolName,
CmsPrincipal principal,
CmsResource resource)
Subscribes the user or group to the resource.
|
void |
CmsDbContext.throwException(CmsMessageContainer message,
java.lang.Throwable throwable)
Returns an exception of the same type as
throwable, if throwable is an OpenCms Exception
with the message as a CmsMessageContainer and the throwable as a cause. |
void |
CmsDriverManager.undelete(CmsDbContext dbc,
CmsResource resource)
Undelete the resource.
|
void |
CmsSecurityManager.undelete(CmsRequestContext context,
CmsResource resource)
Undelete the resource by resetting it's state.
|
void |
CmsDriverManager.undoChanges(CmsDbContext dbc,
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 |
CmsSecurityManager.undoChanges(CmsRequestContext context,
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 |
CmsSecurityManager.unlockProject(CmsRequestContext context,
CmsUUID projectId)
Unlocks all resources in this project.
|
void |
CmsDriverManager.unlockResource(CmsDbContext dbc,
CmsResource resource,
boolean force,
boolean removeSystemLock)
Unlocks a resource.
|
void |
CmsSecurityManager.unlockResource(CmsRequestContext context,
CmsResource resource)
Unlocks a resource.
|
void |
CmsDriverManager.unsubscribeAllDeletedResources(CmsDbContext dbc,
java.lang.String poolName,
long deletedTo)
Unsubscribes all deleted resources that were deleted before the specified time stamp.
|
void |
CmsSubscriptionManager.unsubscribeAllDeletedResources(CmsObject cms,
long deletedTo)
Unsubscribes all deleted resources that were deleted before the specified time stamp.
|
void |
CmsSecurityManager.unsubscribeAllDeletedResources(CmsRequestContext context,
java.lang.String poolName,
long deletedTo)
Unsubscribes all deleted resources that were deleted before the specified time stamp.
|
void |
CmsDriverManager.unsubscribeAllResourcesFor(CmsDbContext dbc,
java.lang.String poolName,
CmsPrincipal principal)
Unsubscribes the principal from all resources.
|
void |
CmsSubscriptionManager.unsubscribeAllResourcesFor(CmsObject cms,
CmsPrincipal principal)
Unsubscribes the user or group from all resources.
|
void |
CmsSecurityManager.unsubscribeAllResourcesFor(CmsRequestContext context,
java.lang.String poolName,
CmsPrincipal principal)
Unsubscribes the user or group from all resources.
|
void |
CmsDriverManager.unsubscribeResourceFor(CmsDbContext dbc,
java.lang.String poolName,
CmsPrincipal principal,
CmsResource resource)
Unsubscribes the principal from the resource.
|
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 |
CmsSecurityManager.unsubscribeResourceFor(CmsRequestContext context,
java.lang.String poolName,
CmsPrincipal principal,
CmsResource resource)
Unsubscribes the principal from the resource.
|
void |
CmsDriverManager.unsubscribeResourceForAll(CmsDbContext dbc,
java.lang.String poolName,
CmsResource resource)
Unsubscribes all groups and users 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 |
CmsSecurityManager.unsubscribeResourceForAll(CmsRequestContext context,
java.lang.String poolName,
CmsResource resource)
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.
|
void |
CmsDriverManager.updateLastLoginDate(CmsDbContext dbc,
CmsUser user)
Updates the last login date on the given user to the current time.
|
void |
CmsSecurityManager.updateLastLoginDate(CmsRequestContext context,
CmsUser user)
Updates the last login date on the given user to the current time.
|
void |
CmsSecurityManager.updateLog()
Logs everything that has not been written to DB jet.
|
void |
CmsDriverManager.updateRelationsForResource(CmsDbContext dbc,
CmsResource resource,
java.util.List<CmsLink> links)
Updates/Creates the given relations for the given resource.
|
void |
CmsSecurityManager.updateRelationsForResource(CmsRequestContext context,
CmsResource resource,
java.util.List<CmsLink> relations)
Updates/Creates the relations for the given resource.
|
boolean |
CmsDriverManager.userInGroup(CmsDbContext dbc,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Returns
true if a user is member of the given group. |
boolean |
CmsSecurityManager.userInGroup(CmsRequestContext context,
java.lang.String username,
java.lang.String groupname)
Tests if a user is member of the given group.
|
void |
CmsDriverManager.writeAccessControlEntry(CmsDbContext dbc,
CmsResource resource,
CmsAccessControlEntry ace)
Writes an access control entries to a given resource.
|
void |
CmsSecurityManager.writeAccessControlEntry(CmsRequestContext context,
CmsResource resource,
CmsAccessControlEntry ace)
Writes an access control entries to a given resource.
|
CmsFile |
CmsDriverManager.writeFile(CmsDbContext dbc,
CmsFile resource)
Writes a resource to the OpenCms VFS, including it's content.
|
CmsFile |
CmsSecurityManager.writeFile(CmsRequestContext context,
CmsFile resource)
Writes a resource to the OpenCms VFS, including it's content.
|
void |
CmsDriverManager.writeGroup(CmsDbContext dbc,
CmsGroup group)
Writes an already existing group.
|
void |
CmsSecurityManager.writeGroup(CmsRequestContext context,
CmsGroup group)
Writes an already existing group.
|
void |
CmsSecurityManager.writeHistoryProject(CmsRequestContext context,
int publishTag,
long publishDate)
Creates a historical entry of the current project.
|
void |
CmsSecurityManager.writeLocks()
Writes the locks that are currently stored in-memory to the database to allow restoring them in
later startups.
|
void |
CmsDriverManager.writeLocks(CmsDbContext dbc)
Writes the locks that are currently stored in-memory to the database to allow restoring them
in future server startups.
|
void |
CmsDriverManager.writeOrganizationalUnit(CmsDbContext dbc,
CmsOrganizationalUnit organizationalUnit)
Writes an already existing organizational unit.
|
void |
CmsSecurityManager.writeOrganizationalUnit(CmsRequestContext context,
CmsOrganizationalUnit organizationalUnit)
Writes an already existing organizational unit.
|
void |
CmsDriverManager.writeProject(CmsDbContext dbc,
CmsProject project)
Writes an already existing project.
|
void |
CmsSecurityManager.writeProject(CmsRequestContext context,
CmsProject project)
Writes an already existing project.
|
void |
CmsDriverManager.writePropertyObject(CmsDbContext dbc,
CmsResource resource,
CmsProperty property)
Writes a property for a specified resource.
|
void |
CmsSecurityManager.writePropertyObject(CmsRequestContext context,
CmsResource resource,
CmsProperty property)
Writes a property for a specified resource.
|
void |
CmsDriverManager.writePropertyObjects(CmsDbContext dbc,
CmsResource resource,
java.util.List<CmsProperty> properties,
boolean updateState)
Writes a list of properties for a specified resource.
|
void |
CmsSecurityManager.writePropertyObjects(CmsRequestContext context,
CmsResource resource,
java.util.List<CmsProperty> properties)
Writes a list of properties for a specified resource.
|
void |
CmsDriverManager.writePublishJob(CmsDbContext dbc,
CmsPublishJobInfoBean publishJob)
Updates a publish job.
|
void |
CmsDriverManager.writePublishReport(CmsDbContext dbc,
CmsPublishJobInfoBean publishJob)
Writes the publish report for a publish job.
|
void |
CmsDriverManager.writeResource(CmsDbContext dbc,
CmsResource resource)
Writes a resource to the OpenCms VFS.
|
void |
CmsSecurityManager.writeResource(CmsRequestContext context,
CmsResource resource)
Writes a resource to the OpenCms VFS.
|
void |
CmsSecurityManager.writeResourceProjectLastModified(CmsRequestContext context,
CmsResource resource,
CmsProject project)
Writes the 'projectlastmodified' field of a resource record.
|
void |
CmsDriverManager.writeStaticExportPublishedResource(CmsDbContext dbc,
java.lang.String resourceName,
int linkType,
java.lang.String linkParameter,
long timestamp)
Inserts an entry in the published resource table.
|
void |
CmsSecurityManager.writeStaticExportPublishedResource(CmsRequestContext context,
java.lang.String resourceName,
int linkType,
java.lang.String linkParameter,
long timestamp)
Inserts an entry in the published resource table.
|
java.lang.String |
CmsSecurityManager.writeUrlNameMapping(CmsRequestContext context,
java.util.Iterator<java.lang.String> nameSeq,
CmsUUID structureId,
java.lang.String locale,
boolean replaceOnPublish)
Writes a new URL name mapping for a given resource.
|
void |
CmsDriverManager.writeUser(CmsDbContext dbc,
CmsUser user)
Updates the user information.
|
void |
CmsSecurityManager.writeUser(CmsRequestContext context,
CmsUser user)
Updates the user information.
|
| 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.
|
| Modifier and Type | Method and Description |
|---|---|
long |
CmsSubscriptionDriver.getDateLastVisitedBy(CmsDbContext dbc,
java.lang.String poolName,
CmsUser user,
CmsResource resource) |
protected void |
CmsUserDriver.internalCreateDefaultGroups(CmsDbContext dbc,
java.lang.String ouFqn,
java.lang.String ouDescription,
boolean webuser)
Creates the default groups and user for the given organizational unit.
|
protected CmsOrganizationalUnit |
CmsUserDriver.internalCreateOrgUnitFromResource(CmsDbContext dbc,
CmsResource resource)
Returns the organizational unit represented by the given resource.
|
protected CmsResource |
CmsUserDriver.internalCreateResourceForOrgUnit(CmsDbContext dbc,
java.lang.String path,
int flags)
Creates a folder with the given path an properties, offline AND online.
|
protected void |
CmsUserDriver.internalDeleteOrgUnitResource(CmsDbContext dbc,
CmsResource resource)
Deletes a resource representing a organizational unit, offline AND online.
|
protected CmsResource |
CmsUserDriver.internalOrgUnitFolder(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit)
Returns the folder for the given organizational units, or the base folder if
null. |
protected java.util.List<java.lang.String> |
CmsUserDriver.internalResourcesForOrgUnit(CmsDbContext dbc,
CmsResource ouResource)
Returns the list of root paths associated to the organizational unit represented by the given resource.
|
protected void |
CmsUserDriver.internalValidateResourceForOrgUnit(CmsDbContext dbc,
CmsOrganizationalUnit orgUnit,
java.lang.String rootPath)
Validates the given root path to be in the scope of the resources of the given organizational unit.
|
protected void |
CmsUserDriver.internalWriteOrgUnitProperty(CmsDbContext dbc,
CmsResource resource,
CmsProperty property)
Writes a property for an organizational unit resource, online AND offline.
|
void |
CmsProjectDriver.publishProject(CmsDbContext dbc,
I_CmsReport report,
CmsProject onlineProject,
CmsPublishList publishList,
int publishTag) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsDataAccessException
Signals data access related issues, i.e. database access.
|
class |
CmsDataNotImplementedException
Signals that an attempt to call a method has failed since it is not implemented.
|
class |
CmsVfsException
Used to signal VFS related issues, for example during file access.
|
class |
CmsVfsResourceAlreadyExistsException
Signals that a VFS resource unexpectedly exists.
|
class |
CmsVfsResourceNotFoundException
Signals that an attempt to read a resource in the VFS denoted by a specified
pathname has failed.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsDataAccessException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsDataNotImplementedException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsVfsException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsVfsResourceAlreadyExistsException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsVfsResourceNotFoundException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsObject.addRelationToResource(CmsResource resource,
CmsResource target,
java.lang.String type)
Adds a new relation to the given resource.
|
void |
CmsObject.addRelationToResource(java.lang.String resourceName,
java.lang.String targetPath,
java.lang.String type)
Adds a new relation to the given resource.
|
void |
CmsObject.addUserToGroup(java.lang.String username,
java.lang.String groupname)
Adds a user to a group.
|
void |
CmsObject.adjustLinks(java.util.List<java.lang.String> sourceFiles,
java.lang.String targetParentFolder)
This method works just like
CmsObject.adjustLinks(String, String), but you can specify multiple source
files, and the target folder is interpreted as the folder into which the source files have been copied. |
void |
CmsObject.adjustLinks(java.util.Map<java.lang.String,java.lang.String> sourceTargetMap,
java.lang.String targetParentFolder)
This method works just like
CmsObject.adjustLinks(String, String), but instead of specifying
a single source and target folder, you can specify multiple sources and the corresponding targets in
a map of strings. |
void |
CmsObject.adjustLinks(java.lang.String sourceFolder,
java.lang.String targetFolder)
Adjusts all links in the target folder that point to the source folder
so that they are kept "relative" in the target folder where possible.
|
void |
CmsObject.chacc(java.lang.String resourceName,
java.lang.String principalType,
java.lang.String principalName,
int allowedPermissions,
int deniedPermissions,
int flags)
Changes the access control for a given resource and a given principal(user/group).
|
void |
CmsObject.chacc(java.lang.String resourceName,
java.lang.String principalType,
java.lang.String principalName,
java.lang.String permissionString)
Changes the access control for a given resource and a given principal(user/group).
|
void |
CmsObject.changeLock(CmsResource resource)
Changes the lock of a resource to the current user,
that is "steals" the lock from another user.
|
void |
CmsObject.changeLock(java.lang.String resourcename)
Changes the lock of a resource to the current user,
that is "steals" the lock from another user.
|
java.util.List<CmsResource> |
CmsObject.changeResourcesInFolderWithProperty(java.lang.String resourcename,
java.lang.String property,
java.lang.String oldValue,
java.lang.String newValue,
boolean recursive)
Returns a list with all sub resources of a given folder that have set the given property,
matching the current property's value with the given old value and replacing it by a given new value.
|
protected static void |
CmsLinkRewriter.checkIsFolder(CmsResource resource)
Checks whether a given resource is a folder and throws an exception otherwise.
|
void |
CmsObject.chflags(java.lang.String resourcename,
int flags)
Changes the resource flags of a resource.
|
void |
CmsObject.chtype(java.lang.String resourcename,
I_CmsResourceType type)
Changes the resource type of a resource.
|
void |
CmsObject.chtype(java.lang.String resourcename,
int type)
Deprecated.
Use
CmsObject.chtype(String, 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. |
protected void |
CmsLinkRewriter.copyLocaleRelations()
Separate method for copying locale relations..
|
void |
CmsObject.copyResource(java.lang.String source,
java.lang.String destination)
Copies a resource.
|
void |
CmsObject.copyResource(java.lang.String source,
java.lang.String destination,
CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
void |
CmsObject.copyResourceToProject(CmsResource resource)
Copies a resource to the current project of the user.
|
void |
CmsObject.copyResourceToProject(java.lang.String resourcename)
Copies a resource to the current project of the user.
|
int |
CmsObject.countLockedResources(CmsUUID id)
Counts the locked resources in a project.
|
void |
CmsObject.cpacc(java.lang.String sourceName,
java.lang.String destName)
Copies access control entries of a given resource to another resource.
|
CmsGroup |
CmsObject.createGroup(java.lang.String groupFqn,
java.lang.String description,
int flags,
java.lang.String parent)
Creates a new user group.
|
CmsProject |
CmsObject.createProject(java.lang.String name,
java.lang.String description,
java.lang.String groupname,
java.lang.String managergroupname)
Creates a new project.
|
CmsProject |
CmsObject.createProject(java.lang.String name,
java.lang.String description,
java.lang.String groupname,
java.lang.String managergroupname,
CmsProject.CmsProjectType projecttype)
Creates a new project.
|
CmsPropertyDefinition |
CmsObject.createPropertyDefinition(java.lang.String name)
Creates a property definition.
|
CmsResource |
CmsObject.createResource(java.lang.String sitePath,
CmsResource resource,
byte[] content,
java.util.List<CmsProperty> properties)
Creates a resource with the given properties and content.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
I_CmsResourceType type)
Creates a new resource of the given resource type with
empty content and no properties.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties)
Creates a new resource of the given resource type
with the provided content and properties.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
int type)
Deprecated.
Use
CmsObject.createResource(String, 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. |
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
int type,
byte[] content,
java.util.List<CmsProperty> properties)
Deprecated.
Use
CmsObject.createResource(String, 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. |
CmsResource |
CmsObject.createSibling(java.lang.String source,
java.lang.String destination,
java.util.List<CmsProperty> properties)
Creates a new sibling of the source resource.
|
CmsProject |
CmsObject.createTempfileProject()
Creates the project for the temporary workplace files.
|
CmsUser |
CmsObject.createUser(java.lang.String userFqn,
java.lang.String password,
java.lang.String description,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user.
|
protected CmsPair<java.lang.String,java.lang.String> |
CmsLinkRewriter.decode(CmsFile file)
Decodes a file's contents and return the content string and the encoding to use for writing the file
back to the VFS.
|
void |
CmsObject.deleteAllStaticExportPublishedResources(int linkType)
Deletes all published resource entries.
|
void |
CmsObject.deleteGroup(CmsUUID groupId,
CmsUUID replacementId)
Deletes a group, where all permissions, users and children of the group
are transfered to a replacement group.
|
void |
CmsObject.deleteGroup(java.lang.String group)
Deletes a user group.
|
void |
CmsObject.deleteHistoricalVersions(int versionsToKeep,
int versionsDeleted,
long timeDeleted,
I_CmsReport report)
Deletes the versions from the history tables, keeping the given number of versions per resource.
|
void |
CmsObject.deleteLogEntries(CmsLogFilter filter)
Deletes the log entries matching the given filter.
|
void |
CmsObject.deleteProject(CmsUUID id)
Deletes a project.
|
void |
CmsObject.deletePropertyDefinition(java.lang.String name)
Deletes a property definition.
|
void |
CmsObject.deleteRelationsFromResource(CmsResource resource,
CmsRelationFilter filter)
Deletes the relations to a given resource.
|
void |
CmsObject.deleteRelationsFromResource(java.lang.String resourceName,
CmsRelationFilter filter)
Deletes the relations to a given resource.
|
void |
CmsObject.deleteResource(CmsResource res,
CmsResource.CmsResourceDeleteMode deletePreserveSiblings)
Deletes a resource.
|
void |
CmsObject.deleteResource(java.lang.String resourcename,
CmsResource.CmsResourceDeleteMode siblingMode)
Deletes a resource given its name.
|
void |
CmsObject.deleteStaticExportPublishedResource(java.lang.String resourceName,
int linkType,
java.lang.String linkParameter)
Deletes a published resource entry.
|
void |
CmsObject.deleteUser(CmsUUID userId)
Deletes a user.
|
void |
CmsObject.deleteUser(CmsUUID userId,
CmsUUID replacementId)
Deletes a user, where all permissions and resources attributes of the user
were transfered to a replacement user.
|
void |
CmsObject.deleteUser(java.lang.String username)
Deletes a user.
|
protected java.util.List<CmsRelation> |
CmsLinkRewriter.findRelationsFromTargetToSource()
Finds relations from the target root folder or its children to the source root folder or its children.
|
java.util.List<CmsAccessControlEntry> |
CmsObject.getAccessControlEntries(java.lang.String resourceName)
Returns the list of access control entries of a resource given its name.
|
java.util.List<CmsAccessControlEntry> |
CmsObject.getAccessControlEntries(java.lang.String resourceName,
boolean getInherited)
Returns the list of access control entries of a resource given its name.
|
CmsAccessControlList |
CmsObject.getAccessControlList(java.lang.String resourceName)
Returns the access control list (summarized access control entries) of a given resource.
|
CmsAccessControlList |
CmsObject.getAccessControlList(java.lang.String resourceName,
boolean inheritedOnly)
Returns the access control list (summarized access control entries) of a given resource.
|
java.util.List<CmsAccessControlEntry> |
CmsObject.getAllAccessControlEntries()
Gets all access control entries for the current project.
|
java.util.List<CmsHistoryProject> |
CmsObject.getAllHistoricalProjects()
Returns a list with all projects from history.
|
java.util.List<java.lang.String> |
CmsObject.getAllUrlNames(CmsUUID id)
Gets all URL names for a given structure id.
|
java.util.List<CmsResource> |
CmsObject.getBlockingLockedResources(CmsResource resource)
Returns a list of child resources to the given resource that can not be locked by the current user.
|
java.util.List<CmsResource> |
CmsObject.getBlockingLockedResources(java.lang.String resourceName)
Returns a list of child resources to the given resource that can not be locked by the current user.
|
java.util.List<CmsGroup> |
CmsObject.getChildren(java.lang.String groupname,
boolean includeSubChildren)
Returns all child groups of a group.
|
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 |
CmsObject.getDetailName(CmsResource res,
java.util.Locale locale,
java.util.List<java.util.Locale> defaultLocales)
Returns the detail name of a resource.
|
java.lang.String |
CmsUser.getDisplayName(CmsObject cms,
java.util.Locale locale) |
java.util.List<CmsResource> |
CmsObject.getFilesInFolder(java.lang.String resourcename)
Returns all file resources contained in a folder.
|
java.util.List<CmsResource> |
CmsObject.getFilesInFolder(java.lang.String resourcename,
CmsResourceFilter filter)
Returns all file resources contained in a folder.
|
java.util.List<CmsGroup> |
CmsObject.getGroupsOfUser(java.lang.String username,
boolean directGroupsOnly)
Returns all the groups the given user belongs to.
|
java.util.List<CmsGroup> |
CmsObject.getGroupsOfUser(java.lang.String username,
boolean directGroupsOnly,
boolean includeOtherOus)
Returns all the groups the given user belongs to.
|
java.util.List<CmsGroup> |
CmsObject.getGroupsOfUser(java.lang.String username,
boolean directGroupsOnly,
boolean includeOtherOus,
java.lang.String remoteAddress)
Returns the groups of a user filtered by the specified IP address.
|
CmsLock |
CmsObject.getLock(CmsResource resource)
Returns the edition lock state for a specified resource.
|
CmsLock |
CmsObject.getLock(java.lang.String resourcename)
Returns the lock state for a specified resource name.
|
java.util.List<CmsResource> |
CmsObject.getLockedResources(CmsResource resource,
CmsLockFilter filter)
Returns all locked resources within a folder or matches the lock of the given resource.
|
java.util.List<java.lang.String> |
CmsObject.getLockedResources(java.lang.String resourceName,
CmsLockFilter filter)
Returns all locked resources within a folder or matches the lock of the given resource.
|
java.util.List<CmsResource> |
CmsObject.getLockedResourcesWithCache(CmsResource resource,
CmsLockFilter filter,
java.util.Map<java.lang.String,CmsResource> cache)
Returns all locked resources within a folder or matches the lock of the given resource, but uses a cache for resource lookup.
|
java.util.List<CmsLogEntry> |
CmsObject.getLogEntries(CmsLogFilter filter)
Returns all log entries matching the given filter.
|
java.lang.String |
CmsObject.getLostAndFoundName(java.lang.String resourcename)
Returns the name a resource would have if it were moved to the
"lost and found" folder.
|
protected java.util.List<CmsPair<CmsResource,CmsResource>> |
CmsLinkRewriter.getMatchingResources(java.lang.String source,
java.lang.String target)
Gets a list of resource pairs whose paths relative to the source/target roots passed match.
|
CmsGroup |
CmsObject.getParent(java.lang.String groupname)
Returns the parent group of a group.
|
CmsPermissionSet |
CmsObject.getPermissions(java.lang.String resourceName)
Returns the set of permissions of the current user for a given resource.
|
CmsPermissionSet |
CmsObject.getPermissions(java.lang.String resourceName,
java.lang.String userName)
Returns the set of permissions of a given user for a given resource.
|
java.util.List<CmsRelation> |
CmsObject.getRelationsForResource(CmsResource resource,
CmsRelationFilter filter)
Returns all relations for the given resource matching the given filter.
|
java.util.List<CmsRelation> |
CmsObject.getRelationsForResource(java.lang.String resourceName,
CmsRelationFilter filter)
Returns all relations for the given resource matching the given filter.
|
protected CmsResource |
CmsLinkRewriter.getResource(CmsUUID structureId)
Accesses a resource by structure id.
|
java.util.Set<CmsResource> |
CmsObject.getResourcesForPrincipal(CmsUUID principalId,
CmsPermissionSet permissions,
boolean includeAttr)
Returns all resources associated to a given principal via an ACE with the given permissions.
|
java.util.List<CmsResource> |
CmsObject.getResourcesInFolder(java.lang.String resourcename,
CmsResourceFilter filter)
Returns all child resources of a resource, that is the resources
contained in a folder.
|
java.util.List<CmsResource> |
CmsObject.getSubFolders(java.lang.String resourcename)
Returns all folder resources contained in a folder.
|
java.util.List<CmsResource> |
CmsObject.getSubFolders(java.lang.String resourcename,
CmsResourceFilter filter)
Returns all folder resources contained in a folder.
|
java.util.List<java.lang.String> |
CmsObject.getUrlNamesForAllLocales(CmsUUID id)
Returns the newest URL names for the given structure id for each locale.
|
java.util.List<CmsUser> |
CmsObject.getUsersOfGroup(java.lang.String groupname)
Returns all direct users of a given group.
|
java.util.List<CmsUser> |
CmsObject.getUsersOfGroup(java.lang.String groupname,
boolean includeOtherOus)
Returns all direct users of a given group.
|
boolean |
CmsObject.hasPermissions(CmsResource resource,
CmsPermissionSet requiredPermissions)
Checks if the current user has required permissions to access a given resource.
|
boolean |
CmsObject.hasPermissions(CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Checks if the current user has required permissions to access a given resource.
|
void |
CmsObject.importAccessControlEntries(CmsResource resource,
java.util.List<CmsAccessControlEntry> acEntries)
Writes a list of access control entries as new access control entries of a given resource.
|
void |
CmsObject.importRelation(java.lang.String resourceName,
java.lang.String targetPath,
java.lang.String relationType)
Imports a new relation to the given resource.
|
CmsResource |
CmsObject.importResource(java.lang.String resourcename,
CmsResource resource,
byte[] content,
java.util.List<CmsProperty> properties)
Imports a resource to the OpenCms VFS.
|
CmsUser |
CmsObject.importUser(java.lang.String id,
java.lang.String name,
java.lang.String password,
java.lang.String firstname,
java.lang.String lastname,
java.lang.String email,
int flags,
long dateCreated,
java.util.Map<java.lang.String,java.lang.Object> additionalInfos)
Creates a new user by import.
|
int |
CmsObject.incrementCounter(java.lang.String name)
Increments a counter and returns its old value.
|
protected void |
CmsLinkRewriter.init()
Reads the data needed for rewriting the relations from the VFS.
|
void |
CmsObject.lockResource(CmsResource resource)
Locks a resource.
|
void |
CmsObject.lockResource(java.lang.String resourcename)
Locks a resource.
|
void |
CmsObject.lockResourceTemporary(CmsResource resource)
Locks a resource temporary.
|
void |
CmsObject.lockResourceTemporary(java.lang.String resourcename)
Locks a resource temporary.
|
java.lang.String |
CmsObject.loginUser(java.lang.String username,
java.lang.String password)
Logs a user into the Cms, if the password is correct.
|
java.lang.String |
CmsObject.loginUser(java.lang.String username,
java.lang.String password,
java.lang.String remoteAddress)
Logs a user with a given ip address into the Cms, if the password is correct.
|
void |
CmsObject.moveResource(java.lang.String source,
java.lang.String destination)
Moves a resource to the given destination.
|
java.lang.String |
CmsObject.moveToLostAndFound(java.lang.String resourcename)
Moves a resource to the "lost and found" folder.
|
java.util.List<I_CmsHistoryResource> |
CmsObject.readAllAvailableVersions(CmsResource resource)
Reads all available versions for a given resource.
|
java.util.List<I_CmsHistoryResource> |
CmsObject.readAllAvailableVersions(java.lang.String resourceName)
Reads all historical versions of a resource.
|
java.util.List<CmsPropertyDefinition> |
CmsObject.readAllPropertyDefinitions()
Reads all property definitions.
|
CmsFolder |
CmsObject.readAncestor(java.lang.String resourcename,
CmsResourceFilter filter)
Returns the first ancestor folder matching the filter criteria.
|
CmsFolder |
CmsObject.readAncestor(java.lang.String resourcename,
int type)
Returns the first ancestor folder matching the resource type.
|
java.lang.String |
CmsObject.readBestUrlName(CmsUUID id,
java.util.Locale locale,
java.util.List<java.util.Locale> defaultLocales)
Reads the newest URL name which is mapped to the given structure id.
|
CmsResource |
CmsObject.readDefaultFile(java.lang.String resourceNameOrID)
Returns the default resource for the given folder.
|
CmsResource |
CmsObject.readDefaultFile(java.lang.String resourceNameOrID,
CmsResourceFilter filter)
Returns the default resource for the given folder.
|
java.util.List<I_CmsHistoryResource> |
CmsObject.readDeletedResources(java.lang.String resourcename,
boolean readTree)
Reads all deleted (historical) resources below the given path,
including the full tree below the path, if required.
|
CmsFile |
CmsObject.readFile(CmsResource resource)
Reads a file resource (including it's binary content) from the VFS,
for the given resource (this may also be an historical version of the resource).
|
CmsFile |
CmsObject.readFile(java.lang.String resourcename)
Reads a file resource (including it's binary content) from the VFS,
using the
filter. |
CmsFile |
CmsObject.readFile(java.lang.String resourcename,
CmsResourceFilter filter)
Reads a file resource (including it's binary content) from the VFS,
using the specified resource filter.
|
CmsFolder |
CmsObject.readFolder(java.lang.String resourcename)
Reads a folder resource from the VFS,
using the
filter. |
CmsFolder |
CmsObject.readFolder(java.lang.String resourcename,
CmsResourceFilter filter)
Reads a folder resource from the VFS,
using the specified resource filter.
|
CmsGroup |
CmsObject.readGroup(CmsUUID groupId)
Reads a group based on its id.
|
CmsGroup |
CmsObject.readGroup(java.lang.String groupName)
Reads a group based on its name.
|
CmsHistoryPrincipal |
CmsObject.readHistoryPrincipal(CmsUUID principalId)
Reads a principal (an user or group) from the historical archive based on its ID.
|
CmsHistoryProject |
CmsObject.readHistoryProject(CmsUUID projectId)
Returns the latest historical project entry with the given id.
|
CmsHistoryProject |
CmsObject.readHistoryProject(int publishTag)
Returns a historical project entry.
|
java.util.List<CmsProperty> |
CmsObject.readHistoryPropertyObjects(I_CmsHistoryResource resource)
Reads the list of all
objects that belong to the given historical resource version. |
CmsUUID |
CmsObject.readIdForUrlName(java.lang.String name)
This method retrieves the structure id which is mapped to a given URL name.
|
CmsUser |
CmsObject.readOwner(CmsProject project)
Reads the owner of a project.
|
CmsResource |
CmsObject.readParentFolder(CmsUUID structureId)
Returns the parent folder to the given structure id.
|
java.util.List<CmsResource> |
CmsObject.readPath(CmsResource resource,
CmsResourceFilter filter)
Builds a list of resources for a given path.
|
java.util.List<CmsResource> |
CmsObject.readPath(java.lang.String path,
CmsResourceFilter filter)
Builds a list of resources for a given path.
|
CmsProject |
CmsObject.readProject(CmsUUID id)
Reads the project with the given id.
|
CmsProject |
CmsObject.readProject(java.lang.String name)
Reads the project with the given name.
|
java.util.List<java.lang.String> |
CmsObject.readProjectResources(CmsProject project)
Returns the list of all resource names that define the "view" of the given project.
|
java.util.List<CmsResource> |
CmsObject.readProjectView(CmsUUID projectId,
CmsResourceState state)
Reads all resources of a project that match a given state from the VFS.
|
CmsPropertyDefinition |
CmsObject.readPropertyDefinition(java.lang.String name)
Reads a property definition.
|
CmsProperty |
CmsObject.readPropertyObject(CmsResource resource,
java.lang.String property,
boolean search)
Reads a property object from a resource specified by a property name.
|
CmsProperty |
CmsObject.readPropertyObject(CmsResource resource,
java.lang.String property,
boolean search,
java.util.Locale locale)
Reads the locale specific version of a property object from a resource specified by a property name.
|
CmsProperty |
CmsObject.readPropertyObject(java.lang.String resourcePath,
java.lang.String property,
boolean search)
Reads a property object from a resource specified by a property name.
|
CmsProperty |
CmsObject.readPropertyObject(java.lang.String resourcePath,
java.lang.String property,
boolean search,
java.util.Locale locale)
Reads the locale specific version of a property object from a resource specified by a property name.
|
java.util.List<CmsProperty> |
CmsObject.readPropertyObjects(CmsResource resource,
boolean search)
Reads all property objects from a resource.
|
java.util.List<CmsProperty> |
CmsObject.readPropertyObjects(java.lang.String resourcePath,
boolean search)
Reads all property objects from a resource.
|
java.util.List<CmsPublishedResource> |
CmsObject.readPublishedResources(CmsUUID publishHistoryId)
Reads the resources that were published in a publish task for a given publish history ID.
|
java.util.List<CmsRelation> |
CmsObject.readRelations(CmsRelationFilter filter)
Returns all relations matching the given filter.
|
CmsResource |
CmsObject.readResource(CmsUUID structureID)
Reads a resource from the VFS,
using the
filter. |
CmsResource |
CmsObject.readResource(CmsUUID structureID,
CmsResourceFilter filter)
Reads a resource from the VFS,
using the specified resource filter.
|
I_CmsHistoryResource |
CmsObject.readResource(CmsUUID structureID,
int version)
Reads the historical resource with the given version for the resource given
the given structure id.
|
CmsResource |
CmsObject.readResource(java.lang.String resourcename)
Reads a resource from the VFS,
using the
filter. |
CmsResource |
CmsObject.readResource(java.lang.String resourcename,
CmsResourceFilter filter)
Reads a resource from the VFS,
using the specified resource filter.
|
java.util.List<CmsResource> |
CmsObject.readResources(CmsResource resource,
CmsResourceFilter filter,
boolean readTree)
Reads all resources below the given resource matching the filter criteria,
including the full tree below the path only in case the
readTree
parameter is true. |
java.util.List<CmsResource> |
CmsObject.readResources(java.lang.String resourcename,
CmsResourceFilter filter)
Reads all resources below the given path matching the filter criteria,
including the full tree below the path.
|
java.util.List<CmsResource> |
CmsObject.readResources(java.lang.String resourcename,
CmsResourceFilter filter,
boolean readTree)
Reads all resources below the given path matching the filter criteria,
including the full tree below the path only in case the
readTree
parameter is true. |
java.util.List<CmsResource> |
CmsObject.readResourcesWithProperty(java.lang.String propertyDefinition)
Reads all resources that have a value set for the specified property.
|
java.util.List<CmsResource> |
CmsObject.readResourcesWithProperty(java.lang.String path,
java.lang.String propertyDefinition)
Reads all resources that have a value set for the specified property in the given path.
|
java.util.List<CmsResource> |
CmsObject.readResourcesWithProperty(java.lang.String path,
java.lang.String propertyDefinition,
java.lang.String value)
Reads all resources that have a value (containing the specified value) set
for the specified property in the given path.
|
java.util.List<CmsResource> |
CmsObject.readResourcesWithProperty(java.lang.String path,
java.lang.String propertyDefinition,
java.lang.String value,
CmsResourceFilter filter)
Reads all resources that have a value (containing the specified value) set
for the specified property in the given path.
|
java.util.Set<I_CmsPrincipal> |
CmsObject.readResponsiblePrincipals(CmsResource resource)
Returns a set of principals that are responsible for a specific resource.
|
java.util.Set<CmsUser> |
CmsObject.readResponsibleUsers(CmsResource resource)
Returns a set of users that are responsible for a specific resource.
|
java.util.List<CmsResource> |
CmsObject.readSiblings(CmsResource resource,
CmsResourceFilter filter)
Returns a list of all siblings of the specified resource,
the specified resource being always part of the result set.
|
java.util.List<CmsResource> |
CmsObject.readSiblings(java.lang.String resourcename,
CmsResourceFilter filter)
Returns a list of all siblings of the specified resource,
the specified resource being always part of the result set.
|
java.util.List<CmsResource> |
CmsObject.readSiblingsForResourceId(CmsUUID resourceId,
CmsResourceFilter filter)
Reads all resources with the given resource id.
|
java.lang.String |
CmsObject.readStaticExportPublishedResourceParameters(java.lang.String rfsName)
Returns the parameters of a resource in the list of all published template resources.
|
java.util.List<java.lang.String> |
CmsObject.readStaticExportResources(int parameterResources,
long timestamp)
Returns a list of all template resources which must be processed during a static export.
|
protected java.util.List<CmsResource> |
CmsLinkRewriter.readTree(java.lang.String rootPath)
Reads the resources in a subtree.
|
java.util.List<CmsUrlNameMappingEntry> |
CmsObject.readUrlNameMappings(CmsUrlNameMappingFilter filter)
Reads the URL name mappings matching a given filter.
|
java.util.List<java.lang.String> |
CmsObject.readUrlNamesForAllLocales(CmsUUID structureId)
Reads the URL names for all locales.
|
CmsUser |
CmsObject.readUser(CmsUUID userId)
Reads a user based on its id.
|
CmsUser |
CmsObject.readUser(java.lang.String username)
Reads a user based on its name.
|
CmsUser |
CmsObject.readUser(java.lang.String username,
java.lang.String password)
Returns a user, if the password is correct.
|
void |
CmsObject.removeResourceFromProject(java.lang.String resourcename)
Removes a resource from the current project of the user.
|
void |
CmsObject.removeUserFromGroup(java.lang.String username,
java.lang.String groupname)
Removes a user from a group.
|
void |
CmsObject.renameResource(java.lang.String source,
java.lang.String destination)
Renames a resource to the given destination name,
this is identical to a
move operation. |
void |
CmsObject.replaceResource(java.lang.String resourcename,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties)
Replaces the content, type and properties of a resource.
|
void |
CmsObject.replaceResource(java.lang.String resourcename,
int type,
byte[] content,
java.util.List<CmsProperty> properties)
Deprecated.
Use
CmsObject.replaceResource(String, 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 |
CmsObject.restoreDeletedResource(CmsUUID structureId)
Restores a deleted resource identified by its structure id from the historical archive.
|
void |
CmsObject.restoreResourceVersion(CmsUUID structureId,
int version)
Restores a resource in the current project with a version from the historical archive.
|
protected void |
CmsLinkRewriter.rewriteContent(CmsFile file,
java.util.Collection<CmsRelation> relations)
Rewrites the links included in the content itself.
|
void |
CmsLinkRewriter.rewriteLinks()
Starts the link rewriting process.
|
protected void |
CmsLinkRewriter.rewriteLinks(CmsResource resource,
java.util.Collection<CmsRelation> relations)
Rewrites the links for a single resource.
|
protected void |
CmsLinkRewriter.rewriteOtherRelations(CmsResource res,
java.util.Collection<CmsRelation> relations)
Rewrites relations which are not derived from links in the content itself.
|
void |
CmsObject.rmacc(java.lang.String resourceName,
java.lang.String principalType,
java.lang.String principalName)
Removes an access control entry of a given principal from a given resource.
|
void |
CmsObject.setDateExpired(CmsResource resource,
long dateExpired,
boolean recursive)
Changes the "expire" date of a resource.
|
void |
CmsObject.setDateExpired(java.lang.String resourcename,
long dateExpired,
boolean recursive)
Changes the "expire" date of a resource.
|
void |
CmsObject.setDateLastModified(java.lang.String resourcename,
long dateLastModified,
boolean recursive)
Changes the "last modified" time stamp of a resource.
|
void |
CmsObject.setDateReleased(CmsResource resource,
long dateReleased,
boolean recursive)
Changes the "release" date of a resource.
|
void |
CmsObject.setDateReleased(java.lang.String resourcename,
long dateReleased,
boolean recursive)
Changes the "release" date of a resource.
|
void |
CmsObject.setParentGroup(java.lang.String groupName,
java.lang.String parentGroupName)
Sets a new parent-group for an already existing group.
|
void |
CmsObject.setPassword(java.lang.String username,
java.lang.String newPassword)
Sets the password for a user.
|
void |
CmsObject.setPassword(java.lang.String username,
java.lang.String oldPassword,
java.lang.String newPassword)
Sets the password for a specified user.
|
void |
CmsObject.undeleteResource(java.lang.String resourcename,
boolean recursive)
Undeletes a resource.
|
void |
CmsObject.undoChanges(java.lang.String resourcename,
CmsResource.CmsResourceUndoMode mode)
Undoes all changes to a resource by restoring the version from the
online project to the current offline project.
|
void |
CmsObject.unlockProject(CmsUUID id)
Unlocks all resources of a project.
|
void |
CmsObject.unlockResource(CmsResource resource)
Unlocks a resource.
|
void |
CmsObject.unlockResource(java.lang.String resourcename)
Unlocks a resource.
|
void |
CmsObject.updateLastLoginDate(CmsUser user)
Updates the last login date on the given user to the current time.
|
boolean |
CmsObject.userInGroup(java.lang.String username,
java.lang.String groupname)
Tests if a user is member of the given group.
|
CmsFile |
CmsObject.writeFile(CmsFile resource)
Writes a resource to the OpenCms VFS, including it's content.
|
void |
CmsObject.writeGroup(CmsGroup group)
Writes an already existing group.
|
void |
CmsObject.writeHistoryProject(int publishTag,
long publishDate)
Creates a historical entry of the current project.
|
void |
CmsObject.writeProject(CmsProject project)
Writes an already existing project.
|
void |
CmsObject.writeProjectLastModified(CmsResource resource,
CmsProject project)
Writes the 'projectlastmodified' field of a resource record.
|
void |
CmsObject.writePropertyObject(java.lang.String resourcename,
CmsProperty property)
Writes a property for a specified resource.
|
void |
CmsObject.writePropertyObjects(CmsResource res,
java.util.List<CmsProperty> properties)
Writes a list of properties for a specified resource.
|
void |
CmsObject.writePropertyObjects(java.lang.String resourcename,
java.util.List<CmsProperty> properties)
Writes a list of properties for a specified resource.
|
void |
CmsObject.writeResource(CmsResource resource)
Writes a resource.
|
void |
CmsObject.writeStaticExportPublishedResource(java.lang.String resourceName,
int linkType,
java.lang.String linkParameter,
long timestamp)
Writes a published resource entry.
|
java.lang.String |
CmsObject.writeUrlNameMapping(java.util.Iterator<java.lang.String> nameSeq,
CmsUUID structureId,
java.lang.String locale,
boolean replaceOnPublish)
Writes a new URL name mapping for a given resource.
|
java.lang.String |
CmsObject.writeUrlNameMapping(java.lang.String name,
CmsUUID structureId,
java.lang.String locale,
boolean replaceOnPublish)
Writes a new URL name mapping for a given resource.
|
void |
CmsObject.writeUser(CmsUser user)
Updates the user information.
|
| 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 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 |
CmsDateResourceCollector.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.
|
int |
CmsSolrCollector.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 |
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.
|
| Modifier and Type | Method and Description |
|---|---|
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. |
| 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) |
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.
|
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 |
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) |
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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
void |
CmsObjectWrapper.copyResource(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 |
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.
|
CmsResource |
CmsObjectWrapper.createResource(java.lang.String resourcename,
int type)
Creates a new resource of the given resource type with empty content and no properties.
|
CmsResource |
CmsObjectWrapper.createResource(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.
|
void |
CmsObjectWrapper.deleteResource(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.
|
CmsLock |
CmsObjectWrapper.getLock(CmsResource resource)
Returns the lock state for a specified resource.
|
java.util.List<CmsResource> |
CmsObjectWrapper.getResourcesInFolder(java.lang.String resourcename,
CmsResourceFilter filter)
Returns all child resources of a resource, that is the resources
contained in a folder.
|
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 |
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.
|
void |
CmsObjectWrapper.lockResource(java.lang.String resourcename)
Locks a resource.
|
void |
CmsObjectWrapper.lockResourceTemporary(java.lang.String resourceName)
Locks a resource temporarily.
|
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.
|
void |
CmsObjectWrapper.moveResource(java.lang.String source,
java.lang.String destination)
Moves a resource to the given destination.
|
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.
|
CmsFile |
CmsObjectWrapper.readFile(java.lang.String resourcename,
CmsResourceFilter filter)
Reads a file resource (including it's binary content) from the VFS,
using the specified resource filter.
|
CmsProperty |
CmsObjectWrapper.readPropertyObject(CmsResource resource,
java.lang.String property,
boolean search)
Delegate method for
CmsObject.readPropertyObject(CmsResource, String, boolean). |
CmsResource |
CmsResourceWrapperXmlPage.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.
|
CmsResource |
CmsObjectWrapper.readResource(CmsUUID structureID,
CmsResourceFilter filter)
Delegate method for
CmsObject.readResource(CmsUUID, CmsResourceFilter). |
CmsResource |
CmsObjectWrapper.readResource(java.lang.String resourcename,
CmsResourceFilter filter)
Reads a resource from the VFS,
using the
filter. |
CmsUser |
CmsObjectWrapper.readUser(CmsUUID userId)
Delegate method for
CmsObject.readUser(CmsUUID). |
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 |
A_CmsResourceWrapper.unlockResource(CmsObject cms,
java.lang.String resourcename) |
boolean |
I_CmsResourceWrapper.unlockResource(CmsObject cms,
java.lang.String resourcename)
Unlocks a resource.
|
void |
CmsObjectWrapper.unlockResource(java.lang.String resourcename)
Unlocks a resource.
|
CmsFile |
CmsObjectWrapper.writeFile(CmsFile resource)
Writes a resource to the OpenCms VFS, including it's content.
|
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.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsFlexCacheException
Signals an error of the Flex cache.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsFlexCacheException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
static CmsFlexBucketConfiguration |
CmsFlexBucketConfiguration.loadFromVfsFile(CmsObject cms,
java.lang.String path)
Loads a flex bucket configuration from the OpenCms VFS.
|
| 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.
|
protected CmsBrokenLinkBean |
CmsBrokenLinkRenderer.createSitemapBrokenLinkBean(CmsResource resource)
Creates a "broken link" bean based on a resource.
|
protected CmsBrokenLinkBean |
CmsVfsService.createSitemapBrokenLinkBean(CmsResource resource)
Creates a "broken link" bean based on a resource.
|
protected CmsLockActionRecord |
CmsGwtService.ensureLock(CmsResource resource)
Locks the given resource with a temporary, if not already locked by the current user.
|
protected CmsLockActionRecord |
CmsGwtService.ensureLock(CmsUUID structureId)
Locks the given resource with a temporary, if not already locked by the current user.
|
protected CmsLockActionRecord |
CmsGwtService.ensureLock(java.lang.String sitepath)
Locks the given resource with a temporary, if not already locked by the current user.
|
protected void |
CmsGwtService.ensureSession()
Ensures that the user session is still valid.
|
java.lang.String |
CmsAliasHelper.exportAliasesAsCsv(CmsObject cms)
Returns the comma separated alias data.
|
protected java.util.List<CmsAliasBean> |
CmsAliasHelper.getAliasesForPage(CmsUUID uuid)
Implementation of the getAliasesForPage method.
|
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.
|
java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>> |
CmsPropertyEditorHelper.getDefaultProperties(java.util.List<CmsUUID> structureIds)
Internal method for computing the default property configurations for a list of structure ids.
|
protected CmsLockInfo |
CmsCoreService.getLock(CmsUUID structureId)
Helper method for locking a resource which returns some information on whether the locking
failed, and why.
|
protected CmsLockInfo |
CmsCoreService.getLock(java.lang.String sitepath)
Helper method for locking a resource which returns some information on whether the locking
failed, and why.
|
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. |
CmsHistoryResourceCollection |
CmsVfsService.getResourceHistoryInternal(CmsUUID structureId)
Internal version of getResourceHistory.
|
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 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.
|
java.util.Map<java.lang.String,CmsClientTemplateBean> |
CmsTemplateFinder.getTemplates()
Returns the available templates.
|
static I_CmsValidationService |
CmsCoreService.getValidationService(java.lang.String name)
Internal helper method for getting a validation service.
|
static <T> T |
CmsCoreService.instantiate(java.lang.Class<T> anInterface,
java.lang.String className)
Instantiates a class given its name using its default constructor.
|
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.
|
CmsPropertiesBean |
CmsPropertyEditorHelper.loadPropertyData(CmsUUID id)
Loads the data needed for editing the properties of a resource.
|
protected CmsVfsEntryBean |
CmsVfsService.makeEntryBean(CmsResource resource,
boolean root)
Helper method for creating a VFS entry bean from a resource.
|
protected java.util.List<CmsVfsEntryBean> |
CmsVfsService.makeEntryBeans(java.util.List<CmsResource> resources,
boolean root)
Helper method for creating a list of VFS entry beans from a list of the corresponding resources.
|
java.lang.String |
CmsVfsService.renameResourceInternal(CmsUUID structureId,
java.lang.String newName)
Internal implementation for renaming a resource.
|
java.util.List<CmsBrokenLinkBean> |
CmsBrokenLinkRenderer.renderBrokenLink(CmsResource target,
CmsResource source)
Renders the source of a broken link as a list of CmsBrokenLinkBean instances.
|
java.util.List<CmsBrokenLinkBean> |
CmsBrokenLinkRenderer.renderBrokenLinkDefault(CmsResource target,
CmsResource source)
The default method for rendering broken link sources.
|
java.util.List<CmsBrokenLinkBean> |
CmsBrokenLinkRenderer.renderBrokenLinkGroupContainer(CmsResource target,
CmsResource source)
Renders the broken links for a group container.
|
java.util.List<CmsBrokenLinkBean> |
CmsBrokenLinkRenderer.renderBrokenLinkInheritanceGroup(CmsResource target,
CmsResource source)
Renders broken links from an inheritance group.
|
void |
CmsAliasHelper.saveAliases(CmsUUID structureId,
java.util.List<CmsAliasBean> aliasBeans)
Saves aliases.
|
void |
CmsPropertyEditorHelper.saveProperties(CmsPropertyChangeSet changes)
Saves a set of property changes.
|
protected java.util.Map<java.lang.String,java.lang.String> |
CmsAliasHelper.validateAliases(CmsUUID uuid,
java.util.Map<java.lang.String,java.lang.String> aliasPaths)
The internal method used for validating aliases.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsMessageException
Used to signal issues with the localization support, for example during localized messages access.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsMessageException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsLocaleGroupService.attachLocaleGroup(CmsResource secondaryPage,
CmsResource primaryPage)
Adds a resource to a locale group.
|
void |
CmsLocaleGroupService.attachLocaleGroupIndirect(CmsResource first,
CmsResource second)
Smarter method to connect a resource to a locale group.
|
void |
CmsLocaleGroupService.detachLocaleGroup(CmsResource firstPage,
CmsResource secondPage)
Removes a locale group relation between two resources.
|
CmsResource |
CmsLocaleGroupService.findLocalizationRoot(CmsResource resource)
Tries to find the 'best' localized subsitemap parent folder for a resource.
|
CmsLocaleGroup |
CmsLocaleGroupService.readDefaultFileLocaleGroup(CmsResource resource)
Reads the locale group of a default file.
|
CmsLocaleGroup |
CmsLocaleGroupService.readLocaleGroup(CmsResource resource)
Reads a locale group from the VFS.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsContainerPageCopier.adjustLocalesForElement(CmsResource elementResource)
Converts locales for the copied container element.
|
void |
CmsContainerPageCopier.copyPageOnly(CmsResource originalPage,
java.lang.String targetPageRootPath)
Copies the given container page to the provided root path.
|
CmsContainerElementBean |
CmsContainerPageCopier.replaceContainerElement(CmsResource targetPage,
CmsContainerElementBean originalElement)
Produces the replacement for a container page element to use in a copy of an existing container page.
|
void |
CmsContainerPageCopier.replaceElements(CmsResource containerPage)
Replaces the elements in the copied container page with copies, if appropriate based on the current copy mode.
|
void |
CmsContainerPageCopier.run(CmsResource source,
CmsResource target)
Starts the page copying process.
|
void |
CmsContainerPageCopier.run(CmsResource source,
CmsResource target,
java.lang.String targetName)
Starts the page copying process.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsImportExportException
Signals an error during import or export of OpenCms data.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsImportExportException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsExport.exportOrgUnit(org.dom4j.Element parent,
CmsOrganizationalUnit orgunit)
Exports one single organizational unit with all it's data.
|
void |
I_CmsImportExportHandler.importData(CmsObject cms,
I_CmsReport report)
Imports the data into the Cms.
|
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 |
CmsImportExportManager.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
I_CmsImportExportHandler.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
void |
CmsVfsImportExportHandler.importData(CmsObject cms,
java.lang.String importFile,
java.lang.String importPath,
I_CmsReport report)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static java.io.IOException |
CmsJlanDiskInterface.convertCmsException(CmsException e)
Tries to convert a CmsException to the matching exception type from JLAN.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsJlanNetworkFile.ensureLock()
Make sure that this resource is locked.
|
CmsObjectWrapper |
CmsJlanRepository.getCms(org.alfresco.jlan.server.SrvSession session,
org.alfresco.jlan.server.filesys.TreeConnection connection)
Creates a CmsObjectWrapper for the current session.
|
protected CmsObjectWrapper |
CmsJlanDiskInterface.getCms(org.alfresco.jlan.server.SrvSession session,
org.alfresco.jlan.server.filesys.TreeConnection connection)
Creates a CmsObjectWrapper for the current session.
|
protected CmsJlanNetworkFile |
CmsJlanDiskInterface.getFileForPath(CmsObjectWrapper cms,
org.alfresco.jlan.server.SrvSession session,
org.alfresco.jlan.server.filesys.TreeConnection connection,
java.lang.String path)
Helper method to get a network file object given a path.
|
protected CmsJlanNetworkFile |
CmsJlanDiskInterface.getFileForPath(org.alfresco.jlan.server.SrvSession session,
org.alfresco.jlan.server.filesys.TreeConnection connection,
java.lang.String path)
Helper method to get a network file object given a path.
|
void |
CmsJlanRepository.initializeCms(CmsObject cms) |
protected void |
CmsJlanNetworkFile.load(boolean needContent)
Loads the file data from the VFS.
|
void |
CmsJlanNetworkFile.moveTo(java.lang.String cmsNewPath)
Moves this file to a different path.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsJspLoginBean.getLoginException()
Returns the exception that was thrown after login,
or null if no Exception was thrown (i.e. login was successful
or not attempted).
|
| Modifier and Type | Method and Description |
|---|---|
static void |
CmsJspLoginBean.logLoginException(CmsRequestContext requestContext,
java.lang.String userName,
CmsException currentLoginException)
Logs any login exception.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsJspTagContentLoad.doLoadNextFile()
Load the next file name from the initialized list of file names.
|
static java.util.List<CmsContainerElementBean> |
CmsJspTagContainer.getGroupContainerElements(CmsObject cms,
CmsContainerElementBean element,
javax.servlet.ServletRequest req,
java.lang.String containerType)
Returns the element group elements.
|
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) |
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.
|
static java.lang.String |
CmsJspTagImage.imageTagAction(java.lang.String src,
CmsImageScaler scaler,
java.util.Map<java.lang.String,java.lang.String> attributes,
boolean partialTag,
boolean noDim,
javax.servlet.ServletRequest req)
Internal action method to create the tag content.
|
static java.lang.String |
CmsJspTagImage.imageTagAction(java.lang.String src,
CmsImageScaler scaler,
java.util.Map<java.lang.String,java.lang.String> attributes,
boolean partialTag,
javax.servlet.ServletRequest req)
Internal action method to create the tag content.
|
static void |
CmsJspTagEditable.insertEditEmpty(javax.servlet.jsp.PageContext context,
I_CmsXmlContentContainer container,
CmsDirectEditMode mode,
java.lang.String id)
Inserts direct edit for empty collector lists.
|
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.
|
static java.lang.String |
CmsJspTagPdfThumbnail.pdfTagAction(javax.servlet.ServletRequest request,
java.lang.String file,
int width,
int height,
java.lang.String format)
The implementation of the tag.
|
static java.lang.String |
CmsJspTagPdf.pdfTagAction(javax.servlet.ServletRequest request,
java.lang.String format,
java.lang.String content,
java.lang.String localeStr,
java.util.SortedMap<java.lang.String,java.lang.String> params,
java.lang.String paramEncoding)
The implementation of the tag.
|
static java.util.Map<java.lang.String,java.lang.String> |
CmsJspTagProperty.propertiesTagAction(java.lang.String action,
javax.servlet.ServletRequest req)
Internal action method.
|
static java.lang.String |
CmsJspTagProperty.propertyTagAction(java.lang.String property,
java.lang.String action,
java.lang.String defaultValue,
boolean escape,
javax.servlet.ServletRequest req)
Internal action method.
|
static java.lang.String |
CmsJspTagProperty.propertyTagAction(java.lang.String property,
java.lang.String action,
java.lang.String defaultValue,
boolean escape,
javax.servlet.ServletRequest req,
java.util.Locale locale)
Internal action method.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsDecoratorConfiguration.addDecorations(CmsDecorationDefintion decorationDefinition)
Adds decorations defined in a
object to the map of all decorations. |
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) |
| 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.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract I_CmsHtmlNodeVisitor |
A_CmsConfiguredHtmlParser.createVisitorInstance()
Subclasses have to create their desired instance for parsing the html here.
|
java.lang.String |
A_CmsConfiguredHtmlParser.doParse(java.lang.String html,
java.lang.String encoding,
java.util.List<java.lang.String> noAutoCloseTags)
Returns the result of subsequent parsing to the <cms:parse< tag implementation.
|
| 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.
|
CmsJspContentAttachmentsBean |
CmsJspContentAccessBean.getAttachments()
Gets an attachment bean, trying to automatically find the right locale for the current page.
|
static CmsJspContentAttachmentsBean |
CmsJspContentAttachmentsBean.getAttachmentsForCurrentPage(CmsObject cms,
CmsResource content)
Gets the attachments / detail-only contents for the current page (i.e. cms.getRequestContext().getUri()).
|
void |
CmsJspStandardContextBean.initPage()
Initializes the requested container page.
|
void |
CmsJspStandardContextBean.CmsContainerElementWrapper.initResource(CmsObject cms) |
boolean |
CmsJspStandardContextBean.CmsContainerElementWrapper.isGroupContainer(CmsObject cms) |
boolean |
CmsJspStandardContextBean.CmsContainerElementWrapper.isInheritedContainer(CmsObject cms) |
protected CmsDynamicFunctionBean |
CmsJspStandardContextBean.readDynamicFunctionBean(java.lang.String configuredName)
Reads a dynamic function bean, given its name in the module configuration.
|
java.util.List<CmsJspResourceWrapper> |
CmsJspVfsAccessBean.readFilesInFolder(java.lang.String resourcePath)
Reads the resources in the given folder.
|
java.util.List<CmsJspResourceWrapper> |
CmsJspVfsAccessBean.readFilesInFolder(java.lang.String resourcePath,
java.lang.String filterString)
Reads the resources in the given folder using the provided filter.
|
CmsJspResourceWrapper |
CmsJspVfsAccessBean.readSubsiteFor(java.lang.String path)
Reads the sub site folder resource.
|
void |
CmsMacroFormatterResolver.resolve()
Resolves the macro.
|
protected CmsResource |
A_CmsJspCustomContextBean.toResource(java.lang.Object input)
Convert the input to a CmsResource using the current context.
|
protected I_CmsXmlDocument |
A_CmsJspCustomContextBean.toXml(java.lang.Object input)
Converts the input (typically a specification of an XML file) to an XML document.
|
| Constructor and Description |
|---|
CmsJspContentAttachmentsBean(CmsObject cms,
CmsResource pageResource)
Initializes this bean with the contents of a detail-only page.
|
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.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsLoaderException
Signals exceptions occuring during the resource loading process.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsLoaderException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| 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[] |
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[] |
CmsMacroFormatterLoader.export(CmsObject cms,
CmsResource resource,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res) |
I_CmsResourceType |
CmsResourceManager.getDefaultTypeForName(java.lang.String resourcename)
Returns the default resource type for the given resource name, using the
configured resource type file extensions.
|
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.
|
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.util.Iterator<java.lang.String> |
I_CmsFileNameGenerator.getUrlNameSequence(java.lang.String baseName)
Returns a sequence of URL name candidates for the given base name as an iterator.
|
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.
|
protected CmsResource |
CmsJspLoader.readJspResource(CmsFlexController controller,
java.lang.String jspName)
Returns the jsp resource identified by the given name, using the controllers cms context.
|
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 |
CmsDumpLoader.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) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsLockException
Signals that a particular action was invoked on resource with an insufficient lock state.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsLockException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsLockManager.addResource(CmsDbContext dbc,
CmsResource resource,
CmsUser user,
CmsProject project,
CmsLockType type)
Adds a resource to the lock manager.
|
static CmsLockActionRecord |
CmsLockUtil.ensureLock(CmsObject cms,
CmsResource resource)
Static helper method to lock a resource.
|
CmsLock |
CmsLockManager.getLock(CmsDbContext dbc,
CmsResource resource)
Returns the lock state of the given resource.
|
CmsLock |
CmsLockManager.getLock(CmsDbContext dbc,
CmsResource resource,
boolean includeSiblings)
Returns the lock state of the given resource.
|
java.util.List<CmsResource> |
CmsLockManager.getLockedResources(CmsDbContext dbc,
CmsResource resource,
CmsLockFilter filter)
Returns all exclusive locked resources matching the given resource and filter.
|
java.util.List<CmsResource> |
CmsLockManager.getLockedResourcesWithCache(CmsDbContext dbc,
CmsResource resource,
CmsLockFilter filter,
java.util.Map<java.lang.String,CmsResource> cache)
Returns all exclusive locked resources matching the given resource and filter, but uses a cache for resource loookups.
|
java.util.List<CmsLock> |
CmsLockManager.getLocks(CmsDbContext dbc,
java.lang.String resourceName,
CmsLockFilter filter)
Returns all exclusive locked resources matching the given resource name and filter.
|
boolean |
CmsLockManager.hasSystemLocks(CmsDbContext dbc,
CmsResource resource)
Returns
true if the given resource contains a resource that has a system lock. |
static CmsLockUtil.LockedFile |
CmsLockUtil.LockedFile.lockResource(CmsObject cms,
CmsResource resource)
Lock and read a file.
|
void |
CmsLockManager.readLocks(CmsDbContext dbc)
Reads the latest saved locks from the database and installs them to
this lock manager.
|
void |
CmsLockManager.removeDeletedResource(CmsDbContext dbc,
java.lang.String resourceName)
Removes a resource after it has been deleted by the driver manager.
|
CmsLock |
CmsLockManager.removeResource(CmsDbContext dbc,
CmsResource resource,
boolean forceUnlock,
boolean removeSystemLock)
Removes a resource from the lock manager.
|
void |
CmsLockManager.writeLocks(CmsDbContext dbc)
Writes the locks that are currently stored in-memory to the database to allow restoring them in
later startups.
|
| Constructor and Description |
|---|
CmsVfsDataSource(CmsObject cms,
CmsResource resource)
Creates a new data source for the given VFS resource.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsMultiException
A multi exception is a container for several exception messages that may be caused by an internal operation.
|
class |
CmsResourceInitException
This exeption is thrown by a class which implements org.opencms.main.I_CmsResourceInit.
|
| Modifier and Type | Field and Description |
|---|---|
protected java.util.List<CmsException> |
CmsMultiException.m_exceptions
The list of internal exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsResourceInitException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsMultiException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsException.createException(CmsMessageContainer container,
java.lang.Throwable cause)
Creates a copied instance of this localized exception.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<CmsException> |
CmsMultiException.getExceptions()
Returns the (unmodifiable) List of exceptions that are stored in this multi exception.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsMultiException.addException(CmsException exception)
Adds an Exception to the list of Exceptions kept in this multi Exception.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsMultiException.addExceptions(java.util.List<CmsException> exceptions)
Adds all Exceptions in the given List to the list of Exceptions kept in this multi Exception.
|
protected void |
CmsMultiException.setExceptions(java.util.List<CmsException> exceptions)
Updates the internal list of stored exceptions.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsSessionManager.checkCreateSessionForUser(CmsUser user)
Checks whether a new session can be created for the user, and throws an exception if not.
|
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 void |
OpenCmsCore.initCmsContextForUI(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
CmsUIServlet servlet)
Initializes the OpenCms context for Vaadin UI servlet.
|
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 org.opencms.main.OpenCmsSolrHandler.Context |
OpenCmsSolrHandler.initializeRequest(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Initialized the search request and sets the local parameter.
|
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.
|
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 |
CmsShell.setLocale(java.util.Locale locale)
Sets the locale of the current user.
|
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.
|
| Constructor and Description |
|---|
CmsMultiException(java.util.List<CmsException> exceptions)
Creates a new multi exception for the given list of
instances. |
| 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). |
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.
|
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.
|
boolean |
CmsModuleImportExportRepository.deleteModule(java.lang.String fileName)
Deletes the module corresponding to the given virtual module file name.
|
byte[] |
CmsModuleImportExportRepository.getExportedModuleData(java.lang.String virtualModuleFileName,
CmsProject project)
Exports a module and returns the export zip file content in a byte array.
|
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.
|
void |
CmsModuleImportExportRepository.importModule(java.lang.String name,
byte[] content)
Imports module data.
|
void |
CmsModuleUpdater.importRelations(CmsObject cms)
Update relations for all imported resources.
|
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.
|
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.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
I_CmsNewsletter.addAttachment(CmsObject cms,
CmsResource resource)
Adds a OpenCms resource as an attachment to the newsletter.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.util.Collection<CmsContentNotification> |
CmsNotificationCandidates.getContentNotifications()
Returns a collection of CmsContentNotifications, one for each responsible that receives a notification.
|
java.lang.String |
CmsNotificationCandidates.notifyResponsibles()
Sends all notifications to the responsible users.
|
| Constructor and Description |
|---|
CmsNotificationCandidates(CmsObject cms)
Collects all resources that will expire in short time, or will become valid, or are not modified since a long time.
|
| 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,
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.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsPublishException
Used to signal publish issues.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsPublishException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsPublishManager.abortPublishJob(CmsObject cms,
CmsPublishJobEnqueued publishJob,
boolean removeJob)
Aborts the given publish job.
|
protected void |
CmsPublishEngine.abortPublishJob(CmsUUID userId,
CmsPublishJobEnqueued publishJob,
boolean removeJob)
Aborts the given publish job.
|
protected void |
CmsPublishHistory.add(CmsPublishJobInfoBean publishJob)
Adds the given publish job to the list.
|
protected void |
CmsPublishQueue.add(CmsPublishJobInfoBean publishJob)
Pushes a new publish job with the given information in publish queue.
|
void |
CmsPublishListVerifier.checkPublishList(CmsPublishList publishList)
Checks whether the given publish job is OK, and throws an exception otherwise.
|
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.
|
byte[] |
CmsPublishManager.getReportContents(CmsPublishJobFinished publishJob)
Returns the content of the publish report assigned to the given publish job.
|
protected byte[] |
CmsPublishEngine.getReportContents(CmsPublishJobFinished publishJob)
Returns the content of the publish report assigned to the given 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 |
CmsPublishEngine.initialize(CmsObject adminCms,
boolean publishQueuePersistance,
int publishQueueShutdowntime)
Initializes the publish engine.
|
protected void |
CmsPublishEngine.lockPublishList(CmsPublishJobInfoBean publishJob)
Sets publish locks of resources in a publish list.
|
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,
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.
|
protected void |
CmsPublishHistory.remove(CmsPublishJobInfoBean publishJob)
Removes the given job from the list.
|
protected void |
CmsPublishQueue.remove(CmsPublishJobInfoBean publishJob)
Removes the given job from the list.
|
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.
|
protected void |
CmsPublishEngine.unlockPublishList(CmsPublishJobInfoBean publishJob)
Removes all publish locks of resources in a publish list of a publish job.
|
| Constructor and Description |
|---|
CmsPublishJobInfoBean(CmsObject cms,
CmsPublishList publishList,
I_CmsReport report)
The Default constructor.
|
| 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 |
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.
|
static java.lang.String |
CmsCategory.getCategoryPath(java.lang.String rootPath,
java.lang.String baseFolder)
Returns the category path for the given root path.
|
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 |
CmsExternalLinksValidator.launch(CmsObject cms,
java.util.Map<java.lang.String,java.lang.String> parameters)
This method is called by the cron scheduler.
|
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<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.
|
| Constructor and Description |
|---|
CmsCategory(CmsUUID structureId,
java.lang.String rootPath,
java.lang.String title,
java.lang.String description,
java.lang.String baseFolder)
Default constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsRepositorySession.copy(java.lang.String src,
java.lang.String dest,
boolean overwrite) |
void |
I_CmsRepositorySession.copy(java.lang.String src,
java.lang.String dest,
boolean overwrite)
Copies the item found at the source path to the destination path.
|
void |
CmsRepositorySession.create(java.lang.String path) |
void |
I_CmsRepositorySession.create(java.lang.String path)
Creates a new item at the given path.
|
void |
CmsRepositorySession.delete(java.lang.String path) |
void |
I_CmsRepositorySession.delete(java.lang.String path)
Deletes the item at the given path.
|
I_CmsRepositoryItem |
CmsRepositorySession.getItem(java.lang.String path) |
I_CmsRepositoryItem |
I_CmsRepositorySession.getItem(java.lang.String path)
Returns the item found at the given path.
|
void |
I_CmsRepository.initializeCms(CmsObject cms)
Initializes this repository with an admin CMS object.
|
java.util.List<I_CmsRepositoryItem> |
CmsRepositorySession.list(java.lang.String path) |
java.util.List<I_CmsRepositoryItem> |
I_CmsRepositorySession.list(java.lang.String path)
Returns a list with all items found directly in the given path.
|
boolean |
CmsRepositorySession.lock(java.lang.String path,
CmsRepositoryLockInfo lock) |
boolean |
I_CmsRepositorySession.lock(java.lang.String path,
CmsRepositoryLockInfo lock)
Creates a new lock on the item at the path with the given information
in the lock info.
|
abstract I_CmsRepositorySession |
A_CmsRepository.login(java.lang.String userName,
java.lang.String password)
Login a user given the username and the password.
|
I_CmsRepositorySession |
CmsRepository.login(java.lang.String userName,
java.lang.String password) |
void |
CmsRepositorySession.move(java.lang.String src,
java.lang.String dest,
boolean overwrite) |
void |
I_CmsRepositorySession.move(java.lang.String src,
java.lang.String dest,
boolean overwrite)
Moves an item from a source path to a destination path.
|
void |
CmsRepositorySession.save(java.lang.String path,
java.io.InputStream inputStream,
boolean overwrite) |
void |
I_CmsRepositorySession.save(java.lang.String path,
java.io.InputStream inputStream,
boolean overwrite)
Saves an item at the given path.
|
| Constructor and Description |
|---|
CmsRemoteShell(java.lang.String additionalCommandsName,
int port)
Creates a new instance.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsSchedulerException
Describes errors that occur in the context of the OpenCms scheduler.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsSchedulerException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsIndexException
Signals an error during an indexing operation.
|
class |
CmsSearchException
Signals an error during a search operation.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsSearchException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsIndexException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsSearchDocument |
CmsIndexingThread.createIndexDocument(CmsObject cms,
CmsResource res,
I_CmsSearchIndex index,
int count,
I_CmsReport report)
Creates the search index document.
|
void |
CmsSearchManager.rebuildAllIndexes(I_CmsReport report)
Rebuilds (if required creates) all configured indexes.
|
void |
CmsSearchManager.rebuildIndex(java.lang.String indexName,
I_CmsReport report)
Rebuilds (if required creates) the index with the given name.
|
void |
CmsSearchManager.rebuildIndexes(java.util.List<java.lang.String> indexNames,
I_CmsReport report)
Rebuilds (if required creates) the List of indexes with the given name.
|
protected void |
CmsSearchManager.updateIndex(I_CmsSearchIndex index,
I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Updates (if required creates) the index with the given name.
|
protected void |
CmsSearchManager.updateIndexIncremental(CmsObject cms,
I_CmsSearchIndex index,
I_CmsReport report,
java.util.List<CmsPublishedResource> resourcesToIndex)
Incrementally updates the given index.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsIndexNoContentException
Signals an error during content extraction of an empty document.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsIndexNoContentException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| 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 |
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. |
java.util.List<java.lang.String> |
A_CmsVfsDocument.getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
java.util.List<java.lang.String> mimeTypes) |
java.util.List<java.lang.String> |
I_CmsDocumentFactory.getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
java.util.List<java.lang.String> mimeTypes)
Returns the list of accepted keys for the resource types that can be indexed using this document factory.
|
java.util.List<java.lang.String> |
CmsDocumentXmlContent.getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
java.util.List<java.lang.String> mimeTypes) |
protected CmsFile |
A_CmsVfsDocument.readFile(CmsObject cms,
CmsResource resource)
Upgrades the given resource to a
CmsFile with content. |
| Modifier and Type | Method and Description |
|---|---|
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.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
CmsGallerySearchResultList |
CmsGallerySearch.getResult(CmsGallerySearchParameters params)
Returns the gallery search result list.
|
static CmsGallerySearchResult |
CmsGallerySearch.searchById(CmsObject cms,
CmsUUID structureId,
java.util.Locale locale)
Searches by structure id.
|
CmsGallerySearchResult |
CmsGallerySearch.searchById(CmsUUID id,
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.
|
CmsGallerySearchResult |
CmsGallerySearch.searchByPath(java.lang.String path,
java.util.Locale locale)
Searches by structure id.
|
void |
CmsGallerySearch.setIndex(java.lang.String indexName)
Set the name of the index to search.
|
void |
CmsGallerySearch.setIndexForProject(CmsObject cms)
Sets the index name according to the current project.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
java.util.List<java.lang.String> |
CmsSolrDocumentXmlContent.getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
java.util.List<java.lang.String> mimeTypes) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsAuthentificationException
Signals that an attempt to authenticate (login) has a user has failed.
|
class |
CmsCustomLoginException
Custom login exception whose message will be displayed to the user if the login fails.
|
class |
CmsPasswordEncryptionException
Signals that an attempt to encrypt a password was not successful.
|
class |
CmsPermissionViolationException
A permission violation occurs if a user without tries to access or maipulate a VFS resource
without the required permissions.
|
class |
CmsRoleViolationException
A role violation occurs if a user without permissions tries to access a protected OpenCms system feature that can only
be accessed by users in certain roles.
|
class |
CmsSecurityException
Used to signal security related issues, for example example during file access and login.
|
class |
CmsUserDisabledException
Signals that an attempt to authenticate (login) a user has failed because the user had to many invalid logins.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsCustomLoginException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsUserDisabledException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsPasswordEncryptionException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsSecurityException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsRoleViolationException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsAuthentificationException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
CmsException |
CmsPermissionViolationException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| 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 |
CmsPasswordInfo.applyChanges()
Sets the new password for the current logged in user.
|
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.
|
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.
|
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.
|
I_CmsPermissionHandler.CmsPermissionCheckResult |
CmsDefaultPermissionHandler.hasPermissions(CmsDbContext dbc,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter) |
I_CmsPermissionHandler.CmsPermissionCheckResult |
I_CmsPermissionHandler.hasPermissions(CmsDbContext dbc,
CmsResource resource,
CmsPermissionSet requiredPermissions,
boolean checkLock,
CmsResourceFilter filter)
Performs a non-blocking permission check on a resource.
|
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) |
void |
CmsOrgUnitManager.initialize(CmsObject cms)
Initializes the organizational units.
|
void |
CmsPersistentLoginTokenHandler.invalidateToken(CmsUser user,
java.lang.String token)
Invalidates all tokens for the given user.
|
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.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsSiteManagerImpl.addSite(CmsObject cms,
CmsSite site)
Adds a site.
|
java.lang.String |
CmsSiteManagerImpl.getSiteTitle(CmsObject cms,
CmsResource resource)
Returns the site title.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsXmlSitemapGenerator.addDetailLinks(CmsResource containerPage,
java.util.Locale locale)
Adds the detail page links for a given page to the results.
|
protected void |
CmsDetailPageDuplicateEliminatingSitemapGenerator.addDetailLinks(CmsResource containerPage,
java.util.Locale locale) |
protected long |
CmsXmlSitemapGenerator.computeContainerPageModificationDate(CmsResource containerPage)
Computes the container the container page modification date from its referenced contents.
|
static CmsXmlSitemapGenerator |
CmsXmlSitemapActionElement.createSitemapGenerator(java.lang.String className,
java.lang.String folderRootPath)
Creates an XML sitemap generator instance given a class name and the root path for the sitemap.
|
java.util.List<CmsXmlSitemapUrlBean> |
CmsXmlSitemapGenerator.generateSitemapBeans()
Generates a list of XML sitemap entry beans for the root folder which has been set in the constructor.
|
java.util.List<CmsXmlSitemapUrlBean> |
CmsDetailPageDuplicateEliminatingSitemapGenerator.generateSitemapBeans() |
protected java.util.List<CmsResource> |
CmsXmlSitemapGenerator.getDirectPages()
Gets the list of pages which should be directly added to the XML sitemap.
|
void |
CmsXmlSeoConfiguration.load(CmsObject cms,
CmsResource resource)
Loads the bean data from the given resource.
|
static CmsXmlSitemapGenerator |
CmsXmlSitemapActionElement.prepareSitemapGenerator(CmsResource seoFileRes,
CmsXmlSeoConfiguration config)
Constructs an XML sitemap generator given an XML sitemap configuration file.
|
java.lang.String |
CmsXmlSitemapGenerator.renderSitemap()
Generates a sitemap and formats it as a string.
|
| Constructor and Description |
|---|
CmsDetailPageDuplicateEliminatingSitemapGenerator(java.lang.String sitemapPath)
Constructor.
|
CmsXmlSitemapGenerator(java.lang.String folderRootPath)
Creates a new sitemap generator instance.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsStaticExportException
Describes errors that occur in the context of OpenCms scheduler.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsStaticExportException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsStaticExportManager.createExportFolder(java.lang.String exportPath,
java.lang.String rfsName)
Creates the parent folder for a exported resource in the RFS.
|
void |
CmsAfterPublishStaticExportHandler.doExportAfterPublish(java.util.List<CmsPublishedResource> resources,
I_CmsReport report)
Does the actual static export.
|
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 void |
CmsAfterPublishStaticExportHandler.exportAfterPublish(CmsUUID publishHistoryId,
I_CmsReport report)
Starts the static export on publish.
|
void |
CmsStaticExportManager.exportFullStaticRender(boolean purgeFirst,
I_CmsReport report)
Starts a complete static export of all resources.
|
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.
|
java.util.List<CmsPublishedResource> |
CmsAfterPublishStaticExportHandler.getAllResources(CmsObject cms)
Returns all resources within the current OpenCms site that are not marked as internal.
|
java.util.Set<CmsPublishedResource> |
CmsStaticExportExportRule.getExportResources(CmsObject cms)
Returns a set of
objects containing all resources specified by the
<export-resources> node of this rule. |
java.util.Set<CmsPublishedResource> |
CmsStaticExportExportRule.getRelatedResources(CmsObject cms,
CmsPublishedResource publishedResource)
Returns a set of
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
objects containing all related resources of the VFS tree. |
protected java.util.Set<CmsPublishedResource> |
CmsAfterPublishStaticExportHandler.getSiblings(CmsObject cms,
CmsPublishedResource pubResource)
Returns all siblings of the published resource as list of
CmsPublishedResource. |
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 |
CmsStaticExportManager.writeResource(javax.servlet.http.HttpServletRequest req,
java.lang.String exportPath,
java.lang.String rfsName,
CmsResource resource,
byte[] content)
Writes a resource to the given export path with the given rfs name and the given content.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsSynchronizeException
Thrown by a class which implements org.opencms.file.I_CmsSyncModifications.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsSynchronizeException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
void |
CmsSynchronizeSettings.checkValues(CmsObject cms)
Performs a check if the values that have been set are valid.
|
| Constructor and Description |
|---|
CmsSynchronize(CmsObject cms,
CmsSynchronizeSettings settings,
I_CmsReport report)
Creates a new CmsSynchronize object which automatically start the
synchronization process.
|
| Modifier and Type | Method and Description |
|---|---|
protected CmsXmlContent |
CmsUgcSession.addContentValues(CmsFile file,
java.util.Map<java.lang.String,java.lang.String> contentValues)
Adds the given values to the content document.
|
void |
CmsUgcSession.finish()
Finishes the session and publishes the changed resources if necessary.
|
java.util.Map<java.lang.String,java.lang.String> |
CmsUgcSession.getValues()
Returns the content values.
|
CmsUgcConfiguration |
CmsUgcConfigurationReader.readConfiguration(CmsFile configFile)
Reads the given configuration file.
|
| Constructor and Description |
|---|
CmsUgcSession(CmsObject adminCms,
CmsObject cms,
CmsUgcConfiguration configuration)
Constructor.
|
CmsUgcSession(CmsObject cms,
CmsUgcConfiguration configuration)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsUserIconHelper.setUserImage(CmsObject cms,
CmsUser user,
java.lang.String rootPath)
Sets the user image for the given user.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsFileExplorer.readFolder(CmsUUID folderId)
Reads the given folder.
|
protected void |
CmsFileExplorer.readFolder(CmsUUID folderId,
boolean clearFilter)
Reads the given folder.
|
| Constructor and Description |
|---|
CmsWorkplaceAppManager(CmsObject adminCms)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
CmsImageCacheHelper.getSingleSize(CmsObject cms,
java.lang.String resPath)
Reads the size of a single image.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsSourceSearchForm.updateSearchRoot()
Updates the search root.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsSessionsTable.ini()
Initializes the table.
|
| 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.
|
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 void |
CmsUserTable.openInfoDialog(CmsUUID id)
Opens the user info dialog.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsResourceTreeContainer.update(CmsObject cms,
CmsUUID id,
CmsResourceFilter filter)
Updates the item for the given structure id.
|
| Constructor and Description |
|---|
CmsNavigationFilter(CmsObject cms,
CmsResource root)
Creates a new instance.
|
CmsResourceSelectDialog(CmsResourceFilter filter)
Creates a new instance.
|
CmsResourceSelectDialog(CmsResourceFilter filter,
CmsObject cms)
public constructor with given CmsObject.
|
CmsResourceSelectDialog(CmsResourceFilter filter,
CmsObject cms,
CmsResourceSelectDialog.Options options)
public constructor.
|
| 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.
|
protected void |
CmsCopyMoveDialog.performSingleOperation(CmsResource source,
CmsResource target,
CmsCopyMoveDialog.Action action,
boolean overwrite,
java.util.Map<java.lang.String,java.lang.String> makroMap)
Performs the single resource operation.
|
protected void |
CmsCopyMoveDialog.performSingleOperation(CmsResource source,
CmsResource target,
java.lang.String name,
CmsCopyMoveDialog.Action action,
boolean overwrite,
java.util.Map<java.lang.String,java.lang.String> macroMap)
Performs the single resource operation.
|
protected void |
CmsSecureExportDialog.saveData()
Touches the selected files.
|
void |
CmsCopyMoveDialog.setTargetFolder(CmsUUID structureId)
Preselects the target folder.
|
protected void |
CmsTouchDialog.touchFiles()
Touches the selected files.
|
protected java.util.List<CmsUUID> |
CmsUndeleteDialog.undelete()
Undeletes the selected files
|
| Constructor and Description |
|---|
CmsChangeTypeDialog(I_CmsDialogContext context)
Creates a new instance.
|
CmsRestoreDeletedDialog(I_CmsDialogContext context)
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.util.List<CmsUUID> |
CmsAvailabilityDialog.changeAvailability()
Actually performs the availability change.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsHistoryDialog.tryCompare()
Opens the 'compare' view for the two selected versions of the resource.
|
| Modifier and Type | Method and Description |
|---|---|
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> |
CmsValueDiff.diff(CmsObject cms,
CmsHistoryResourceBean v1,
CmsHistoryResourceBean v2) |
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsMessageBundleEditorModel.deleteDescriptorIfNecessary()
When the descriptor was added while editing, but the change was not saved, it has to be removed
when the editor is closed.
|
com.vaadin.v7.data.util.IndexedContainer |
CmsMessageBundleEditorModel.getContainerForCurrentLocale()
Returns the container filled according to the current locale.
|
void |
CmsMessageBundleEditorModel.save()
Saves the messages for all languages that were opened in the editor.
|
void |
CmsMessageBundleEditorModel.saveAsPropertyBundle()
Saves the loaded XML bundle as property bundle.
|
| Constructor and Description |
|---|
CmsMessageBundleEditorModel(CmsObject cms,
CmsResource resource) |
| Modifier and Type | Method and Description |
|---|---|
java.util.List<CmsFavoriteEntry> |
CmsFavoriteDAO.loadFavorites()
Loads the favorite list.
|
void |
CmsFavoriteDAO.saveFavorites(java.util.List<CmsFavoriteEntry> favorites)
Saves the favorites.
|
java.lang.String |
CmsFavoriteEntry.updateContextAndGetFavoriteUrl(CmsObject cms)
Prepares the CmsObject for jumping to this favorite location, and returns the appropriate URL.
|
| Constructor and Description |
|---|
CmsFavoriteDAO(CmsObject cms)
Creates a new instance.
|
CmsFavoriteDAO(CmsObject cms,
java.lang.String userName)
Creates a new instance.
|
CmsFavoriteDialog(I_CmsFavoriteContext context,
CmsFavoriteDAO favDao)
Creates a new dialog instance.
|
| 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.displayVaadinLoginDialog(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Returns the initial HTML for the Vaadin based login dialog.
|
static java.lang.String |
CmsLoginController.getLoginTarget(CmsObject currentCms,
CmsWorkplaceSettings settings,
java.lang.String requestedResource)
Gets the login target link.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
CmsVfsSitemapService |
CmsSitemapTreeDataProvider.getSitemapService()
Gets the sitemap service.
|
void |
CmsSitemapTreeNodeData.initialize(CmsObject cms)
Initializes the bean.
|
void |
CmsLocaleComparePanel.initialize(CmsUUID id,
java.util.Locale initialComparisonLocale)
Initializes the locale comparison view.
|
protected void |
CmsLocaleComparePanel.initTree(CmsResource rootRes)
Initializes the tree with the given resource as a root.
|
void |
CmsLocaleComparePanel.switchToLocale(java.util.Locale locale)
Switches the root locale to the given value.
|
| Constructor and Description |
|---|
CmsLocaleLinkTargetSelectionDialog(I_CmsDialogContext context,
I_CmsLocaleCompareContext localeContext)
Creates a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
CmsResource |
CmsNewResourceBuilder.createResource()
Triggers the resource creation.
|
CmsPropertiesBean |
CmsNewResourceBuilder.PropertyEditorHelper.loadPropertyData(CmsUUID id)
Loads the data needed for editing the properties of a resource.
|
| Constructor and Description |
|---|
CmsNewResourceBuilder(CmsObject cms)
Creates a new instance.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsRfsException
Used to signal issues with the real local file system (RFS), for example during file access.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsRfsException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
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).
|
static void |
CmsVfsUtil.createFolder(CmsObject cms,
java.lang.String rootPath)
Creates a folder and its parent folders if they don't exist.
|
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 |
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.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsWidgetException
Describes errors that occur in the context of the OpenCms widgets.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsWidgetException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Class and Description |
|---|---|
class |
CmsInvalidActionException
An exception which indicates that a user tried to execute an invalid workflow action.
|
class |
CmsNewParentNotInWorkflowException
An exception which indicates that the user tried to trigger a workflow action for a set of resources for which some parent folder
is not included in the set, but has the resource state 'new'.
|
| 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.
|
protected void |
CmsExtendedWorkflowManager.cleanupEmptyWorkflowProjects(java.util.List<CmsProject> projects)
Cleans up empty workflow projects.
|
protected void |
CmsExtendedWorkflowManager.cleanupProjectIfEmpty(CmsProject project)
Removes a project if there are no longer any resources which have been last modified in that project.
|
protected void |
CmsExtendedWorkflowManager.clearLocks(CmsProject project,
java.util.List<CmsResource> resources)
Ensures that the resources to be released are unlocked.
|
protected CmsPublishResource |
CmsDefaultPublishResourceFormatter.createPublishResource(CmsResource resource)
Creates a publish resource bean from a resource.
|
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) |
CmsPublishResourceInfo |
CmsDefaultPublishResourceFormatter.AlreadyPublishedValidator.getInfoForResource(CmsResource resource) |
CmsPublishResourceInfo |
CmsDefaultPublishResourceFormatter.BlockingLockedValidator.getInfoForResource(CmsResource resource) |
CmsPublishResourceInfo |
CmsDefaultPublishResourceFormatter.I_PublishResourceValidator.getInfoForResource(CmsResource resource)
Gets the status information for an excluded resource.
|
java.util.List<CmsPublishResource> |
I_CmsPublishResourceFormatter.getPublishResources()
Gets the publish resource beans created by this formatter.
|
java.util.List<CmsResource> |
CmsExtendedRealProjectWrapper.getResources(CmsObject cms,
java.util.Map<java.lang.String,java.lang.String> params,
java.lang.String workflowId) |
void |
CmsDefaultPublishResourceFormatter.initialize(CmsPublishOptions options,
CmsPublishRelationFinder.ResourceMap resources) |
void |
I_CmsPublishResourceFormatter.initialize(CmsPublishOptions options,
CmsPublishRelationFinder.ResourceMap resources)
Initializes the formatter.
|
protected boolean |
CmsExtendedWorkflowManager.isProjectEmpty(CmsProject project)
Checks whether there are resources which have last been modified in a given project.
|
protected boolean |
CmsExtendedWorkflowManager.isProjectManager(CmsObject userCms)
Checks whether the user for a given CMS context can manage workflow projects.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsWorkplaceException
Signals that an exceptional program flow happens in the workplace.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsWorkplaceException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
CmsDialog.buildLockHeaderBox()
Returns the html code to build the header box.
|
void |
CmsWorkplace.checkLock(java.lang.String resource)
Checks the lock state of the resource and locks it if the autolock feature is enabled.
|
void |
CmsWorkplace.checkLock(java.lang.String resource,
CmsLockType type)
Checks the lock state of the resource and locks it if the autolock feature is enabled.
|
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.
|
CmsObject |
CmsWorkplaceAction.getCmsAdminObject()
Gets the admin cmsObject.
|
java.lang.String |
CmsDialog.getState()
Gets a formatted file state string.
|
void |
CmsWorkplaceManager.initialize(CmsObject cms)
Initializes the workplace manager with the OpenCms system configuration.
|
protected void |
CmsWorkplace.switchToCurrentProject()
Helper method to change back from the temporary project to the current project.
|
protected CmsUUID |
CmsWorkplace.switchToTempProject()
Helper method to change the current project to the temporary file project.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
| Constructor and Description |
|---|
CmsXmlDocumentComparison(CmsObject cms,
CmsFile res1,
CmsFile res2)
Creates a new xml document comparison.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
CmsEditor.actionExit()
Performs the exit editor action.
|
void |
CmsEditor.checkLock(java.lang.String resource,
CmsLockType type) |
protected void |
CmsEditor.commitTempFile()
Writes the content of a temporary file back to the original file.
|
protected void |
CmsXmlContentEditor.commitTempFile() |
protected java.lang.String |
CmsEditor.createTempFile()
Creates a temporary file which is needed while working in an editor with preview option.
|
protected CmsObject |
CmsEditor.getCloneCms()
Returns a cloned cms instance that prevents the time range resource filter check.
|
java.lang.String |
CmsEditorHandler.getEditorUri(java.lang.String resource,
CmsJspActionElement jsp) |
java.lang.String |
I_CmsEditorHandler.getEditorUri(java.lang.String resource,
CmsJspActionElement jsp)
Returns the editor URI which will be used for the selected resource in the OpenCms VFS to the editor selector class.
|
protected void |
CmsDefaultPageEditor.performSaveContent(java.lang.String body,
java.util.Locale locale)
Saves the editor content to the temporary file.
|
protected void |
CmsDialogCopyLanguage.transferContents(CmsXmlContent content,
java.util.Locale sourceLocale,
java.util.List<java.util.Locale> destLocales)
Copies the contents from a source locale to a number of destination locales by overwriting them.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.lang.String |
CmsDirectEditDefaultProvider.getContentAsString(CmsFile file)
Helper method to convert the content of a resource to a string.
|
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 |
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.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsExplorerTypeAccess.createAccessControlList(java.lang.String resourceType)
Creates the access control list from the temporary map.
|
java.lang.String |
CmsResourceUtil.getNoEditReason(java.util.Locale locale)
Checks is the current resource can be edited by the current user.
|
java.lang.String |
CmsResourceUtil.getNoEditReason(java.util.Locale locale,
boolean ignoreExpiration)
Checks is the current resource can be edited by the current user.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CmsXmlException
Signals that an error occurred while processing an xml resource.
|
| Modifier and Type | Method and Description |
|---|---|
CmsException |
CmsXmlException.createException(CmsMessageContainer container,
java.lang.Throwable cause) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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 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 CmsResource |
CmsXmlContainerPage.fillResource(CmsObject cms,
org.dom4j.Element element,
CmsUUID resourceId)
Fills a
CmsXmlVfsFileValue with the resource identified by the given id. |
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.
|
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.
|
java.util.Set<java.lang.String> |
CmsXmlInheritGroupContainerHandler.getJSHeadIncludes(CmsObject cms,
CmsResource resource) |
java.util.Set<java.lang.String> |
CmsXmlGroupContainerHandler.getJSHeadIncludes(CmsObject cms,
CmsResource resource) |
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.
|
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.
|
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.
|
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.
|
CmsFile |
CmsHtmlRedirectHandler.prepareForWrite(CmsObject cms,
CmsXmlContent content,
CmsFile file) |
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.
|
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.
|
void |
CmsXmlContainerPage.writeContainerPage(CmsObject cms,
CmsContainerPageBean cntPage)
Saves a container page in in-memory XML structure.
|
| Constructor and Description |
|---|
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.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsMappingResolutionContext.commitUrlNameMappings()
Writes all the stored URL name mappings to the database.
|
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.
|
CmsObject |
CmsDefaultXmlContentHandler.createRootCms(CmsObject cms)
Copies a given CMS context and set the copy's site root to '/'.
|
void |
CmsMappingResolutionContext.finalizeMappings()
Finalizes the mappings.
|
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.
|
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.
|
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.
|
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.getUriForId(CmsObject cms,
CmsUUID id)
Returns a sitemap or VFS path given a sitemap entry id or structure id.
|
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.
|
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.
|
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.
|
protected CmsFile |
CmsDefaultXmlContentHandler.writeCategories(CmsObject cms,
CmsFile file,
CmsXmlContent content)
Writes the categories if a category widget is present.
|
| Constructor and Description |
|---|
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.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
| 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.
|