|
||||||
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
public class 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 | |
---|---|
protected CmsJspLoader |
m_jspLoader
JSP Loader instance. |
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_FOLDER_PATH_TOUCH, 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 | |
---|---|
void |
chtype(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
int type)
Changes the resource type of a resource. |
void |
deleteResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
CmsResource.CmsResourceDeleteMode siblingMode)
Deletes a resource given its name. |
int |
getLoaderId()
Returns the loader type id of this resource type. |
protected java.util.Set |
getReferencingStrongLinks(CmsObject cms,
CmsResource resource)
Returns a set of root paths of files that are including the given resource using the 'link.strong' macro. |
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. |
void |
initialize(CmsObject cms)
Initializes this resource type. |
void |
moveResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
java.lang.String destination)
Moves a resource to the given destination. |
java.util.List |
parseLinks(CmsObject cms,
CmsFile file)
Returns a list of all links from the specified file. |
protected void |
removeReferencingFromCache(java.util.Set references)
Removes the referencing resources from the cache. |
void |
replaceResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
int type,
byte[] content,
java.util.List properties)
Replaces the content, type and properties of a resource. |
void |
restoreResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
int version)
Restores a resource in the current project with a version from the historical archive. |
void |
setDateExpired(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
long dateExpired,
boolean recursive)
Changes the "expire" date of a resource. |
void |
setDateLastModified(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
long dateLastModified,
boolean recursive)
Changes the "last modified" date of a resource. |
void |
setDateReleased(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
long dateReleased,
boolean recursive)
Changes the "release" date of a resource. |
void |
undoChanges(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
CmsResource.CmsResourceUndoMode mode)
Undos all changes in the resource by restoring the version from the online project to the current offline project. |
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 |
---|
protected CmsJspLoader m_jspLoader
Constructor Detail |
---|
public CmsResourceTypeJsp()
Method Detail |
---|
public static int getStaticTypeId()
public static java.lang.String getStaticTypeName()
public void chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) throws CmsException
I_CmsResourceType
OpenCms handles resources according to the resource type, not the file suffix. This is e.g. why a JSP in OpenCms can have the suffix ".html" instead of ".jsp" only. Changing the resource type makes sense e.g. if you want to make a plain text file a JSP resource, or a binary file an image, etc.
chtype
in interface I_CmsResourceType
chtype
in class A_CmsResourceType
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to change the type fortype
- the new resource type for this resource
CmsException
- if something goes wrongA_CmsResourceType.chtype(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, int)
public void deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceDeleteMode siblingMode) throws CmsException
I_CmsResourceType
The siblingMode
parameter controls how to handle siblings
during the delete operation.
Possible values for this parameter are:
deleteResource
in interface I_CmsResourceType
deleteResource
in class A_CmsResourceType
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managerresource
- the resource to deletesiblingMode
- indicates how to handle siblings of the deleted resource
CmsException
- if something goes wrongA_CmsResourceType.deleteResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, org.opencms.file.CmsResource.CmsResourceDeleteMode)
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
name
- the resource type nameid
- the resource type idclassName
- the class name of the resource type (read from the XML configuration)
CmsConfigurationException
- if the configuration is invalidA_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)
public void initialize(CmsObject cms)
I_CmsResourceType
This method will be called once during the OpenCms initialization processs. The VFS will already be available at the time the method is called.
initialize
in interface I_CmsResourceType
initialize
in class A_CmsResourceType
cms
- a OpenCms context initialized with "Admin" permissionsA_CmsResourceType.initialize(org.opencms.file.CmsObject)
public void moveResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, java.lang.String destination) throws CmsException, CmsIllegalArgumentException
I_CmsResourceType
A move operation in OpenCms is always a copy (as sibling) followed by a delete, this is a result of the online/offline structure of the OpenCms VFS. This way you can see the deleted files/folders in the offline project, and you will be unable to undelete them.
moveResource
in interface I_CmsResourceType
moveResource
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to movedestination
- the destination resource name
CmsException
- if something goes wrong
CmsIllegalArgumentException
- if the source
argument is null or of length 0A_CmsResourceType.moveResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, java.lang.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 void replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List properties) throws CmsException
I_CmsResourceType
replaceResource
in interface I_CmsResourceType
replaceResource
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the name of the resource to replacetype
- the new type of the resourcecontent
- the new content of the resourceproperties
- the new properties of the resource
CmsException
- if something goes wrongA_CmsResourceType.replaceResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, int, byte[], java.util.List)
public void restoreResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int version) throws CmsException
I_CmsResourceType
restoreResource
in interface I_CmsResourceType
restoreResource
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to restore from the archiveversion
- the version number of the resource to restore
CmsException
- if something goes wrongA_CmsResourceType.restoreResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, int)
public void setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateExpired, boolean recursive) throws CmsException
I_CmsResourceType
setDateExpired
in interface I_CmsResourceType
setDateExpired
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateExpired
- the new expire date of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder
CmsException
- if something goes wrongA_CmsResourceType.setDateExpired(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, long, boolean)
public void setDateLastModified(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, boolean recursive) throws CmsException
I_CmsResourceType
setDateLastModified
in interface I_CmsResourceType
setDateLastModified
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateLastModified
- timestamp the new timestamp of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder
CmsException
- if something goes wrongA_CmsResourceType.setDateLastModified(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, long, boolean)
public void setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateReleased, boolean recursive) throws CmsException
I_CmsResourceType
setDateReleased
in interface I_CmsResourceType
setDateReleased
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to touchdateReleased
- the new release date of the changed resourcerecursive
- if this operation is to be applied recursively to all resources in a folder
CmsException
- if something goes wrongA_CmsResourceType.setDateReleased(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, long, boolean)
public void undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsResource.CmsResourceUndoMode mode) throws CmsException
I_CmsResourceType
undoChanges
in interface I_CmsResourceType
undoChanges
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to undo the changes formode
- the undo mode, one of the CmsResource.CmsResourceUndoMode
#UNDO_XXX
constants
CmsException
- if something goes wrongA_CmsResourceType.undoChanges(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, org.opencms.file.CmsResource.CmsResourceUndoMode)
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 wrongA_CmsResourceType.writeFile(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsFile)
protected java.util.Set getReferencingStrongLinks(CmsObject cms, CmsResource resource) throws CmsException
cms
- the current cms contextresource
- the resource to check
CmsException
- if something goes wrongprotected void removeReferencingFromCache(java.util.Set references)
references
- the references to remove
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |