Package org.opencms.file.types

Class CmsResourceTypeFunctionConfig

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.A_CmsResourceTypeLinkParseable

org.opencms.file.types.CmsResourceTypeXmlContent

org.opencms.file.types.CmsResourceTypeXmlAdeConfiguration

org.opencms.file.types.CmsResourceTypeFunctionConfig

All Implemented Interfaces:

Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType, I_CmsLinkParseable

public class CmsResourceTypeFunctionConfig
extends CmsResourceTypeXmlAdeConfiguration

Resource type class for the second version of dynamic functions.

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

Modifier and Type	Field	Description
static final String	FORMATTER_PATH	The path of the JSP used for rendering v2 functions.
static final String	TYPE_NAME	The type name.

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

ATTR_REVERSE_AVAILABILITY_MAPPING, CONFIGURATION_SCHEMA, DIALOG_CHOOSEMODEL, RESOURCE_TYPE_NAME

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

Method Summary

Modifier and Type	Method	Description
String	getCachePropertyDefault()	Returns the default for the cache property setting of this resource type.
static String	getStaticTypeName()	Returns the static type name of this (default) resource type.
static boolean	isFunction(CmsResource res)	Checks if a resource has this type.
CmsFile	writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource)	Writes a resource, including it's content.

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

getLocaleForNewContent

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

addConfigurationParameter, createResource, deleteResource, getConfiguration, getEditHandler, getFormattersForResource, getGalleryPreviewProvider, getLoaderId, getModelFiles, getSchema, getXsdLink, initialize, isPossiblyDetailContent, isXmlContent, moveResource, parseLinks, setDateExpired, setDateReleased

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

isDirectEditable

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

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

Methods inherited from class java.lang.Object

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

Field Details

FORMATTER_PATH

public static final String FORMATTER_PATH

The path of the JSP used for rendering v2 functions.

See Also:

• Constant Field Values

TYPE_NAME

public static final String TYPE_NAME

The type name.

See Also:

• Constant Field Values

Constructor Details

CmsResourceTypeFunctionConfig

public CmsResourceTypeFunctionConfig()

Method Details

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

isFunction

public static boolean isFunction(CmsResource res)

Checks if a resource has this type.

Parameters:

res - the resource to check

Returns:

true if the resource is a V2 dynamic function

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 CmsResourceTypeXmlContent

Returns:

the default for the cache property setting of this resource type

See Also:

• CmsResourceTypeXmlContent.getCachePropertyDefault()

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 CmsResourceTypeXmlContent

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:

• After writing the file, this method waits until the formatter configuration is update the next time.