Package org.opencms.file.types

Class CmsResourceTypeUnknown

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.CmsResourceTypeUnknown

All Implemented Interfaces:

java.io.Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeUnknown
extends A_CmsResourceType

Resource type descriptor used in case the given resource type class in the XML configuration could not be instantiated.

Using this class usually indicates that the class name given in the XML configuration is unavailable. This can be the case if a module with a new resource type is imported, where the resource type class comes as part of the module and OpenCms must be restarted after the module import.

Since:

6.0.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType

I_CmsResourceType.Formatter

Field Summary

Fields inherited from class org.opencms.file.types.A_CmsResourceType

CONFIGURATION_GALLERY_JAVASCRIPT_PATH, CONFIGURATION_GALLERY_PREVIEW_PROVIDER, CONFIGURATION_GALLERY_TYPE_NAMES, CONFIGURATION_INTERNAL, DEFAULT_GALLERY_PREVIEW_PROVIDER, m_addititionalModuleResourceType, m_className, m_configuration, m_copyResources, m_defaultProperties, m_frozen, m_galleryPreviewProvider, m_mappings, m_moduleName, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_FOLDER_PATH_TOUCH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH

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

Constructors

Constructor	Description
CmsResourceTypeUnknown()	Default constructor, used to initialize member variables.

Method Summary

Modifier and Type	Method	Description
int	getLoaderId()	Unknown resource types are always loaded with the CmsDumpLoader.
void	initConfiguration(java.lang.String name, java.lang.String id, java.lang.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.

Methods inherited from class org.opencms.file.types.A_CmsResourceType

addConfigurationParameter, addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, chtype, chtype, copyResource, copyResourceToProject, createRelations, createResource, createSibling, deleteResource, equals, getAdjustLinksFolder, getCachePropertyDefault, getClassName, getConfiguration, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getCopyResources, getFormattersForResource, getGalleryPreviewProvider, getGalleryTypes, getMacroResolver, getModuleName, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isFolder, isIdentical, lockResource, moveResource, processCopyResources, processDefaultProperties, removeResourceFromProject, replaceResource, replaceResource, restoreResource, setAdditionalModuleResourceType, setAdjustLinksFolder, setDateExpired, setDateLastModified, setDateReleased, setModuleName, toString, undelete, undoChanges, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CmsResourceTypeUnknown

public CmsResourceTypeUnknown()

Default constructor, used to initialize member variables.

Method Detail

getLoaderId

public int getLoaderId()

Unknown resource types are always loaded with the CmsDumpLoader.

Specified by:

getLoaderId in interface I_CmsResourceType

Specified by:

getLoaderId in class A_CmsResourceType

Returns:

the loader type id of this resource type

See Also:

I_CmsResourceType.getLoaderId()

initConfiguration

public void initConfiguration(java.lang.String name,
                              java.lang.String id,
                              java.lang.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 (I_CmsResourceType). 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 implementing I_CmsResourceType, then CmsResourceTypeUnknown is used for the resource type instance.

Specified by:

initConfiguration in interface I_CmsResourceType

Overrides:

initConfiguration in class A_CmsResourceType

Parameters:

name - the resource type name

id - the resource type id

className - the class name of the resource type (read from the XML configuration)

Throws:

CmsConfigurationException - if the configuration is invalid

See Also:

A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)