|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.file.types.A_CmsResourceType
org.opencms.file.types.A_CmsResourceTypeLinkParseable
org.opencms.file.types.CmsResourceTypeXmlContent
public class CmsResourceTypeXmlContent
Resource type descriptor for the type "xmlcontent".
Field Summary | |
---|---|
static java.lang.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(java.lang.String paramName,
java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance. |
CmsResource |
createResource(CmsObject cms,
CmsSecurityManager securityManager,
java.lang.String resourcename,
byte[] content,
java.util.List 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. |
java.util.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. |
java.util.List |
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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONFIGURATION_SCHEMA
Constructor Detail |
---|
public CmsResourceTypeXmlContent()
Method Detail |
---|
public void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
I_CmsConfigurationParameterHandler
addConfigurationParameter
in interface I_CmsConfigurationParameterHandler
addConfigurationParameter
in class A_CmsResourceType
paramName
- the name of the parameterparamValue
- the value for the parameterA_CmsResourceType.addConfigurationParameter(java.lang.String, java.lang.String)
public CmsResource createResource(CmsObject cms, CmsSecurityManager securityManager, java.lang.String resourcename, byte[] content, java.util.List properties) throws CmsException
I_CmsResourceType
createResource
in interface I_CmsResourceType
createResource
in class A_CmsResourceType
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresourcename
- the name of the resource to create (full path)content
- the content for the new resourceproperties
- the properties for the new resource
CmsException
- if something goes wrongI_CmsResourceType.createResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, java.lang.String, byte[], java.util.List)
public java.lang.String getCachePropertyDefault()
I_CmsResourceType
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.
getCachePropertyDefault
in interface I_CmsResourceType
getCachePropertyDefault
in class A_CmsResourceType
cache
property setting of this resource typeI_CmsResourceType.getCachePropertyDefault()
public java.util.Map getConfiguration()
I_CmsConfigurationParameterHandler
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.
getConfiguration
in interface I_CmsConfigurationParameterHandler
getConfiguration
in class A_CmsResourceType
null
A_CmsResourceType.getConfiguration()
public int getLoaderId()
I_CmsResourceType
getLoaderId
in interface I_CmsResourceType
getLoaderId
in class A_CmsResourceType
I_CmsResourceType.getLoaderId()
public java.util.List parseLinks(CmsObject cms, CmsFile file)
I_CmsLinkParseable
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.).
cms
- the current user's contextfile
- the file to be parsed
CmsLink
objects with the URIs of all linked resourcesI_CmsLinkParseable.parseLinks(org.opencms.file.CmsObject, org.opencms.file.CmsFile)
public CmsFile writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) throws CmsException
I_CmsResourceType
Applies only to resources of type
that have a binary content attached.CmsFile
writeFile
in interface I_CmsResourceType
writeFile
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to apply this operation to
CmsException
- if something goes wrongI_CmsResourceType.writeFile(org.opencms.file.CmsObject, CmsSecurityManager, CmsFile)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |