Package org.opencms.file.types

Class A_CmsResourceTypeFolderBase

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.A_CmsResourceTypeFolderBase

All Implemented Interfaces:

Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType

Direct Known Subclasses:

CmsResourceTypeFolder, CmsResourceTypeFolderExtended, CmsResourceTypeUnknownFolder

public abstract class A_CmsResourceTypeFolderBase
extends A_CmsResourceType

Resource type descriptor for the type "folder".

Since:

6.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType

I_CmsResourceType.Formatter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_SHALLOW_FOLDER_COPY	Attribute to control shallow copying.

Fields inherited from class org.opencms.file.types.A_CmsResourceType

CONFIGURATION_GALLERY_JAVASCRIPT_PATH, CONFIGURATION_GALLERY_PREVIEW_PROVIDER, CONFIGURATION_GALLERY_TYPE_NAMES, CONFIGURATION_INTERNAL, DEFAULT_GALLERY_PREVIEW_PROVIDER, m_addititionalModuleResourceType, m_className, m_configuration, m_copyResources, m_defaultProperties, m_frozen, m_galleryPreviewProvider, m_mappings, m_moduleName, 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.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

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

Constructor Summary

Constructors

Constructor	Description
A_CmsResourceTypeFolderBase()	Default constructor, used to initialize member variables.

Method Summary

Modifier and Type	Method	Description
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, String destination, CmsResource.CmsResourceCopyMode siblingMode)	Copies a resource.
CmsResource	createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List<CmsProperty> 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, String destination)	Moves a resource to the given destination.
void	replaceResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type, byte[] content, List<CmsProperty> properties)	Replaces the content, type and properties of a resource.
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 org.opencms.file.types.A_CmsResourceType

addConfigurationParameter, addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, chtype, copyResourceToProject, createRelations, createSibling, deleteResource, equals, getAdjustLinksFolder, getCachePropertyDefault, getClassName, getConfiguration, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getCopyResources, getFormattersForResource, getGalleryPreviewProvider, getGalleryTypes, getMacroResolver, getModuleName, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, replaceResource, restoreResource, setAdditionalModuleResourceType, setAdjustLinksFolder, setModuleName, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ATTR_SHALLOW_FOLDER_COPY

public static final String ATTR_SHALLOW_FOLDER_COPY

Attribute to control shallow copying.

See Also:

• Constant Field Values

Constructor Details

A_CmsResourceTypeFolderBase

public A_CmsResourceTypeFolderBase()

Default constructor, used to initialize member variables.

Method Details

chtype

public void chtype(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource filename,
 int newType)
            throws CmsException,
CmsDataNotImplementedException

Description copied from interface: I_CmsResourceType

Changes the resource type of a resource.

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.

Specified by:

chtype in interface I_CmsResourceType

Overrides:

chtype in class A_CmsResourceType

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

filename - the resource to change the type for

newType - the new resource type for this resource

Throws:

CmsException - if something goes wrong

CmsDataNotImplementedException

See Also:

• I_CmsResourceType.chtype(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, int)

copyResource

public void copyResource(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource source,
 String destination,
 CmsResource.CmsResourceCopyMode siblingMode)
                  throws CmsIllegalArgumentException,
CmsException

Description copied from interface: I_CmsResourceType

Copies a resource.

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:

• CmsResource.COPY_AS_NEW
• CmsResource.COPY_AS_SIBLING
• CmsResource.COPY_PRESERVE_SIBLING

Specified by:

copyResource in interface I_CmsResourceType

Overrides:

copyResource in class A_CmsResourceType

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

source - the resource to copy

destination - the name of the copy destination with complete path

siblingMode - indicates how to handle siblings during copy

Throws:

CmsIllegalArgumentException - if the destination argument is null or of length 0

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.copyResource(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, java.lang.String, CmsResource.CmsResourceCopyMode)

createResource

public CmsResource createResource(CmsObject cms,
 CmsSecurityManager securityManager,
 String resourcename,
 byte[] content,
 List<CmsProperty> properties)
                           throws CmsException

Description copied from interface: I_CmsResourceType

Creates a new resource of the given resource type with the provided content and properties.

Specified by:

createResource in interface I_CmsResourceType

Overrides:

createResource in class A_CmsResourceType

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resourcename - the name of the resource to create (full path)

content - the content for the new resource

properties - the properties for the new resource

Returns:

the created resource

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.createResource(org.opencms.file.CmsObject, CmsSecurityManager, java.lang.String, byte[], List)

getLoaderId

public int getLoaderId()

Description copied from interface: I_CmsResourceType

Returns the loader type id of this resource type.

Specified by:

getLoaderId in interface I_CmsResourceType

Specified by:

getLoaderId in class A_CmsResourceType

Returns:

the loader type id of this resource type

See Also:

• I_CmsResourceType.getLoaderId()

isFolder

public boolean isFolder()

Description copied from interface: I_CmsResourceType

Returns true if this resource type is a folder.

Specified by:

isFolder in interface I_CmsResourceType

Overrides:

isFolder in class A_CmsResourceType

Returns:

true if this resource type is a folder

See Also:

• A_CmsResourceType.isFolder()

moveResource

public void moveResource(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 String destination)
                  throws CmsException,
CmsIllegalArgumentException

Description copied from interface: I_CmsResourceType

Moves a resource to the given destination.

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.

Specified by:

moveResource in interface I_CmsResourceType

Overrides:

moveResource in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to move

destination - the destination resource name

Throws:

CmsException - if something goes wrong

CmsIllegalArgumentException - if the source argument is null or of length 0

See Also:

• I_CmsResourceType.moveResource(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, java.lang.String)

replaceResource

public void replaceResource(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 int type,
 byte[] content,
 List<CmsProperty> properties)
                     throws CmsException,
CmsDataNotImplementedException

Description copied from interface: I_CmsResourceType

Replaces the content, type and properties of a resource.

Specified by:

replaceResource in interface I_CmsResourceType

Overrides:

replaceResource in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the name of the resource to replace

type - the new type of the resource

content - the new content of the resource

properties - the new properties of the resource

Throws:

CmsException - if something goes wrong

CmsDataNotImplementedException

See Also:

• I_CmsResourceType.replaceResource(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, int, byte[], List)

setDateExpired

public void setDateExpired(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 long dateLastModified,
 boolean recursive)
                    throws CmsException

Description copied from interface: I_CmsResourceType

Changes the "expire" date of a resource.

Specified by:

setDateExpired in interface I_CmsResourceType

Overrides:

setDateExpired in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to touch

dateLastModified - the new expire date of the changed resource

recursive - if this operation is to be applied recursively to all resources in a folder

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.setDateExpired(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, long, boolean)

setDateLastModified

public void setDateLastModified(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 long dateLastModified,
 boolean recursive)
                         throws CmsException

Description copied from interface: I_CmsResourceType

Changes the "last modified" date of a resource.

Specified by:

setDateLastModified in interface I_CmsResourceType

Overrides:

setDateLastModified in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to touch

dateLastModified - timestamp the new timestamp of the changed resource

recursive - if this operation is to be applied recursively to all resources in a folder

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.setDateLastModified(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, long, boolean)

setDateReleased

public void setDateReleased(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 long dateLastModified,
 boolean recursive)
                     throws CmsException

Description copied from interface: I_CmsResourceType

Changes the "release" date of a resource.

Specified by:

setDateReleased in interface I_CmsResourceType

Overrides:

setDateReleased in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to touch

dateLastModified - the new release date of the changed resource

recursive - if this operation is to be applied recursively to all resources in a folder

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.setDateReleased(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, long, boolean)

undelete

public void undelete(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 boolean recursive)
              throws CmsException

Description copied from interface: I_CmsResourceType

Undeletes a resource.

Only resources that have already been published once can be undeleted, if a "new" resource is deleted it can not be undeleted.

Specified by:

undelete in interface I_CmsResourceType

Overrides:

undelete in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to undelete

recursive - if this operation is to be applied recursively to all resources in a folder

Throws:

CmsException - if something goes wrong

See Also:

• A_CmsResourceType.undelete(org.opencms.file.CmsObject, org.opencms.db.CmsSecurityManager, org.opencms.file.CmsResource, boolean)

undoChanges

public void undoChanges(CmsObject cms,
 CmsSecurityManager securityManager,
 CmsResource resource,
 CmsResource.CmsResourceUndoMode mode)
                 throws CmsException

Description copied from interface: I_CmsResourceType

Undos all changes in the resource by restoring the version from the online project to the current offline project.

Specified by:

undoChanges in interface I_CmsResourceType

Overrides:

undoChanges in class A_CmsResourceType

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to undo the changes for

mode - the undo mode, one of the CmsResource.CmsResourceUndoMode#UNDO_XXX constants

Throws:

CmsException - if something goes wrong

See Also:

• I_CmsResourceType.undoChanges(org.opencms.file.CmsObject, CmsSecurityManager, CmsResource, CmsResource.CmsResourceUndoMode)