|
|||||||
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.CmsResourceTypeJsp
Resource type descriptor for the type "jsp".
Ensures that some required file properties are attached to new JSPs.
The value for the encoding properties of a new JSP usually is the
system default encoding, but this can be overwritten by
a configuration parameters set in opencms-vfs.xml
.
Field Summary |
Fields inherited from class org.opencms.file.types.A_CmsResourceType |
CONFIGURATION_INTERNAL, 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 | |
CmsResourceTypeJsp()
Default constructor, used to initialize member variables. |
Method Summary | |
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. |
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 |
Constructor Detail |
public CmsResourceTypeJsp()
Method Detail |
public static int getStaticTypeId()
public static java.lang.String getStaticTypeName()
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 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
CmsException
A_CmsResourceType.writeFile(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsFile)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |