Uses of Class
org.opencms.configuration.CmsParameterConfiguration

Packages that use CmsParameterConfiguration

Package	Description
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.upload
org.opencms.ai
org.opencms.cmis
org.opencms.configuration	Reads and writes the XML based OpenCms configuration files.
org.opencms.crypto
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.db.storage
org.opencms.db.storage.policy
org.opencms.file.types	The implementations of the core resource types for the VFS are located here.
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.userdata
org.opencms.letsencrypt	Classes related to the LetsEncrypt docker integration.
org.opencms.loader	Low-level functions to manage the loading of resources from the OpenCms VFS.
org.opencms.main	Provides the main OpenCms "operating system".
org.opencms.repository	Package contains all classes and interfaces needed to create or use a repository to access the resources in the VFS.
org.opencms.scheduler	The OpenCms scheduler provides a facility to run jobs in a regular schedule, much like the "cron" faciltiy in UNIX systems.
org.opencms.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.solr	The package contains the Solr search integration.
org.opencms.security	Access control and security classes for the OpenCms ACL permission system.
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.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.xml2json
org.opencms.xml.xml2json.handler
org.opencms.xml.xml2json.renderer

Uses of CmsParameterConfiguration in org.opencms.ade.contenteditor

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

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDummyTranslator.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.ade.detailpage

Methods in org.opencms.ade.detailpage that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultDetailPageHandler.getConfiguration()	Gets the configuration.

Uses of CmsParameterConfiguration in org.opencms.ade.upload

Methods in org.opencms.ade.upload that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultUploadRestriction.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.ai

Methods in org.opencms.ai that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsAiContentTranslation.getConfiguration()
CmsParameterConfiguration	CmsDeeplTranslation.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.cmis

Methods in org.opencms.cmis that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsCmisRepository.getConfiguration()
CmsParameterConfiguration	I_CmsCmisRepository.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.configuration

Fields in org.opencms.configuration declared as CmsParameterConfiguration

Modifier and Type	Field	Description
static final CmsParameterConfiguration	CmsParameterConfiguration.EMPTY_PARAMETERS	An empty, immutable parameter configuration.

Methods in org.opencms.configuration that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsXmlConfiguration.getConfiguration()
CmsParameterConfiguration	CmsAdditionalLogFolderConfig.getConfiguration()
CmsParameterConfiguration	CmsConfigurationManager.getConfiguration()	Returns the properties read from opencms.properties.
CmsParameterConfiguration	CmsStoragePolicyConfiguration.getConfiguration()
CmsParameterConfiguration	I_CmsConfigurationParameterHandler.getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
CmsParameterConfiguration	CmsSystemConfiguration.ApiAuthorizationConfig.getParams()	Gets the parameters for the handler.
static CmsParameterConfiguration	CmsParameterConfiguration.unmodifiableVersion(CmsParameterConfiguration original)	Returns an unmodifiable version of this parameter configuration.

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

Modifier and Type	Method	Description
void	CmsSystemConfiguration.addRequestHandler(String clazz, CmsParameterConfiguration params)	Adds a new instance of a request handler class.
void	CmsSystemConfiguration.addResourceInitHandler(String clazz, CmsParameterConfiguration params)	Adds a new instance of a resource init handler class.
void	CmsConfigurationManager.setConfiguration(CmsParameterConfiguration propertyConfiguration)	Sets the configuration read from the opencms.properties.
static CmsParameterConfiguration	CmsParameterConfiguration.unmodifiableVersion(CmsParameterConfiguration original)	Returns an unmodifiable version of this parameter configuration.

Uses of CmsParameterConfiguration in org.opencms.crypto

Methods in org.opencms.crypto that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsAESCBCTextEncryption.getConfiguration()
CmsParameterConfiguration	CmsAESTextEncryption.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.db

Methods in org.opencms.db that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsOnlineFolderOptions.getParams()	Gets the additional parameters.
CmsParameterConfiguration	CmsDriverManager.getPropertyConfiguration()	Returns the configuration read from the opencms.properties file.

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

Modifier and Type	Method	Description
protected Object	CmsDriverManager.createDriver(CmsDbContext dbc, CmsConfigurationManager configManager, CmsParameterConfiguration config, String driverChainKey, String suffix)	Helper method for creating a driver from configuration data.
static com.zaxxer.hikari.HikariConfig	CmsDbPoolV11.createHikariConfig(CmsParameterConfiguration config, String key)	Creates the HikariCP configuration based on the configuration of a pool defined in opencms.properties.
Object	CmsDriverManager.newDriverInstance(CmsParameterConfiguration configuration, String driverName, String driverPoolUrl)	Method to create a new instance of a driver.
void	CmsDriverManager.newPoolInstance(CmsParameterConfiguration configuration, String poolName)	Method to create a new instance of a pool.

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

Modifier	Constructor	Description
	CmsDbPoolV11(CmsParameterConfiguration config, String key)	Default constructor.
	CmsOnlineFolderOptions(List<String> paths, CmsParameterConfiguration params)	Creates a new instance.

Uses of CmsParameterConfiguration in org.opencms.db.generic

Methods in org.opencms.db.generic with parameters of type CmsParameterConfiguration

Modifier and Type	Method	Description
protected List<String>	CmsStorageVfsDriver.getAdditionalSqlQueryProperties(CmsParameterConfiguration configuration)
protected List<String>	CmsVfsDriver.getAdditionalSqlQueryProperties(CmsParameterConfiguration configuration)	Returns additional SQL query property files to load between the generic and database-specific queries.

Uses of CmsParameterConfiguration in org.opencms.db.storage

Methods in org.opencms.db.storage with parameters of type CmsParameterConfiguration

Modifier and Type	Method	Description
static CmsS3ClientConfiguration	CmsStorageManager.createS3ClientConfiguration(CmsParameterConfiguration configuration, String prefix)	Creates an S3 client configuration from properties below the given prefix.
static CmsS3ClientConfiguration	CmsStorageManager.createS3ClientConfiguration(CmsParameterConfiguration configuration, String backendId, String bucketOverride)	Creates an S3 client configuration from a configured storage backend.
static String	CmsStorageManager.getActiveStorageId(CmsParameterConfiguration configuration)	Returns the active storage backend id from the runtime property configuration.
static String	CmsStorageManager.getActiveStorageType(CmsParameterConfiguration configuration)	Returns the active storage backend type from the runtime property configuration.
static List<String>	CmsStorageManager.getDataStorageIds(CmsParameterConfiguration configuration)	Returns the backend identifiers used for VFS data storage.
static String	CmsStorageManager.getFileSystemStoragePath(CmsParameterConfiguration configuration, String storageId)	Returns the configured file system repository path.
static String	CmsStorageManager.getStorageType(CmsParameterConfiguration configuration, String storageId)	Returns the type for a configured storage backend.

Constructors in org.opencms.db.storage with parameters of type CmsParameterConfiguration

Modifier	Constructor	Description
	CmsStorageManager(CmsSqlManager sqlManager, CmsParameterConfiguration configuration)	Creates a new storage manager.
	CmsStorageManager(CmsSqlManager sqlManager, CmsParameterConfiguration configuration, CmsStoragePolicyConfiguration storagePolicyConfiguration)	Creates a new storage manager.

Uses of CmsParameterConfiguration in org.opencms.db.storage.policy

Methods in org.opencms.db.storage.policy that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultStoragePolicy.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.file.types

Fields in org.opencms.file.types declared as CmsParameterConfiguration

Modifier and Type	Field	Description
protected CmsParameterConfiguration	A_CmsResourceType.m_configuration	Configuration parameters.

Methods in org.opencms.file.types that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsResourceType.getConfiguration()
CmsParameterConfiguration	CmsResourceTypeFolder.getConfiguration()
CmsParameterConfiguration	CmsResourceTypeFolderExtended.getConfiguration()
CmsParameterConfiguration	CmsResourceTypeXmlContent.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.jlan

Methods in org.opencms.jlan that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsJlanRepository.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.jsp

Methods in org.opencms.jsp that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultElementMarker.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.jsp.userdata

Methods in org.opencms.jsp.userdata that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultUserDataDomain.getConfiguration()
CmsParameterConfiguration	CmsUserDataHeader.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.letsencrypt

Methods in org.opencms.letsencrypt that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsLetsEncryptConfiguration.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.loader

Methods in org.opencms.loader that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDumpLoader.getConfiguration()	Will always return null since this loader does not need to be configured.
CmsParameterConfiguration	CmsImageLoader.getConfiguration()
CmsParameterConfiguration	CmsJspLoader.getConfiguration()
CmsParameterConfiguration	CmsMacroFormatterLoader.getConfiguration()	Returns null since XML document loaders does usually not need to be configured.
CmsParameterConfiguration	CmsPointerLoader.getConfiguration()	Will always return null since this loader does not need to be cnofigured.
CmsParameterConfiguration	CmsRedirectLoader.getConfiguration()

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

Modifier and Type	Method	Description
static I_CmsImageCache	CmsImageCacheFactory.create(CmsParameterConfiguration configuration)	Creates the configured external image cache.
void	CmsImageLoader.initializeImageCache(CmsParameterConfiguration propertyConfiguration)	Initializes the image cache after the complete OpenCms runtime configuration is available.
protected void	CmsImageLoader.initImageCache(CmsParameterConfiguration propertyConfiguration)	Initializes the optional image cache.
static void	CmsImageCacheFactory.validateConfiguration(CmsParameterConfiguration configuration)	Validates the image cache settings and separation from active and legacy data storage.

Uses of CmsParameterConfiguration in org.opencms.main

Methods in org.opencms.main that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsProtectedStaticFileHandler.getConfiguration()
default CmsParameterConfiguration	I_CmsRequestHandler.getConfiguration()	Gets the configuration.
default CmsParameterConfiguration	I_CmsResourceInit.getConfiguration()	Gets the configuration data.

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

Modifier and Type	Method	Description
protected void	OpenCmsCore.initConfiguration(CmsParameterConfiguration configuration)	Constructor to create a new OpenCms object.
default void	I_CmsRequestHandler.initParameters(CmsParameterConfiguration params)	Initializes parameters.
default void	I_CmsResourceInit.initParameters(CmsParameterConfiguration params)	Initializes parameters.
protected OpenCmsCore	OpenCmsCore.upgradeRunlevel(CmsParameterConfiguration configuration)	Upgrades to runlevel OpenCms.RUNLEVEL_3_SHELL_ACCESS, this is shell access to the database but no Servlet context.

Uses of CmsParameterConfiguration in org.opencms.repository

Methods in org.opencms.repository that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsRepository.getConfiguration()

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

Modifier and Type	Method	Description
static List<I_CmsResourceWrapper>	CmsRepositoryManager.createResourceWrappersFromConfiguration(CmsParameterConfiguration config, String paramName, org.apache.commons.logging.Log log)	Creates a list of resource wrappers from a collection of configuration parameters, for use in configuring repositories.

Uses of CmsParameterConfiguration in org.opencms.scheduler

Methods in org.opencms.scheduler that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsScheduledJobInfo.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.search

Methods in org.opencms.search that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsSearchIndex.getConfiguration()	Returns the empty configuration.
CmsParameterConfiguration	CmsSearchDocumentType.getConfiguration()
CmsParameterConfiguration	CmsSearchIndex.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.search.documents

Methods in org.opencms.search.documents that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsVfsDocument.getConfiguration()	Returns the empty configuration.

Uses of CmsParameterConfiguration in org.opencms.search.solr

Methods in org.opencms.search.solr that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsSolrIndex.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.security

Methods in org.opencms.security that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultPasswordHandler.getConfiguration()
CmsParameterConfiguration	CmsNullSecretStore.getConfiguration()
CmsParameterConfiguration	CmsRfsSecretStore.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.workplace.editors

Fields in org.opencms.workplace.editors declared as CmsParameterConfiguration

Modifier and Type	Field	Description
protected CmsParameterConfiguration	A_CmsPreEditorActionDefinition.m_configuration	Configuration parameters.

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

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsPreEditorActionDefinition.getConfiguration()

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

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

Modifier and Type	Field	Description
protected CmsParameterConfiguration	A_CmsDirectEditProvider.m_configurationParameters	The parameters form the configuration.

Methods in org.opencms.workplace.editors.directedit that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	A_CmsDirectEditProvider.getConfiguration()

Uses of CmsParameterConfiguration in org.opencms.xml.content

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

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsDefaultXmlContentHandler.getParameters()	Gets the set of parameters.

Uses of CmsParameterConfiguration in org.opencms.xml.xml2json

Methods in org.opencms.xml.xml2json with parameters of type CmsParameterConfiguration

Modifier and Type	Method	Description
void	CmsJsonResourceHandler.initParameters(CmsParameterConfiguration params)
void	I_CmsApiAuthorizationHandler.setParameters(CmsParameterConfiguration params)	Sets the configuration parameters for this handler.

Uses of CmsParameterConfiguration in org.opencms.xml.xml2json.handler

Methods in org.opencms.xml.xml2json.handler that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsJsonHandlerContext.getHandlerConfig()	Gets the configured handler parameters.

Constructors in org.opencms.xml.xml2json.handler with parameters of type CmsParameterConfiguration

Modifier	Constructor	Description
	CmsJsonHandlerContext(CmsObject cms, CmsObject rootCms, String path, CmsResource resource, Map<String,String> params, CmsParameterConfiguration handlerConfig, CmsJsonAccessPolicy policy)	Creates a new instance.

Uses of CmsParameterConfiguration in org.opencms.xml.xml2json.renderer

Methods in org.opencms.xml.xml2json.renderer that return CmsParameterConfiguration

Modifier and Type	Method	Description
CmsParameterConfiguration	CmsJsonRendererXmlContent.getConfiguration()