Class A_CmsResourceType
- All Implemented Interfaces:
Serializable
,I_CmsConfigurationParameterHandler
,I_CmsResourceType
- Direct Known Subclasses:
A_CmsResourceTypeFolderBase
,A_CmsResourceTypeLinkParseable
,CmsResourceTypeBinary
,CmsResourceTypeImage
,CmsResourceTypePlain
,CmsResourceTypePointer
,CmsResourceTypeUnknown
,CmsResourceTypeUnknownFile
- Since:
- 6.0.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType
I_CmsResourceType.Formatter
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Configuration key for optional javascript in galleries.static final String
Configuration key for optional preview provider in galleries.static final String
Configuration key for the optional folder class name.static final String
Configuration key for the (optional) internal flag.static final String
The default gallery preview provider.protected boolean
Flag for showing that this is an additional resource type which is defined in a module.protected String
The configured class name of this resource type.protected CmsParameterConfiguration
Configuration parameters.protected List<CmsConfigurationCopyResource>
The list of resources to copy.protected List<CmsProperty>
The list of configured default properties.protected boolean
Indicates that the configuration of the resource type has been frozen.protected String
The gallery preview provider.Contains the file extensions mapped to this resource type.protected String
The module name if this is an additional resource type which is defined in a module.protected int
The configured id of this resource type.protected String
The configured name of this resource type.static final String
Macro for the folder path of the current resource.static final String
Macro for the folder path of the current resource, with touch enabled for the copied resources.static final String
Macro for the name of the current resource.static final String
Macro for the parent folder path of the current resource.static final String
Macro for the root path of the current resource.static final String
Macro for the site path of the current resource.Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
Fields inherited from interface org.opencms.file.types.I_CmsResourceType
ADD_MAPPING_METHOD, ADD_RESOURCE_TYPE_METHOD, CONFIGURATION_PROPERTY_CREATE, CONFIGURATION_RESOURCE_TYPE_ID, CONFIGURATION_RESOURCE_TYPE_NAME, PROPERTY_ON_RESOURCE, PROPERTY_ON_STRUCTURE
-
Constructor Summary
ConstructorDescriptionDefault constructor, used to initialize some member variables. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addConfigurationParameter
(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.void
addCopyResource
(String source, String target, String type) Adds a new "copy resource" to this resource type, allowed only during the configuration phase.void
addDefaultProperty
(CmsProperty property) Adds a default property to this resource type, allowed only during the configuration phase.void
addMappingType
(String mapping) Maps a file extension to a resource type.void
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
chflags
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags) Changes the resource flags of a resource.void
chtype
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) Deprecated.void
chtype
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type) Changes the resource type of a resource.void
copyResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode) Copies a resource.void
copyResourceToProject
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Copies a resource to the current project of the user.protected CmsResource
createRelations
(CmsObject cms, CmsSecurityManager securityManager, String resourceName, boolean updateSiblingState) Creates the relation information for the resource with the given resource name.createResource
(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties) Creates a new resource of the given resource type with the provided content and properties.createSibling
(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties) Creates a new sibling of the source resource.void
deleteResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode) Deletes a resource given its name.boolean
Returnstrue
, if this resource type is equal to the given Object.Gets the folder for which the links should be adjusted after processing the copy resources.Returns the default for thecache
property setting of this resource type.Returns the configured class name of this resource type.Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.Returns the (unmodifiable) list of copy resources.Returns the default properties for this resource type in an unmodifiable List.Returns the file extensions mappings for this resource type in an unmodifiable List.protected List<CmsConfigurationCopyResource>
getCopyResources
(CmsObject cms, String resourcename, CmsMacroResolver resolver) Gets the actual copy resources to use when creating a resource.getFormattersForResource
(CmsObject cms, CmsResource res) Returns the formatter configuration for the given resource.Returns the gallery preview provider class name.Returns the gallery types for this resource type.abstract int
Returns the loader type id of this resource type.protected CmsMacroResolver
getMacroResolver
(CmsObject cms, String resourcename) Creates a macro resolver based on the current users OpenCms context and the provided resource name.Returns the module name if this is an additional resource type which is defined in a module, ornull
.protected I_CmsResourceType
getResourceType
(CmsResource resource) Convenience method to get the initialized resource type instance for the given resource, with a fall back to special "unknown" resource types in case the resource type is not configured.int
Deprecated.Use this class orgetTypeName()
instead.Returns the name of this resource type.int
hashCode()
The hash code implementation uses the type name to generate a hash code.importResource
(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties) Imports a resource to the OpenCms VFS.final void
Initializes a configuration after all parameters have been added.void
initConfiguration
(String name, String id, String className) Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.void
initialize
(CmsObject cms) Initializes this resource type.boolean
Indicates that this is an additional resource type which is defined in a module.boolean
Returnstrue
if this resource type is direct editable.boolean
isFolder()
Returnstrue
if this resource type is a folder.boolean
isIdentical
(I_CmsResourceType type) Tests if the given resource type definition is identical to this resource type definition.void
lockResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type) Locks a resource.void
moveResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination) Moves a resource to the given destination.protected void
processCopyResources
(CmsObject cms, String resourcename, CmsMacroResolver resolver) Processes the copy resources of this resource type.protected List<CmsProperty>
processDefaultProperties
(List<CmsProperty> properties, CmsMacroResolver resolver) Returns a list of property objects that are attached to the resource on creation.void
removeResourceFromProject
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Removes a resource from the current project of the user.void
replaceResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties) Deprecated.void
replaceResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, List<CmsProperty> properties) Replaces the content, type and properties of a resource.void
restoreResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version) Restores a resource in the current project with a version from the historical archive.void
setAdditionalModuleResourceType
(boolean additionalType) Sets the additional resource type flag.void
setAdjustLinksFolder
(String adjustLinksFolder) Sets the folder for adjusting links after copying the copy-resources.void
setDateExpired
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive) Changes the "expire" date of a resource.void
setDateLastModified
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive) Changes the "last modified" date of a resource.void
setDateReleased
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive) Changes the "release" date of a resource.void
setModuleName
(String moduleName) Sets the module name if this is an additional resource type which is defined in a module, ornull
.toString()
void
undelete
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive) Undeletes a resource.void
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
unlockResource
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Unlocks a resource.protected void
updateRelationForUndo
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Update the relations after an undo changes operation.writeFile
(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.void
writePropertyObject
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property) Writes a property for a specified resource.void
writePropertyObjects
(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, List<CmsProperty> properties) Writes a list of properties for a specified resource.
-
Field Details
-
CONFIGURATION_GALLERY_JAVASCRIPT_PATH
Configuration key for optional javascript in galleries.- See Also:
-
CONFIGURATION_GALLERY_PREVIEW_PROVIDER
Configuration key for optional preview provider in galleries.- See Also:
-
CONFIGURATION_GALLERY_TYPE_NAMES
Configuration key for the optional folder class name.- See Also:
-
CONFIGURATION_INTERNAL
Configuration key for the (optional) internal flag.- See Also:
-
DEFAULT_GALLERY_PREVIEW_PROVIDER
The default gallery preview provider.- See Also:
-
MACRO_RESOURCE_FOLDER_PATH
Macro for the folder path of the current resource.- See Also:
-
MACRO_RESOURCE_FOLDER_PATH_TOUCH
Macro for the folder path of the current resource, with touch enabled for the copied resources.- See Also:
-
MACRO_RESOURCE_NAME
Macro for the name of the current resource.- See Also:
-
MACRO_RESOURCE_PARENT_PATH
Macro for the parent folder path of the current resource.- See Also:
-
MACRO_RESOURCE_ROOT_PATH
Macro for the root path of the current resource.- See Also:
-
MACRO_RESOURCE_SITE_PATH
Macro for the site path of the current resource.- See Also:
-
m_addititionalModuleResourceType
Flag for showing that this is an additional resource type which is defined in a module. -
m_className
The configured class name of this resource type. -
m_configuration
Configuration parameters. -
m_copyResources
The list of resources to copy. -
m_defaultProperties
The list of configured default properties. -
m_frozen
Indicates that the configuration of the resource type has been frozen. -
m_galleryPreviewProvider
The gallery preview provider. -
m_mappings
Contains the file extensions mapped to this resource type. -
m_moduleName
The module name if this is an additional resource type which is defined in a module. -
m_typeId
The configured id of this resource type. -
m_typeName
The configured name of this resource type.
-
-
Constructor Details
-
A_CmsResourceType
public A_CmsResourceType()Default constructor, used to initialize some member variables.
-
-
Method Details
-
addConfigurationParameter
Description copied from interface:I_CmsConfigurationParameterHandler
Adds a configuration parameter to this parameter configurable class instance.- Specified by:
addConfigurationParameter
in interfaceI_CmsConfigurationParameterHandler
- Parameters:
paramName
- the name of the parameterparamValue
- the value for the parameter- See Also:
-
addCopyResource
public void addCopyResource(String source, String target, String type) throws CmsConfigurationException Adds a new "copy resource" to this resource type, allowed only during the configuration phase.The "copy resources" are copied to the specified location after a new resource of this type is created. Usually this feature is used to populate a newly created folder with some default resources.
If target is
null
, the macroMACRO_RESOURCE_FOLDER_PATH
is used as default. If type isnull
, the copy typeCmsResource.COPY_AS_NEW
is used as default.- Parameters:
source
- the source resourcetarget
- the target resource (may contain macros)type
- the type of the copy, for example "as new", "as sibling" etc- Throws:
CmsConfigurationException
- if the configuration is already frozen
-
addDefaultProperty
Adds a default property to this resource type, allowed only during the configuration phase.- Parameters:
property
- the default property to add- Throws:
CmsConfigurationException
- if the configuration is already frozen
-
addMappingType
Description copied from interface:I_CmsResourceType
Maps a file extension to a resource type.When uploading files into OpenCms, they must be mapped to the different OpenCms resource types. The configuration, to map which extension to which resouce type is done in the OpenCms VFS configuration.
- Specified by:
addMappingType
in interfaceI_CmsResourceType
- Parameters:
mapping
- the file extension mapped to the resource type- See Also:
-
changeLock
public void changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) throws CmsException Description copied from interface:I_CmsResourceType
Changes the lock of a resource to the current user, that is "steals" the lock from another user.- Specified by:
changeLock
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the name of the resource to change the lock with complete path- Throws:
CmsException
- if something goes wrong- See Also:
-
chflags
public void chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags) throws CmsException Description copied from interface:I_CmsResourceType
Changes the resource flags of a resource.The resource flags are used to indicate various "special" conditions for a resource. Most notably, the "internal only" setting which signals that a resource can not be directly requested with it's URL.
- Specified by:
chflags
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to change the flags forflags
- the new resource flags for this resource- Throws:
CmsException
- if something goes wrong- See Also:
-
chtype
public void chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type) throws CmsException Description copied from interface:I_CmsResourceType
Changes the resource type of a resource.OpenCms handles resources according to the resource type, not the file suffix. This is e.g. why a JSP in OpenCms can have the suffix ".html" instead of ".jsp" only. Changing the resource type makes sense e.g. if you want to make a plain text file a JSP resource, or a binary file an image, etc.
- Specified by:
chtype
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to change the type fortype
- the new resource type for this resource- Throws:
CmsException
- if something goes wrong- See Also:
-
chtype
@Deprecated public void chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) throws CmsException Deprecated.Usechtype(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.Description copied from interface:I_CmsResourceType
Changes the resource type of a resource.OpenCms handles resources according to the resource type, not the file suffix. This is e.g. why a JSP in OpenCms can have the suffix ".html" instead of ".jsp" only. Changing the resource type makes sense e.g. if you want to make a plain text file a JSP resource, or a binary file an image, etc.
- Specified by:
chtype
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to change the type fortype
- the new resource type for this resource- Throws:
CmsException
- if something goes wrong- See Also:
-
copyResource
public void copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, CmsResource.CmsResourceCopyMode siblingMode) throws CmsException Description copied from interface:I_CmsResourceType
Copies a resource.You must ensure that the destination path is an absolute, valid and existing VFS path. Relative paths from the source are currently not supported.
The copied resource will always be locked to the current user after the copy operation.
In case the target resource already exists, it is overwritten with the source resource.
The
siblingMode
parameter controls how to handle siblings during the copy operation.
Possible values for this parameter are:
- Specified by:
copyResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managersource
- the resource to copydestination
- the name of the copy destination with complete pathsiblingMode
- indicates how to handle siblings during copy- Throws:
CmsException
- if something goes wrong- See Also:
-
copyResourceToProject
public void copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) throws CmsException Description copied from interface:I_CmsResourceType
Copies a resource to the current project of the user.This is used to extend the current users project with the specified resource, in case that the resource is not yet part of the project. The resource is not really copied like in a regular copy operation, it is in fact only "enabled" in the current users project.
- Specified by:
copyResourceToProject
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to apply this operation to- Throws:
CmsException
- if something goes wrong- See Also:
-
createResource
public CmsResource createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> properties) throws CmsException Description copied from interface:I_CmsResourceType
Creates a new resource of the given resource type with the provided content and properties.- Specified by:
createResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresourcename
- the name of the resource to create (full path)content
- the content for the new resourceproperties
- the properties for the new resource- Returns:
- the created resource
- Throws:
CmsException
- if something goes wrong- See Also:
-
createSibling
public CmsResource createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List<CmsProperty> properties) throws CmsException Description copied from interface:I_CmsResourceType
Creates a new sibling of the source resource.- Specified by:
createSibling
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managersource
- the resource to create a sibling fordestination
- the name of the sibling to create with complete pathproperties
- the individual properties for the new sibling- Returns:
- the new created sibling
- Throws:
CmsException
- if something goes wrong- See Also:
-
deleteResource
public void deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode) throws CmsException Description copied from interface:I_CmsResourceType
Deletes a resource given its name.The
siblingMode
parameter controls how to handle siblings during the delete operation.
Possible values for this parameter are:
- Specified by:
deleteResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to deletesiblingMode
- indicates how to handle siblings of the deleted resource- Throws:
CmsException
- if something goes wrong- See Also:
-
equals
Returnstrue
, if this resource type is equal to the given Object.Please note: A resource type is identified by it's id
getTypeId()
and it's namegetTypeName()
. Two resource types are considered equal, if either their id or their name is equal. This is to prevent issues in the configuration with multiple occurrences of the same name or id. -
getAdjustLinksFolder
Description copied from interface:I_CmsResourceType
Gets the folder for which the links should be adjusted after processing the copy resources.- Specified by:
getAdjustLinksFolder
in interfaceI_CmsResourceType
- Returns:
- the path of the folder for which the links should be adjusted
- See Also:
-
getCachePropertyDefault
Description copied from interface:I_CmsResourceType
Returns the default for thecache
property setting of this resource type.The
cache
property is used by the Flex cache implementation to build the cache key that controls the caching behaviour of a resource.If
null
is returnd, this is the same as turning the cache off by default for this resource type.- Specified by:
getCachePropertyDefault
in interfaceI_CmsResourceType
- Returns:
- the default for the
cache
property setting of this resource type - See Also:
-
getClassName
Returns the configured class name of this resource type.- Specified by:
getClassName
in interfaceI_CmsResourceType
- Returns:
- the class name configured for this resource type
- See Also:
-
getConfiguration
Description copied from interface:I_CmsConfigurationParameterHandler
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.- Specified by:
getConfiguration
in interfaceI_CmsConfigurationParameterHandler
- Returns:
- the parameters of this configurable class instance,
or
null
if the class does not need any parameters - See Also:
-
getConfiguredCopyResources
Returns the (unmodifiable) list of copy resources.- Specified by:
getConfiguredCopyResources
in interfaceI_CmsResourceType
- Returns:
- the (unmodifiable) list of copy resources
-
getConfiguredDefaultProperties
Returns the default properties for this resource type in an unmodifiable List.- Specified by:
getConfiguredDefaultProperties
in interfaceI_CmsResourceType
- Returns:
- the default properties for this resource type in an unmodifiable List
-
getConfiguredMappings
Description copied from interface:I_CmsResourceType
Returns the file extensions mappings for this resource type in an unmodifiable List.- Specified by:
getConfiguredMappings
in interfaceI_CmsResourceType
- Returns:
- a list of file extensions mappings for this resource type in an unmodifiable List
- See Also:
-
getFormattersForResource
Description copied from interface:I_CmsResourceType
Returns the formatter configuration for the given resource.- Specified by:
getFormattersForResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextres
- the resource to get the formatter configuration for- Returns:
- the formatter configuration for the given resource
- See Also:
-
getGalleryPreviewProvider
Description copied from interface:I_CmsResourceType
Returns the gallery preview provider class name.- Specified by:
getGalleryPreviewProvider
in interfaceI_CmsResourceType
- Returns:
- the gallery preview provider class name
- See Also:
-
getGalleryTypes
Description copied from interface:I_CmsResourceType
Returns the gallery types for this resource type.- Specified by:
getGalleryTypes
in interfaceI_CmsResourceType
- Returns:
- the gallery types, if no gallery is configured
null
will be returned - See Also:
-
getLoaderId
Description copied from interface:I_CmsResourceType
Returns the loader type id of this resource type.- Specified by:
getLoaderId
in interfaceI_CmsResourceType
- Returns:
- the loader type id of this resource type
- See Also:
-
getModuleName
Description copied from interface:I_CmsResourceType
Returns the module name if this is an additional resource type which is defined in a module, ornull
.- Specified by:
getModuleName
in interfaceI_CmsResourceType
- Returns:
- the module name if this is an additional resource type which is defined in a module, or
null
- See Also:
-
getTypeId
Deprecated.Use this class orgetTypeName()
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.Description copied from interface:I_CmsResourceType
Returns the type id of this resource type.- Specified by:
getTypeId
in interfaceI_CmsResourceType
- Returns:
- the type id of this resource type
- See Also:
-
getTypeName
Description copied from interface:I_CmsResourceType
Returns the name of this resource type.- Specified by:
getTypeName
in interfaceI_CmsResourceType
- Returns:
- the name of this resource type
- See Also:
-
hashCode
The hash code implementation uses the type name to generate a hash code. -
importResource
public CmsResource importResource(CmsObject cms, CmsSecurityManager securityManager, I_CmsReport report, String resourcename, CmsResource resource, byte[] content, List<CmsProperty> properties) throws CmsException Description copied from interface:I_CmsResourceType
Imports a resource to the OpenCms VFS.If a resource already exists in the VFS (i.e. has the same name and same id) it is replaced by the imported resource.
If a resource with the same name but a different id exists, the imported resource is (usually) moved to the "lost and found" folder.
- Specified by:
importResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerreport
- optional report to write non-critical import problems toresourcename
- the target name (with full path) for the resource after importresource
- the resource to be importedcontent
- the content of the resourceproperties
- the properties of the resource- Returns:
- the imported resource
- Throws:
CmsException
- if something goes wrong- See Also:
-
initConfiguration
Description copied from interface:I_CmsConfigurationParameterHandler
Initializes a configuration after all parameters have been added.- Specified by:
initConfiguration
in interfaceI_CmsConfigurationParameterHandler
- See Also:
-
initConfiguration
public void initConfiguration(String name, String id, String className) throws CmsConfigurationException Description copied from interface:I_CmsResourceType
Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.Please note: Many resource types defined in the core have in fact a fixed resource type and a fixed id. Configurable name and id is used only for certain types.
The provided named class must implement this interface (
). Usually the provided class name should be the class name of the resource type instance, but this may be different in special cases or configuration errors. For example, if a module is imported that contains it's own resource type class files, the included class file are usually not be available until the server is restarted. If the named class given in the XML configuration (or module manifest.xml) is not available, or not implementingI_CmsResourceType
, thenI_CmsResourceType
is used for the resource type instance.CmsResourceTypeUnknown
- Specified by:
initConfiguration
in interfaceI_CmsResourceType
- Parameters:
name
- the resource type nameid
- the resource type idclassName
- the class name of the resource type (read from the XML configuration)- Throws:
CmsConfigurationException
- if the configuration is invalid- See Also:
-
initialize
Description copied from interface:I_CmsResourceType
Initializes this resource type.This method will be called once during the OpenCms initialization processs. The VFS will already be available at the time the method is called.
- Specified by:
initialize
in interfaceI_CmsResourceType
- Parameters:
cms
- a OpenCms context initialized with "Admin" permissions- See Also:
-
isAdditionalModuleResourceType
Description copied from interface:I_CmsResourceType
Indicates that this is an additional resource type which is defined in a module.- Specified by:
isAdditionalModuleResourceType
in interfaceI_CmsResourceType
- Returns:
- true or false
- See Also:
-
isDirectEditable
Description copied from interface:I_CmsResourceType
Returnstrue
if this resource type is direct editable.- Specified by:
isDirectEditable
in interfaceI_CmsResourceType
- Returns:
true
if this resource type is direct editable- See Also:
-
isFolder
Description copied from interface:I_CmsResourceType
Returnstrue
if this resource type is a folder.- Specified by:
isFolder
in interfaceI_CmsResourceType
- Returns:
true
if this resource type is a folder- See Also:
-
isIdentical
Description copied from interface:I_CmsResourceType
Tests if the given resource type definition is identical to this resource type definition.Two resource types are considered identical if their names
I_CmsResourceType.getTypeName()
and their idsI_CmsResourceType.getTypeId()
are both the same.Please note: Two resource type are considered equal in the sense of
Object.equals(Object)
if either if their namesI_CmsResourceType.getTypeName()
or their idsI_CmsResourceType.getTypeId()
are equal.- Specified by:
isIdentical
in interfaceI_CmsResourceType
- Parameters:
type
- another resource type- Returns:
- true, if the specified resource type is identical to this resource type
- See Also:
-
lockResource
public void lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsLockType type) throws CmsException Description copied from interface:I_CmsResourceType
Locks a resource.The
type
parameter controls what kind of lock is used.
Possible values for this parameter are:
- Specified by:
lockResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to locktype
- type of the lock- Throws:
CmsException
- if something goes wrong- See Also:
-
moveResource
public void moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, String destination) throws CmsException, CmsIllegalArgumentException Description copied from interface:I_CmsResourceType
Moves a resource to the given destination.A move operation in OpenCms is always a copy (as sibling) followed by a delete, this is a result of the online/offline structure of the OpenCms VFS. This way you can see the deleted files/folders in the offline project, and you will be unable to undelete them.
- Specified by:
moveResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to movedestination
- the destination resource name- Throws:
CmsException
- if something goes wrongCmsIllegalArgumentException
- if thesource
argument is null or of length 0- See Also:
-
removeResourceFromProject
public void removeResourceFromProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) throws CmsException Description copied from interface:I_CmsResourceType
Removes a resource from the current project of the user.This is used to reduce the current users project with the specified resource, in case that the resource is already part of the project. The resource is not really removed like in a regular copy operation, it is in fact only "disabled" in the current users project.
- Specified by:
removeResourceFromProject
in interfaceI_CmsResourceType
- Parameters:
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to apply this operation to- Throws:
CmsException
- if something goes wrong- See Also:
-
replaceResource
public void replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, I_CmsResourceType type, byte[] content, List<CmsProperty> properties) throws CmsException Description copied from interface:I_CmsResourceType
Replaces the content, type and properties of a resource.- Specified by:
replaceResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the name of the resource to replacetype
- the new type of the resourcecontent
- the new content of the resourceproperties
- the new properties of the resource- Throws:
CmsException
- if something goes wrong- See Also:
-
replaceResource
@Deprecated public void replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties) throws CmsException Deprecated.UsereplaceResource(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.Description copied from interface:I_CmsResourceType
Replaces the content, type and properties of a resource.- Specified by:
replaceResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the name of the resource to replacetype
- the new type of the resourcecontent
- the new content of the resourceproperties
- the new properties of the resource- Throws:
CmsException
- if something goes wrong- See Also:
-
restoreResource
public void restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version) throws CmsException Description copied from interface:I_CmsResourceType
Restores a resource in the current project with a version from the historical archive.- Specified by:
restoreResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to restore from the archiveversion
- the version number of the resource to restore- Throws:
CmsException
- if something goes wrong- See Also:
-
setAdditionalModuleResourceType
Description copied from interface:I_CmsResourceType
Sets the additional resource type flag.- Specified by:
setAdditionalModuleResourceType
in interfaceI_CmsResourceType
- Parameters:
additionalType
- true or false- See Also:
-
setAdjustLinksFolder
Description copied from interface:I_CmsResourceType
Sets the folder for adjusting links after copying the copy-resources.- Specified by:
setAdjustLinksFolder
in interfaceI_CmsResourceType
- Parameters:
adjustLinksFolder
- the folder for which links should be adjusted- See Also:
-
setDateExpired
public void setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive) throws CmsException Description copied from interface:I_CmsResourceType
Changes the "expire" date of a resource.- Specified by:
setDateExpired
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateExpired
- the new expire date of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder- Throws:
CmsException
- if something goes wrong- See Also:
-
setDateLastModified
public void setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive) throws CmsException Description copied from interface:I_CmsResourceType
Changes the "last modified" date of a resource.- Specified by:
setDateLastModified
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateLastModified
- timestamp the new timestamp of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder- Throws:
CmsException
- if something goes wrong- See Also:
-
setDateReleased
public void setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive) throws CmsException Description copied from interface:I_CmsResourceType
Changes the "release" date of a resource.- Specified by:
setDateReleased
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateReleased
- the new release date of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder- Throws:
CmsException
- if something goes wrong- See Also:
-
setModuleName
Description copied from interface:I_CmsResourceType
Sets the module name if this is an additional resource type which is defined in a module, ornull
.- Specified by:
setModuleName
in interfaceI_CmsResourceType
- Parameters:
moduleName
- the module name if this is an additional resource type which is defined in a module, ornull
- See Also:
-
toString
-
undelete
public void undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive) throws CmsException Description copied from interface:I_CmsResourceType
Undeletes a resource.Only resources that have already been published once can be undeleted, if a "new" resource is deleted it can not be undeleted.
- Specified by:
undelete
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to undeleterecursive
- if this operation is to be applied recursively to all resources in a folder- Throws:
CmsException
- if something goes wrong- See Also:
-
undoChanges
public void undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode) throws CmsException Description copied from interface:I_CmsResourceType
Undos all changes in the resource by restoring the version from the online project to the current offline project.- Specified by:
undoChanges
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to undo the changes formode
- the undo mode, one of the
constantsCmsResource.CmsResourceUndoMode
#UNDO_XXX- Throws:
CmsException
- if something goes wrong- See Also:
-
unlockResource
public void unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) throws CmsException Description copied from interface:I_CmsResourceType
Unlocks a resource.- Specified by:
unlockResource
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to unlock- Throws:
CmsException
- if something goes wrong- See Also:
-
writeFile
public CmsFile writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) throws CmsException Description copied from interface:I_CmsResourceType
Writes a resource, including it's content.Applies only to resources of type
that have a binary content attached.CmsFile
- Specified by:
writeFile
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to apply this operation to- Returns:
- the written resource
- Throws:
CmsException
- if something goes wrong- See Also:
-
writePropertyObject
public void writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property) throws CmsException Description copied from interface:I_CmsResourceType
Writes a property for a specified resource.- Specified by:
writePropertyObject
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to write the property forproperty
- the property to write- Throws:
CmsException
- if something goes wrong- See Also:
-
writePropertyObjects
public void writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, List<CmsProperty> properties) throws CmsException Description copied from interface:I_CmsResourceType
Writes a list of properties for a specified resource.Code calling this method has to ensure that the no properties
a, b
are contained in the specified list so thata.equals(b)
, otherwise an exception is thrown.- Specified by:
writePropertyObjects
in interfaceI_CmsResourceType
- Parameters:
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to write the properties forproperties
- the list of properties to write- Throws:
CmsException
- if something goes wrong- See Also:
-
createRelations
protected CmsResource createRelations(CmsObject cms, CmsSecurityManager securityManager, String resourceName, boolean updateSiblingState) throws CmsException Creates the relation information for the resource with the given resource name.- Parameters:
cms
- the cms contextsecurityManager
- the security managerresourceName
- the resource name of the resource to update the relations forupdateSiblingState
- if true, sets the state of siblings with changed relations to 'changed' (unless they are new or deleted)- Returns:
- the fresh read resource
- Throws:
CmsException
- if something goes wrong
-
getCopyResources
protected List<CmsConfigurationCopyResource> getCopyResources(CmsObject cms, String resourcename, CmsMacroResolver resolver) Gets the actual copy resources to use when creating a resource.- Parameters:
cms
- the CMS contextresourcename
- the path of the resource to createresolver
- the macro resolver to use- Returns:
- the copy resources to use
-
getMacroResolver
Creates a macro resolver based on the current users OpenCms context and the provided resource name.- Parameters:
cms
- the current OpenCms user contextresourcename
- the resource name for macros likeMACRO_RESOURCE_FOLDER_PATH
- Returns:
- a macro resolver based on the current users OpenCms context and the provided resource name
-
getResourceType
Convenience method to get the initialized resource type instance for the given resource, with a fall back to special "unknown" resource types in case the resource type is not configured.- Parameters:
resource
- the resource to get the type for- Returns:
- the initialized resource type instance for the given resource
- See Also:
-
processCopyResources
Processes the copy resources of this resource type.- Parameters:
cms
- the current OpenCms user contextresourcename
- the name of the base resourceresolver
- the resolver used for resolving target macro names
-
processDefaultProperties
protected List<CmsProperty> processDefaultProperties(List<CmsProperty> properties, CmsMacroResolver resolver) Returns a list of property objects that are attached to the resource on creation.It's possible to use OpenCms macros for the property values. Please see
CmsMacroResolver
for allowed macro values.- Parameters:
properties
- the (optional) properties provided by the userresolver
- the resolver used to resolve the macro values- Returns:
- a list of property objects that are attached to the resource on creation
-
updateRelationForUndo
protected void updateRelationForUndo(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) throws CmsException Update the relations after an undo changes operation.- Parameters:
cms
- the cms contextsecurityManager
- the security managerresource
- the resource that has been undone- Throws:
CmsException
- if something goes wrong
-
chtype(CmsObject, CmsSecurityManager, CmsResource, I_CmsResourceType)
instead.