org.opencms.file.types
Class CmsResourceTypeXmlContent

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

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeXmlContent
extends A_CmsResourceType

Resource type descriptor for the type "xmlcontent".

Since:

6.0.0

Version:

$Revision: 1.22 $

Author:

Alexander Kandzior

Field Summary

static String

CONFIGURATION_SCHEMA Configuration key for the (optional) schema.

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

m_addititionalModuleResourceType, m_className, 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

CmsResourceTypeXmlContent()

Method Summary

void	addConfigurationParameter(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.
CmsResource	createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List properties) Creates a new resource of the given resource type with the provided content and properties.
String	getCachePropertyDefault() Returns the default for the cache property setting of this resource type.
Map	getConfiguration() Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
int	getLoaderId() Returns the loader type id of this resource type.
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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONFIGURATION_SCHEMA

public static final String CONFIGURATION_SCHEMA

Configuration key for the (optional) schema.

See Also:

Constant Field Values

Constructor Detail

CmsResourceTypeXmlContent

public CmsResourceTypeXmlContent()

Method Detail

addConfigurationParameter

public void addConfigurationParameter(String paramName,
                                      String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Overrides:

addConfigurationParameter in class A_CmsResourceType

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

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

createResource

public CmsResource createResource(CmsObject cms,
                                  CmsSecurityManager securityManager,
                                  String resourcename,
                                  byte[] content,
                                  List 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:

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

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

Returns:

the default for the cache property setting of this resource type

See Also:

I_CmsResourceType.getCachePropertyDefault()

getConfiguration

public Map getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.

All elements in the configuration are key, value String pairs, set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method during initialization of the loader.

Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Overrides:

getConfiguration in class A_CmsResourceType

Returns:

the configuration of this resource loader, or null

See Also:

A_CmsResourceType.getConfiguration()

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()

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

Returns:

true if this resource type is direct editable

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 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)