程序包 | 说明 |
---|---|
org.opencms.ade.containerpage | |
org.opencms.db |
Low-level database connection and access functionality.
|
org.opencms.db.log |
This package contains the implementation classes for the DB log.
|
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.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.i18n |
Classes to handle internalization (i18n) and locale selection in OpenCms.
|
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.module |
OpenCms modules provide a powerful, standardized way to extend
the core OpenCms functionality.
|
org.opencms.relations |
Classes to represent and validate the internal and external links/relations of resources in the OpenCms VFS.
|
org.opencms.search |
Implements the main full text search and indexing functions available in OpenCms.
|
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 | |
org.opencms.security |
Access control and security classes for the OpenCms ACL permission system.
|
org.opencms.util |
Utility functions for String manipulation and other often used tasks.
|
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.administration |
This package contains the core classes for implementing the administration view.
|
org.opencms.workplace.comparison |
Contains OpenCms Workplace dialogs to compare OpenCms Xml Documents.
|
org.opencms.workplace.list |
Generates the list views commonly used in the OpenCms Workplace "Administration" tools.
|
org.opencms.workplace.threads |
A collection of thread classes that are used in the OpenCms Workplace,
usually in connection with a report.
|
org.opencms.workplace.tools |
Contains the base classes for implementing a tool in the OpenCms Workplace "Administration" view.
|
org.opencms.workplace.tools.accounts |
This package contains the tool classes for the account management related administration views.
|
org.opencms.workplace.tools.content |
This package contains the tool classes for the content tools administration view.
|
org.opencms.workplace.tools.content.convertxml | |
org.opencms.workplace.tools.content.updatexml | |
org.opencms.workplace.tools.database |
This package contains the tool classes for the database management related administration views.
|
org.opencms.workplace.tools.projects |
This package contains the tool classes for the account management related administration views.
|
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.types |
Contains the basic XML content type definitions, used for XML content and XML pages.
|
限定符和类型 | 方法和说明 |
---|---|
CmsUUID |
CmsContainerpageService.convertToServerId(java.lang.String id)
Parses an element id.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsDriverManager.copyResource(CmsDbContext dbc,
CmsResource source,
java.lang.String destination,
org.opencms.file.CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
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.
|
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.
|
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.
|
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.
|
java.lang.String |
CmsDriverManager.moveToLostAndFound(CmsDbContext dbc,
CmsResource resource,
boolean returnNameOnly)
Moves a resource to the "lost and found" folder.
|
void |
CmsDriverManager.removeUserFromGroup(CmsDbContext dbc,
java.lang.String username,
java.lang.String groupname,
boolean readRoles)
Removes a user from a group.
|
void |
CmsDriverManager.setPassword(CmsDbContext dbc,
java.lang.String username,
java.lang.String newPassword)
Sets the password for a user.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsLogEntryType |
CmsLogEntryType.valueOf(int id)
Parses an
int into a log entry type. |
限定符和类型 | 方法和说明 |
---|---|
void |
CmsUser.checkName(java.lang.String name)
Checks if the provided user name is a valid user name and can be used as an argument value
for
CmsPrincipal.setName(String) . |
static void |
CmsPropertyDefinition.checkPropertyName(java.lang.String name)
Checks if the provided property name is a valid property name,
that is contains only valid characters.
|
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,
org.opencms.file.CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
int type)
Creates a new resource of the given resource type with
empty content and no properties.
|
CmsResource |
CmsObject.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.
|
限定符和类型 | 方法和说明 |
---|---|
protected java.util.List<CmsResource> |
CmsDefaultResourceCollector.getAllInFolder(CmsObject cms,
java.lang.String param,
boolean tree)
Returns all resources in the folder pointed to by the parameter.
|
限定符和类型 | 方法和说明 |
---|---|
void |
I_CmsResourceType.copyResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource source,
java.lang.String destination,
org.opencms.file.CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource.
|
void |
A_CmsResourceTypeFolderBase.copyResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource source,
java.lang.String destination,
org.opencms.file.CmsResource.CmsResourceCopyMode siblingMode) |
void |
I_CmsResourceType.copyResourceToProject(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource)
Copies a resource to the current project of the user.
|
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.
|
void |
I_CmsResourceType.moveResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
java.lang.String destination)
Moves a resource to the given destination.
|
void |
A_CmsResourceTypeFolderBase.moveResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
java.lang.String destination) |
void |
CmsResourceTypeJsp.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 |
CmsResourceTypePlain.moveResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
java.lang.String destination) |
void |
I_CmsResourceType.removeResourceFromProject(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource)
Removes a resource from the current project of the user.
|
限定符和类型 | 方法和说明 |
---|---|
boolean |
I_CmsResourceWrapper.copyResource(CmsObject cms,
java.lang.String source,
java.lang.String destination,
CmsResourceCopyMode siblingMode)
Copies a resource.
|
boolean |
CmsResourceWrapperXmlPage.copyResource(CmsObject cms,
java.lang.String source,
java.lang.String destination,
CmsResourceCopyMode siblingMode) |
boolean |
A_CmsResourceWrapper.copyResource(CmsObject cms,
java.lang.String source,
java.lang.String destination,
CmsResourceCopyMode siblingMode) |
boolean |
A_CmsResourceExtensionWrapper.copyResource(CmsObject cms,
java.lang.String source,
java.lang.String destination,
CmsResourceCopyMode siblingMode) |
void |
CmsObjectWrapper.copyResource(java.lang.String source,
java.lang.String destination,
CmsResourceCopyMode siblingMode)
Copies a resource.
|
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 |
CmsResourceWrapperPreventCreateNameCI.createResource(CmsObject cms,
java.lang.String resourcepath,
int type,
byte[] content,
java.util.List<CmsProperty> properties) |
CmsResource |
CmsResourceWrapperReplaceDeleted.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 |
CmsResourceWrapperXmlPage.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 |
A_CmsResourceExtensionWrapper.createResource(CmsObject cms,
java.lang.String resourcename,
int type,
byte[] content,
java.util.List<CmsProperty> 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 |
I_CmsResourceWrapper.moveResource(CmsObject cms,
java.lang.String source,
java.lang.String destination)
Moves a resource to the given destination.
|
boolean |
CmsResourceWrapperPreventCreateNameCI.moveResource(CmsObject cms,
java.lang.String source,
java.lang.String destination) |
boolean |
CmsResourceWrapperXmlPage.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 |
A_CmsResourceExtensionWrapper.moveResource(CmsObject cms,
java.lang.String source,
java.lang.String destination) |
限定符和类型 | 方法和说明 |
---|---|
void |
CmsMultiMessages.addMessages(CmsMessages messages)
Adds a messages instance to this multi message bundle.
|
限定符和类型 | 方法和说明 |
---|---|
int |
CmsJspTagNavigation.doStartTag() |
int |
CmsJspTagResourceLoad.doStartTag() |
int |
CmsJspTagFormatter.doStartTag() |
int |
CmsJspTagContentLoad.doStartTag() |
限定符和类型 | 方法和说明 |
---|---|
protected void |
CmsModule.checkFrozen()
Checks if this modules configuration is frozen.
|
void |
CmsModuleManager.checkModuleSelectionList(java.util.List<java.lang.String> moduleNames,
java.lang.String rfsAbsPath,
boolean forDeletion)
Checks the module selection list for consistency, that means
that if a module is selected, all its dependencies are also selected.
|
void |
CmsModule.checkResources(CmsObject cms)
Checks if all resources of the module are present.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsRelationType |
CmsRelationType.valueOf(int id)
Parses an
int into a relation type. |
static CmsRelationType |
CmsRelationType.valueOf(java.lang.String name)
Parses an
String into a relation type. |
限定符和类型 | 方法和说明 |
---|---|
void |
CmsSearchIndexSource.setIndexerClassName(java.lang.String indexerClassName)
Sets the class name of the indexer.
|
void |
CmsSearchIndexSource.setName(java.lang.String name)
Sets the logical key/name of this search index source.
|
void |
CmsSearchIndex.setName(java.lang.String name)
Sets the logical key/name of this search index.
|
void |
CmsSearchParameters.setSearchIndex(CmsSearchIndex index)
Sets the search index to use for the search.
|
构造器和说明 |
---|
CmsSearchIndex(java.lang.String name)
Creates a new CmsSearchIndex with the given name.
|
构造器和说明 |
---|
CmsGallerySearchIndex(java.lang.String name)
Creates a new gallery search index with the given name.
|
构造器和说明 |
---|
CmsSolrIndex(java.lang.String name)
Public constructor to create a Solr index.
|
限定符和类型 | 方法和说明 |
---|---|
void |
I_CmsValidationHandler.checkEmail(java.lang.String email)
Checks if the provided email is a valid email address.
|
void |
CmsDefaultValidationHandler.checkEmail(java.lang.String email)
The email should only be composed by digits and standard english letters, points,
underscores and exact one "At" symbol.
|
void |
I_CmsValidationHandler.checkFirstname(java.lang.String firstname)
Checks if the provided first name is valid.
|
void |
CmsDefaultValidationHandler.checkFirstname(java.lang.String firstname) |
void |
I_CmsValidationHandler.checkGroupName(java.lang.String groupName)
Checks if the provided group name is a valid group name.
|
void |
CmsDefaultValidationHandler.checkGroupName(java.lang.String name) |
void |
I_CmsValidationHandler.checkLastname(java.lang.String lastname)
Checks if the provided last name is valid.
|
void |
CmsDefaultValidationHandler.checkLastname(java.lang.String lastname) |
void |
I_CmsValidationHandler.checkUserName(java.lang.String userName)
Checks if the provided user name is a valid user name.
|
void |
CmsDefaultValidationHandler.checkUserName(java.lang.String userName)
A user name can only be composed of digits,
standard ASCII letters and the symbols defined in
CmsDefaultValidationHandler.USERNAME_CONSTRAINTS . |
void |
I_CmsValidationHandler.checkZipCode(java.lang.String zipcode)
Checks if the provided string is a valid zip code.
|
void |
CmsDefaultValidationHandler.checkZipCode(java.lang.String zipcode)
That means, the parameter should only be composed by digits and standard english letters.
|
限定符和类型 | 方法和说明 |
---|---|
static void |
CmsStringUtil.checkName(java.lang.String name,
java.lang.String contraints,
java.lang.String key,
I_CmsMessageBundle bundle)
Checks if a given name is composed only of the characters
a...z,A...Z,0...9
and the provided constraints . |
static void |
CmsFileUtil.checkResources(CmsObject cms,
java.util.List<java.lang.String> resources)
Checks if all resources are present.
|
java.lang.String |
PrintfFormat.sprintf(double x)
Format a double.
|
java.lang.String |
PrintfFormat.sprintf(int x)
Format an int.
|
java.lang.String |
PrintfFormat.sprintf(long x)
Format an long.
|
java.lang.String |
PrintfFormat.sprintf(java.lang.Object x)
Format an Object.
|
java.lang.String |
PrintfFormat.sprintf(java.lang.String x)
Format a String.
|
构造器和说明 |
---|
PrintfFormat(java.util.Locale locale,
java.lang.String fmtArg)
Constructs an array of control specifications
possibly preceded, separated, or followed by
ordinary strings.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsWidgetDialogParameter.setStringValue(CmsObject cms,
java.lang.String value) |
限定符和类型 | 方法和说明 |
---|---|
protected java.lang.String |
A_CmsImportFromHttp.copyFileToServer(java.lang.String destination)
Gets a database import file from the client and copies it to the server.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsDiffViewMode |
CmsDiffViewMode.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
限定符和类型 | 方法和说明 |
---|---|
java.lang.Object |
CmsListItem.get(java.lang.String columnId)
Returns the value of the column for this item.
|
java.lang.Object |
CmsListItem.set(java.lang.String columnId,
java.lang.Object value)
Sets the object to display at the given column.
|
void |
CmsHtmlList.setCurrentPage(int currentPage)
Sets the current page.
|
void |
CmsHtmlList.setSortedColumn(java.lang.String sortedColumn)
Sets the sorted column.
|
static CmsListColumnAlignEnum |
CmsListColumnAlignEnum.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
static CmsListOrderEnum |
CmsListOrderEnum.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsXmlContentRepairSettings.setVfsFolder(java.lang.String vfsFolder)
Sets the VFS folder under which XML contents will be processed recursively.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsHtmlIconButtonStyleEnum |
CmsHtmlIconButtonStyleEnum.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsDependencyIconActionType |
CmsDependencyIconActionType.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsTagReplaceSettings.setPropertyValueTagReplaceID(java.lang.String propertyValueTagreplaceID)
Sets the value of the shared
CmsTagReplaceSettings.PROPERTY_CONTENTOOLS_TAGREPLACE to set on resources
that have been processed with these settings. |
void |
CmsTagReplaceSettings.setReplacements(java.util.SortedMap replacements)
Sets the replacements to perform in form of a comma-separated List of "key=value" tokens.
|
void |
CmsTagReplaceSettings.setWorkPath(java.lang.String workPath)
Sets the path under which files will be processed recursively.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsConvertXmlSettings.setIncludeSubFolders(boolean subFolders)
Sets value if also process files in sub folders.
|
void |
CmsConvertXmlSettings.setOnlyCountFiles(boolean countFiles)
Sets if only count files to transform.
|
void |
CmsConvertXmlSettings.setResourceType(int resourceType)
Sets resource type to transform.
|
void |
CmsConvertXmlSettings.setVfsFolder(java.lang.String vfsFolder)
Sets vfs folder to process files in.
|
void |
CmsConvertXmlSettings.setXslFile(java.lang.String xslFile)
Sets path to xsl file.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsUpdateXmlSettings.setIncludeSubFolders(boolean subFolders)
Sets value if also process files in sub folders.
|
void |
CmsUpdateXmlSettings.setOnlyCountFiles(boolean countFiles)
Sets if only count files to transform.
|
void |
CmsUpdateXmlSettings.setResourceType(int resourceType)
Sets resource type to transform.
|
void |
CmsUpdateXmlSettings.setVfsFolder(java.lang.String vfsFolder)
Sets vfs folder to process files in.
|
void |
CmsUpdateXmlSettings.setXslFile(java.lang.String xslFile)
Sets path to xsl file.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsHtmlImport.validate(org.apache.commons.fileupload.FileItem fi,
boolean isdefault)
Tests if all given input parameters for the HTML Import are valid, that is that all the
given folders do exist.
|
限定符和类型 | 方法和说明 |
---|---|
static CmsProjectResourcesDisplayMode |
CmsProjectResourcesDisplayMode.valueOf(java.lang.String value)
Parses an string into an element of this enumeration.
|
限定符和类型 | 方法和说明 |
---|---|
I_CmsXmlContentValue |
CmsXmlContent.addValue(CmsObject cms,
java.lang.String path,
java.util.Locale locale,
int index)
Adds a new XML content value for the given element name and locale at the given index position
to this XML content document.
|
限定符和类型 | 方法和说明 |
---|---|
void |
CmsXmlPage.addValue(java.lang.String name,
java.util.Locale locale)
Adds a new, empty value with the given name and locale
to this XML document.
|
void |
CmsXmlPage.renameValue(java.lang.String oldValue,
java.lang.String newValue,
java.util.Locale locale)
Renames the page-element value from the old to the new one.
|
限定符和类型 | 方法和说明 |
---|---|
void |
A_CmsXmlValueTextBase.setStringValue(CmsObject cms,
java.lang.String value) |
void |
CmsXmlBooleanValue.setStringValue(CmsObject cms,
java.lang.String value) |
void |
CmsXmlVarLinkValue.setStringValue(CmsObject cms,
java.lang.String value) |
void |
CmsXmlVfsImageValue.setStringValue(CmsObject cms,
java.lang.String value) |
void |
A_CmsXmlValueCdataBase.setStringValue(CmsObject cms,
java.lang.String value) |
void |
CmsXmlCategoryValue.setStringValue(CmsObject cms,
java.lang.String value) |
void |
CmsXmlVfsFileValue.setStringValue(CmsObject cms,
java.lang.String value) |