org.opencms.file.types
Interface I_CmsResourceType

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

A_CmsResourceType

public interface I_CmsResourceType

extends I_CmsConfigurationParameterHandler

Defines resource type descriptors for all resources in the VFS.

Each file in the VFS must belong to an initialized resource type. The available resource type are read during system startup ftom the configuration file opencms-vfs.xml.

Certain resource types may require special handling for certain operations. This is usually required for write operations, or other operations that modify the VFS database. Therefore, the CmsObject defers handling of this operations to implementations of this interface.

If you implement a new resource type, it's a good idea to extend the abstract class A_CmsResourceType.

Important: The CmsObject passes the CmsSecurityManager object to implementations of this class. Using this object correctly is key to the resource type operations. Mistakes made in the implementation of a resource type can screw up the system security and the database structure, and make you unhappy.

Since:

6.0.0

Version:

$Revision: 1.25 $

Author:

Alexander Kandzior, Thomas Weckert, Michael Emmerich

Field Summary

static String	ADD_MAPPING_METHOD The name of the addMapping() method.
static String	ADD_RESOURCE_TYPE_METHOD Name of the addResourceType() method to add a resource type from the configuration.
static String	CONFIGURATION_PROPERTY_CREATE Configuration key prefix for properties that are attached when creating a new resource.
static String	CONFIGURATION_RESOURCE_TYPE_ID Configuration key for the resource type id.
static String	CONFIGURATION_RESOURCE_TYPE_NAME Configuration key for the resource type name.
static String	PROPERTY_ON_RESOURCE Store the property on resource record.
static String	PROPERTY_ON_STRUCTURE Store the property on structure record.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Method Summary

void	addMappingType(String mapping) Maps a file extension to a resource type.
void	changeLastModifiedProjectId(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Changes the project id of the resource to the current project, indicating that the resource was last modified in this project.
void	changeLock(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Changes the lock of a resource to the current user, that is "steals" the lock from another user.
void	chflags(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int flags) Changes the resource flags of a resource.
void	chtype(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int type) Changes the resource type of a resource.
void	copyResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, int siblingMode) Copies a resource.
void	copyResourceToProject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Copies a resource to the current project of the user.
CmsResource	createResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, byte[] content, List properties) Creates a new resource of the given resource type with the provided content and properties.
void	createSibling(CmsObject cms, CmsSecurityManager securityManager, CmsResource source, String destination, List properties) Creates a new sibling of the source resource.
void	deleteResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int siblingMode) Deletes a resource given its name.
String	getCachePropertyDefault() Returns the default for the cache property setting of this resource type.
List	getConfiguredCopyResources() Returns the configured copy resources for this resource type in an unmodifiable List.
List	getConfiguredDefaultProperties() Returns the configured default properties for this resource type in an unmodifiable List.
List	getConfiguredMappings() Returns the file extensions mappings for this resource type in an unmodifiable List.
int	getLoaderId() Returns the loader type id of this resource type.
int	getTypeId() Returns the type id of this resource type.
String	getTypeName() Returns the name of this resource type.
CmsResource	importResource(CmsObject cms, CmsSecurityManager securityManager, String resourcename, CmsResource resource, byte[] content, List properties) Imports a resource to the OpenCms VFS.
void	initialize(CmsObject cms) Initializes this resource type.
boolean	isAdditionalModuleResourceType() Indicates that this is an additional resource type which is defined in a module.
boolean	isDirectEditable() Returns true if this resource type is direct editable.
boolean	isFolder() Returns true if this resource type is a folder.
void	lockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int mode) Locks a resource.
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 properties) Replaces the content, type and properties of a resource.
void	restoreResourceBackup(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, int tag) Restores a file in the current project with a version from the backup archive.
void	setAdditionalModuleResourceType(boolean additionalType) Sets the additional resource type flag.
void	touch(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, long dateLastModified, long dateReleased, long dateExpired, boolean recursive) Changes the timestamp information of a resource.
void	undoChanges(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, boolean recursive) Undos all changes in the resource by restoring the version from the online project to the current offline project.
void	unlockResource(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource) Unlocks a resource.
CmsFile	writeFile(CmsObject cms, CmsSecurityManager securityManager, CmsFile resource) Writes a resource, including it's content.
void	writePropertyObject(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, CmsProperty property) Writes a property for a specified resource.
void	writePropertyObjects(CmsObject cms, CmsSecurityManager securityManager, CmsResource resource, List properties) Writes a list of properties for a specified resource.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Field Detail

ADD_MAPPING_METHOD

public static final String ADD_MAPPING_METHOD

The name of the addMapping() method.

See Also:

Constant Field Values

ADD_RESOURCE_TYPE_METHOD

public static final String ADD_RESOURCE_TYPE_METHOD

Name of the addResourceType() method to add a resource type from the configuration.

See Also:

Constant Field Values

CONFIGURATION_PROPERTY_CREATE

public static final String CONFIGURATION_PROPERTY_CREATE

Configuration key prefix for properties that are attached when creating a new resource.

See Also:

Constant Field Values

CONFIGURATION_RESOURCE_TYPE_ID

public static final String CONFIGURATION_RESOURCE_TYPE_ID

Configuration key for the resource type id.

See Also:

Constant Field Values

CONFIGURATION_RESOURCE_TYPE_NAME

public static final String CONFIGURATION_RESOURCE_TYPE_NAME

Configuration key for the resource type name.

See Also:

Constant Field Values

PROPERTY_ON_RESOURCE

public static final String PROPERTY_ON_RESOURCE

Store the property on resource record.

See Also:

Constant Field Values

PROPERTY_ON_STRUCTURE

public static final String PROPERTY_ON_STRUCTURE

Store the property on structure record.

See Also:

Constant Field Values

Method Detail

addMappingType

public void addMappingType(String mapping)

Maps a file extension to a resource type.

When uploading files into OpenCms, they must be mapped to the different OpenCms resource types. The configuration, to map which extension to which resouce type is done in the OpenCms VFS configuration.

Parameters:

mapping - the file extension mapped to the resource type

changeLastModifiedProjectId

public void changeLastModifiedProjectId(CmsObject cms,
                                        CmsSecurityManager securityManager,
                                        CmsResource resource)
                                 throws CmsException

Changes the project id of the resource to the current project, indicating that the resource was last modified in this project.

This information is used while publishing. Only resources inside the project folders that are new/modified/changed and that "belong" to the project (i.e. have the id of the project set) are published with the project.

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to apply this operation to

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.changeLastModifiedProjectId(String), CmsSecurityManager.changeLastModifiedProjectId(org.opencms.file.CmsRequestContext, CmsResource)

changeLock

public void changeLock(CmsObject cms,
                       CmsSecurityManager securityManager,
                       CmsResource resource)
                throws CmsException

Changes the lock of a resource to the current user, that is "steals" the lock from another user.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the name of the resource to change the lock with complete path

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.changeLock(String), CmsSecurityManager.changeLock(org.opencms.file.CmsRequestContext, CmsResource)

chflags

public void chflags(CmsObject cms,
                    CmsSecurityManager securityManager,
                    CmsResource resource,
                    int flags)
             throws CmsException

Changes the resource flags of a resource.

The resource flags are used to indicate various "special" conditions for a resource. Most notably, the "internal only" setting which signals that a resource can not be directly requested with it's URL.

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to change the flags for

flags - the new resource flags for this resource

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.chflags(String, int), CmsSecurityManager.chflags(org.opencms.file.CmsRequestContext, CmsResource, int)

chtype

public void chtype(CmsObject cms,
                   CmsSecurityManager securityManager,
                   CmsResource resource,
                   int type)
            throws CmsException

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.

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to change the type for

type - the new resource type for this resource

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.chtype(String, int), CmsSecurityManager.chtype(org.opencms.file.CmsRequestContext, CmsResource, int)

copyResource

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

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

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:

CmsObject.copyResource(String, String, int), CmsSecurityManager.copyResource(org.opencms.file.CmsRequestContext, CmsResource, String, int)

copyResourceToProject

public void copyResourceToProject(CmsObject cms,
                                  CmsSecurityManager securityManager,
                                  CmsResource resource)
                           throws CmsException,
                                  CmsIllegalArgumentException

Copies a resource to the current project of the user.

This is used to extend the current users project with the specified resource, in case that the resource is not yet part of the project. The resource is not really copied like in a regular copy operation, it is in fact only "enabled" in the current users project.

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to apply this operation to

Throws:

CmsException - if something goes wrong

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

See Also:

CmsObject.copyResourceToProject(String), CmsSecurityManager.copyResourceToProject(org.opencms.file.CmsRequestContext, CmsResource)

createResource

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

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

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

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

See Also:

CmsObject.createResource(String, int, byte[], List), CmsObject.createResource(String, int), CmsSecurityManager.createResource(org.opencms.file.CmsRequestContext, String, int, byte[], List)

createSibling

public void createSibling(CmsObject cms,
                          CmsSecurityManager securityManager,
                          CmsResource source,
                          String destination,
                          List properties)
                   throws CmsException

Creates a new sibling of the source resource.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

source - the resource to create a sibling for

destination - the name of the sibling to create with complete path

properties - the individual properties for the new sibling

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.createSibling(String, String, List), CmsSecurityManager.createSibling(org.opencms.file.CmsRequestContext, CmsResource, String, List)

deleteResource

public void deleteResource(CmsObject cms,
                           CmsSecurityManager securityManager,
                           CmsResource resource,
                           int siblingMode)
                    throws CmsException

Deletes a resource given its name.

The siblingMode parameter controls how to handle siblings during the delete operation.
Possible values for this parameter are:

• CmsResource.DELETE_REMOVE_SIBLINGS
• CmsResource.DELETE_PRESERVE_SIBLINGS

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to delete

siblingMode - indicates how to handle siblings of the deleted resource

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.deleteResource(String, int), CmsSecurityManager.deleteResource(org.opencms.file.CmsRequestContext, CmsResource, int)

getCachePropertyDefault

public String getCachePropertyDefault()

Returns the default for the 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.

Returns:

the default for the cache property setting of this resource type

See Also:

CmsFlexCache, CmsFlexCacheKey

getConfiguredCopyResources

public List getConfiguredCopyResources()

Returns the configured copy resources for this resource type in an unmodifiable List.

Returns:

the configured copy resources for this resource type in an unmodifiable List

getConfiguredDefaultProperties

public List getConfiguredDefaultProperties()

Returns the configured default properties for this resource type in an unmodifiable List.

Returns:

the configured default properties for this resource type in an unmodifiable List

getConfiguredMappings

public List getConfiguredMappings()

Returns the file extensions mappings for this resource type in an unmodifiable List.

Returns:

a list of file extensions mappings for this resource type in an unmodifiable List

getLoaderId

public int getLoaderId()

Returns the loader type id of this resource type.

Returns:

the loader type id of this resource type

getTypeId

public int getTypeId()

Returns the type id of this resource type.

Returns:

the type id of this resource type

getTypeName

public String getTypeName()

Returns the name of this resource type.

Returns:

the name of this resource type

importResource

public CmsResource importResource(CmsObject cms,
                                  CmsSecurityManager securityManager,
                                  String resourcename,
                                  CmsResource resource,
                                  byte[] content,
                                  List properties)
                           throws CmsException

Imports a resource to the OpenCms VFS.

If a resource already exists in the VFS (i.e. has the same name and same id) it is replaced by the imported resource.

If a resource with the same name but a different id exists, the imported resource is (usually) moved to the "lost and found" folder.

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resourcename - the target name (with full path) for the resource after import

resource - the resource to be imported

content - the content of the resource

properties - the properties of the resource

Returns:

the imported resource

Throws:

CmsException - if something goes wrong

See Also:

CmsSecurityManager.moveToLostAndFound(org.opencms.file.CmsRequestContext, String, boolean), CmsObject.importResource(String, CmsResource, byte[], List), CmsSecurityManager.importResource(org.opencms.file.CmsRequestContext, String, CmsResource, byte[], List, boolean)

initialize

public void initialize(CmsObject cms)

Initializes this resource type.

This method will be called once during the OpenCms initialization processs. The VFS will already be available at the time the method is called.

Parameters:

cms - a OpenCms context initialized with "Admin" permissions

isAdditionalModuleResourceType

public boolean isAdditionalModuleResourceType()

Indicates that this is an additional resource type which is defined in a module.

Returns:

true or false

isDirectEditable

public boolean isDirectEditable()

Returns true if this resource type is direct editable.

Returns:

true if this resource type is direct editable

isFolder

public boolean isFolder()

Returns true if this resource type is a folder.

Returns:

true if this resource type is a folder

lockResource

public void lockResource(CmsObject cms,
                         CmsSecurityManager securityManager,
                         CmsResource resource,
                         int mode)
                  throws CmsException

Locks a resource.

The mode parameter controls what kind of lock is used.
Possible values for this parameter are:

• CmsLock.COMMON
• CmsLock.TEMPORARY

Parameters:

cms - the initialized CmsObject

securityManager - the initialized OpenCms security manager

resource - the resource to lock

mode - flag indicating the mode for the lock

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.lockResource(String, int), CmsSecurityManager.lockResource(org.opencms.file.CmsRequestContext, CmsResource, int)

moveResource

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

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.

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:

CmsObject.moveResource(String, String), CmsObject.renameResource(String, String), CmsSecurityManager.copyResource(org.opencms.file.CmsRequestContext, CmsResource, String, int), CmsSecurityManager.deleteResource(org.opencms.file.CmsRequestContext, CmsResource, int)

replaceResource

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

Replaces the content, type and properties of a resource.

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

See Also:

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

restoreResourceBackup

public void restoreResourceBackup(CmsObject cms,
                                  CmsSecurityManager securityManager,
                                  CmsResource resource,
                                  int tag)
                           throws CmsException

Restores a file in the current project with a version from the backup archive.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to restore from the archive

tag - the tag (version) id to resource form the archive

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.restoreResourceBackup(String, int), CmsSecurityManager.restoreResource(org.opencms.file.CmsRequestContext, CmsResource, int)

setAdditionalModuleResourceType

public void setAdditionalModuleResourceType(boolean additionalType)

Sets the additional resource type flag.

Parameters:

additionalType - true or false

touch

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

Changes the timestamp information of a resource.

This method is used to set the "last modified" date of a resource, the "release" date of a resource, and also the "expire" date of a resource.

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

dateReleased - the new release date of the changed resource, set it to CmsResource.TOUCH_DATE_UNCHANGED to keep it unchanged.

dateExpired - the new expire date of the changed resource, set it to CmsResource.TOUCH_DATE_UNCHANGED to keep it unchanged.

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

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.touch(String, long, long, long, boolean), CmsSecurityManager.touch(org.opencms.file.CmsRequestContext, CmsResource, long, long, long)

undoChanges

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

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

This is also used when doing an "undelete" operation.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to undo the changes for

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

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.undoChanges(String, boolean), CmsSecurityManager.undoChanges(org.opencms.file.CmsRequestContext, CmsResource)

unlockResource

public void unlockResource(CmsObject cms,
                           CmsSecurityManager securityManager,
                           CmsResource resource)
                    throws CmsException

Unlocks a resource.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to unlock

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.unlockResource(String), CmsSecurityManager.unlockResource(org.opencms.file.CmsRequestContext, CmsResource)

writeFile

public CmsFile writeFile(CmsObject cms,
                         CmsSecurityManager securityManager,
                         CmsFile resource)
                  throws CmsException

Writes a resource, including it's content.

Applies only to resources of type CmsFile have a binary content attached.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to apply this operation to

Returns:

the written resource

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.writeFile(CmsFile), CmsSecurityManager.writeFile(org.opencms.file.CmsRequestContext, CmsFile)

writePropertyObject

public void writePropertyObject(CmsObject cms,
                                CmsSecurityManager securityManager,
                                CmsResource resource,
                                CmsProperty property)
                         throws CmsException

Writes a property for a specified resource.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to write the property for

property - the property to write

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.writePropertyObject(String, CmsProperty), CmsSecurityManager.writePropertyObject(org.opencms.file.CmsRequestContext, CmsResource, CmsProperty)

writePropertyObjects

public void writePropertyObjects(CmsObject cms,
                                 CmsSecurityManager securityManager,
                                 CmsResource resource,
                                 List properties)
                          throws CmsException

Writes a list of properties for a specified resource.

Code calling this method has to ensure that the no properties a, b are contained in the specified list so that a.equals(b), otherwise an exception is thrown.

Parameters:

cms - the current cms context

securityManager - the initialized OpenCms security manager

resource - the resource to write the properties for

properties - the list of properties to write

Throws:

CmsException - if something goes wrong

See Also:

CmsObject.writePropertyObjects(String, List), CmsSecurityManager.writePropertyObjects(org.opencms.file.CmsRequestContext, CmsResource, List)