org.opencms.file.types
Class CmsResourceTypeXmlPage

java.lang.Object
  org.opencms.file.types.A_CmsResourceType
      org.opencms.file.types.CmsResourceTypeXmlPage

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsResourceType, I_CmsXmlDocumentLinkValidatable

public class CmsResourceTypeXmlPage

extends A_CmsResourceType

implements I_CmsXmlDocumentLinkValidatable

Resource type descriptor for the type "xmlpage".

Since:

6.0.0

Version:

$Revision: 1.21 $

Author:

Alexander Kandzior

Field Summary

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

m_addititionalModuleResourceType, m_copyResources, m_defaultProperties, m_frozen, m_mappings, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH

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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsResourceTypeXmlPage()
Default constructor, used to initialize member variables.

Method Summary

List	findLinks(CmsObject cms, CmsResource resource) Returns a list with the Cms URIs of all linked resources (either via href attribs or img tags) in the (body) content of the specified Cms resource.
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 String	getStaticTypeName() Returns the static type name of this (default) resource type.
void	initConfiguration(String name, String id) Special version of the configuration initialization used to also set resource type and id.
boolean	isDirectEditable() Returns true if this resource type is direct editable.
CmsFile	writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.

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

addConfigurationParameter, addCopyResource, addDefaultProperty, addMappingType, changeLastModifiedProjectId, changeLock, chflags, chtype, copyResource, copyResourceToProject, createResource, createSibling, deleteResource, getConfiguration, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getMacroResolver, getResourceType, getTypeId, getTypeName, importResource, initConfiguration, initialize, isAdditionalModuleResourceType, isFolder, lockResource, moveResource, processCopyResources, processDefaultProperties, replaceResource, restoreResourceBackup, setAdditionalModuleResourceType, toString, touch, undoChanges, unlockResource, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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 String getStaticTypeName()

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

Returns:

the static type name of this (default) resource type

findLinks

public List findLinks(CmsObject cms,
                      CmsResource resource)

Description copied from interface: I_CmsXmlDocumentLinkValidatable

Returns a list with the Cms URIs of all linked resources (either via href attribs or img tags) in the (body) content of the specified Cms resource.

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

Second, implementations of this method are responsible to filter out any "external" URLs pointing to targets outside the OpenCms VFS (http, https, mailto, ftp etc.) from the result list.

Specified by:

findLinks in interface I_CmsXmlDocumentLinkValidatable

Parameters:

cms - the current user's Cms object

resource - a CmsResource with links

Returns:

a list with the URIs of all linked resources (either via href attribs or img tags)

See Also:

I_CmsXmlDocumentLinkValidatable.findLinks(org.opencms.file.CmsObject, org.opencms.file.CmsResource)

getCachePropertyDefault

public 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

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

See Also:

I_CmsResourceType.getLoaderId()

initConfiguration

public void initConfiguration(String name,
                              String id)
                       throws CmsConfigurationException

Description copied from class: A_CmsResourceType

Special version of the configuration initialization used to also set resource type and id.

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.

Overrides:

initConfiguration in class A_CmsResourceType

Parameters:

name - the resource type name

id - the resource type id

Throws:

CmsConfigurationException - if something goes wrong

See Also:

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

isDirectEditable

public boolean isDirectEditable()

Description copied from interface: I_CmsResourceType

Returns true if this resource type is direct editable.

Specified by:

isDirectEditable in interface I_CmsResourceType

Overrides:

isDirectEditable in class A_CmsResourceType

See Also:

I_CmsResourceType.isDirectEditable()

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

Specified by:

writeFile in interface I_CmsResourceType

Overrides:

writeFile in class A_CmsResourceType

Throws:

CmsException

See Also:

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