Package org.opencms.file.types

Class CmsResourceTypeXmlPage

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.A_CmsResourceTypeLinkParseable

org.opencms.file.types.CmsResourceTypeXmlPage

All Implemented Interfaces:

java.io.Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType, I_CmsLinkParseable

public class CmsResourceTypeXmlPage
extends A_CmsResourceTypeLinkParseable

Resource type descriptor for the type "xmlpage".

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
CmsResourceTypeXmlPage()	Default constructor, used to initialize member variables.

Method Summary

Modifier and Type	Method	Description
CmsResource	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.
java.lang.String	getCachePropertyDefault()	Returns the default for the cache property setting of this resource type.
int	getLoaderId()	Returns the loader type id of this resource type.
static int	getStaticTypeId()	Returns the static type id of this (default) resource type.
static java.lang.String	getStaticTypeName()	Returns the static type name of this (default) resource type.
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.
static boolean	isXmlPage(CmsResource resource)	Returns true in case the given resource is an XML page.
java.util.List<CmsLink>	parseLinks(CmsObject cms, CmsFile file)	Returns a list of all links from the specified file.
CmsFile	writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)	Writes a resource, including it's content.

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

isDirectEditable

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsResourceTypeXmlPage

public CmsResourceTypeXmlPage()

Default constructor, used to initialize member variables.

Method Detail

getStaticTypeId

public static int getStaticTypeId()

Returns the static type id of this (default) resource type.

Returns:

the static type id of this (default) resource type

getStaticTypeName

public static java.lang.String getStaticTypeName()

Returns the static type name of this (default) resource type.

Returns:

the static type name of this (default) resource type

isXmlPage

public static boolean isXmlPage(CmsResource resource)

Returns true in case the given resource is an XML page.

Internally this checks if the type id for the given resource is identical type id of the XML page.

Parameters:

resource - the resource to check

Returns:

true in case the given resource is an XML page

Since:

7.0.2

createResource

public CmsResource createResource(CmsObject cms,
                                  CmsSecurityManager securityManager,
                                  java.lang.String resourcename,
                                  byte[] content,
                                  java.util.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 interface I_CmsResourceType

Overrides:

createResource in class A_CmsResourceType

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resourcename - the name of the resource to create (full path)

content - the content for the new resource

properties - the properties for the new resource

Returns:

the created resource

Throws:

CmsException - if something goes wrong

See Also:

A_CmsResourceType.createResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, java.lang.String, byte[], java.util.List)

getCachePropertyDefault

public java.lang.String getCachePropertyDefault()

Description copied from interface: I_CmsResourceType

Returns the default for the cache 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 interface I_CmsResourceType

Overrides:

getCachePropertyDefault in class A_CmsResourceType

Returns:

the default for the cache property setting of this resource type

See Also:

I_CmsResourceType.getCachePropertyDefault()

getLoaderId

public int getLoaderId()

Description copied from interface: I_CmsResourceType

Returns the loader type id of this resource type.

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)

parseLinks

public java.util.List<CmsLink> parseLinks(CmsObject cms,
                                          CmsFile file)

Description copied from interface: I_CmsLinkParseable

Returns a list of all links from the specified file.

Implementations of this method must return an empty list, or better Collections.EMPTY_LIST, if no link is found at all.

Implementations of this method should return the list of links including internal (OpenCms VFS) and external links (http, https, mailto, ftp, etc.).

Parameters:

cms - the current user's context

file - the file to be parsed

Returns:

a list of CmsLink objects with the URIs of all linked resources

See Also:

I_CmsLinkParseable.parseLinks(org.opencms.file.CmsObject, org.opencms.file.CmsFile)

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 CmsFile that have a binary content attached.

Specified by:

writeFile in interface I_CmsResourceType

Overrides:

writeFile in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to apply this operation to

Returns:

the written resource

Throws:

CmsException - if something goes wrong

See Also:

I_CmsResourceType.writeFile(org.opencms.file.CmsObject, CmsSecurityManager, CmsFile)