|
||||||
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_CmsResourceTypeFolderBase
public abstract class A_CmsResourceTypeFolderBase
Resource type descriptor for the type "folder".
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 | |
---|---|
A_CmsResourceTypeFolderBase()
Default constructor, used to initialize member variables. |
Method Summary | |
---|---|
void |
chtype(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource filename,
int newType)
Changes the resource type of a resource. |
void |
copyResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource source,
java.lang.String destination,
CmsResource.CmsResourceCopyMode siblingMode)
Copies a resource. |
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. |
int |
getLoaderId()
Returns the loader type id of this resource type. |
boolean |
isFolder()
Returns true if this resource type is a folder. |
void |
moveResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
java.lang.String destination)
Moves a resource to the given destination. |
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 |
restoreResourceBackup(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resourename,
int version)
Deprecated. Use A_CmsResourceType.restoreResource(CmsObject,CmsSecurityManager,CmsResource,int) instead |
void |
setDateExpired(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
long dateLastModified,
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 dateLastModified,
boolean recursive)
Changes the "release" date of a resource. |
void |
undelete(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
boolean recursive)
Undeletes 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. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public A_CmsResourceTypeFolderBase()
Method Detail |
---|
public void chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource filename, int newType) throws CmsException, CmsDataNotImplementedException
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 managerfilename
- the resource to change the type fornewType
- the new resource type for this resource
CmsException
- if something goes wrong
CmsDataNotImplementedException
I_CmsResourceType.chtype(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, int)
public void copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, java.lang.String destination, CmsResource.CmsResourceCopyMode siblingMode) throws CmsIllegalArgumentException, CmsException
I_CmsResourceType
You must ensure that the destination path is an absolute, valid and existing VFS path. Relative paths from the source are currently not supported.
The copied resource will always be locked to the current user after the copy operation.
In case the target resource already exists, it is overwritten with the source resource.
The siblingMode
parameter controls how to handle siblings
during the copy operation.
Possible values for this parameter are:
copyResource
in interface I_CmsResourceType
copyResource
in class A_CmsResourceType
cms
- the initialized CmsObjectsecurityManager
- the initialized OpenCms security managersource
- the resource to copydestination
- the name of the copy destination with complete pathsiblingMode
- indicates how to handle siblings during copy
CmsIllegalArgumentException
- if the destination
argument is null or of length 0
CmsException
- if something goes wrongI_CmsResourceType.copyResource(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, java.lang.String, CmsResource.CmsResourceCopyMode)
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, CmsSecurityManager, java.lang.String, byte[], List)
public int getLoaderId()
I_CmsResourceType
getLoaderId
in interface I_CmsResourceType
getLoaderId
in class A_CmsResourceType
I_CmsResourceType.getLoaderId()
public boolean isFolder()
I_CmsResourceType
true
if this resource type is a folder.
isFolder
in interface I_CmsResourceType
isFolder
in class A_CmsResourceType
true
if this resource type is a folderA_CmsResourceType.isFolder()
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 0I_CmsResourceType.moveResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, java.lang.String)
public void replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, java.util.List properties) throws CmsException, CmsDataNotImplementedException
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 wrong
CmsDataNotImplementedException
I_CmsResourceType.replaceResource(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, int, byte[], List)
public void restoreResourceBackup(CmsObject cms, CmsSecurityManager securityManager, CmsResource resourename, int version) throws CmsException
A_CmsResourceType.restoreResource(CmsObject,CmsSecurityManager,CmsResource,int)
instead
I_CmsResourceType
restoreResourceBackup
in interface I_CmsResourceType
restoreResourceBackup
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresourename
- the resource to restore from the archiveversion
- the publish tag of the resource to restore
CmsException
- if something goes wrongI_CmsResourceType.restoreResourceBackup(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, int)
public void setDateExpired(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, 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 touchdateLastModified
- the new expire date of the changed resourcerecursive
- if this operation is to be applied recursivly to all resources in a folder
CmsException
- if something goes wrongI_CmsResourceType.setDateExpired(org.opencms.file.CmsObject, CmsSecurityManager, 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 recursivly to all resources in a folder
CmsException
- if something goes wrongI_CmsResourceType.setDateLastModified(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, long, boolean)
public void setDateReleased(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, 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 touchdateLastModified
- the new release date of the changed resourcerecursive
- if this operation is to be applied recursivly to all resources in a folder
CmsException
- if something goes wrongI_CmsResourceType.setDateReleased(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, long, boolean)
public void undelete(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive) throws CmsException
I_CmsResourceType
Only resources that have already been published once can be undeleted, if a "new" resource is deleted it can not be undeleted.
undelete
in interface I_CmsResourceType
undelete
in class A_CmsResourceType
cms
- the current cms contextsecurityManager
- the initialized OpenCms security managerresource
- the resource to undeleterecursive
- if this operation is to be applied recursivly to all resources in a folder
CmsException
- if something goes wrongA_CmsResourceType.undelete(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, 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 wrongI_CmsResourceType.undoChanges(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, CmsResource.CmsResourceUndoMode)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |