|
|||||||
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.CmsResourceTypeXmlPage
Resource type descriptor for the type "xmlpage".
Field Summary |
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 | |
CmsResourceTypeXmlPage()
Default constructor, used to initialize member variables. |
Method Summary | |
java.util.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. |
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. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsResourceTypeXmlPage()
Method Detail |
public static int getStaticTypeId()
public static java.lang.String getStaticTypeName()
public java.util.List findLinks(CmsObject cms, CmsResource resource)
I_CmsXmlDocumentLinkValidatable
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.
findLinks
in interface I_CmsXmlDocumentLinkValidatable
cms
- the current user's Cms objectresource
- a CmsResource with links
I_CmsXmlDocumentLinkValidatable.findLinks(org.opencms.file.CmsObject, org.opencms.file.CmsResource)
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
I_CmsResourceType.getCachePropertyDefault()
public int getLoaderId()
I_CmsResourceType
getLoaderId
in interface I_CmsResourceType
getLoaderId
in class A_CmsResourceType
I_CmsResourceType.getLoaderId()
public void initConfiguration(java.lang.String name, java.lang.String id, java.lang.String className) throws CmsConfigurationException
I_CmsResourceType
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 (
).
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 I_CmsResourceType
is used for the resource type instance.CmsResourceTypeUnknown
initConfiguration
in interface I_CmsResourceType
initConfiguration
in class A_CmsResourceType
CmsConfigurationException
A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)
public boolean isDirectEditable()
I_CmsResourceType
true
if this resource type is direct editable.
isDirectEditable
in interface I_CmsResourceType
isDirectEditable
in class A_CmsResourceType
I_CmsResourceType.isDirectEditable()
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
CmsException
I_CmsResourceType.writeFile(org.opencms.file.CmsObject, CmsSecurityManager, CmsFile)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |