Package org.opencms.db.generic

Class CmsStorageVfsDriver

java.lang.Object

org.opencms.db.generic.CmsVfsDriver

org.opencms.db.generic.CmsStorageVfsDriver

All Implemented Interfaces:

I_CmsDriver, I_CmsVfsDriver

Direct Known Subclasses:

CmsStorageVfsDriver, CmsStorageVfsDriver, CmsStorageVfsDriver, CmsStorageVfsDriver, CmsStorageVfsDriver, CmsStorageVfsDriver, CmsStorageVfsDriver

public class CmsStorageVfsDriver
extends CmsVfsDriver

Integrates the OpenCms deduplicating media storage engine (DMSE) with VFS content operations.

This driver reads and writes storage identifiers and content hashes alongside VFS content rows. It delegates backend access to the storage manager and supports content in both the regular VFS content columns and storage backends.

See Also:

• CmsStorageManager

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.db.generic.CmsVfsDriver

CmsVfsDriver.RelationConditionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected CmsStorageManager	m_storageManager
protected I_CmsStoredContentInfoCache	m_storedContentInfoCache	The stored content info cache.

Fields inherited from class org.opencms.db.generic.CmsVfsDriver

m_driverManager, m_resOp, m_sqlManager, OFFLINE, ONLINE

Fields inherited from interface org.opencms.db.I_CmsDriver

AND_CONDITION, BEGIN_CONDITION, BEGIN_EXCLUDE_CONDITION, BEGIN_INCLUDE_CONDITION, END_CONDITION, OR_CONDITION

Fields inherited from interface org.opencms.db.I_CmsVfsDriver

DRIVER_TYPE_ID, REQ_ATTR_CHECK_PERMISSIONS, REQ_ATTR_RESOURCE_OUS

Constructor Summary

Constructors

Constructor	Description
CmsStorageVfsDriver()

Method Summary

Modifier and Type	Method	Description
void	createContent(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)	Creates a content entry for the specified resource.
CmsFile	createFile(CmsDbContext dbc, ResultSet res, CmsUUID projectId)	Creates a CmsFile instance from a JDBC ResultSet.
CmsFile	createFile(CmsDbContext dbc, ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet)	Creates a CmsFile instance from a JDBC ResultSet.
void	createOnlineContent(CmsDbContext dbc, CmsUUID resourceId, byte[] contents, int publishTag, boolean keepOnline, boolean needToUpdateContent)	Creates a new content in the offline project.
protected I_CmsStoredContentInfoCache	createStoredContentInfoCache(CmsStoredContentInfoCacheConfiguration configuration)	Creates the stored content info cache.
void	deleteHistoryContent(CmsDbContext dbc, CmsUUID resourceId, int publishTagToKeep)	Deletes historical content entries for a resource older than the given publish tag.
void	destroy()	Destroys this driver.
protected List<String>	getAdditionalSqlQueryProperties(CmsParameterConfiguration configuration)	Returns additional SQL query property files to load between the generic and database-specific queries.
I_CmsStorageDelivery	getStoredContentDelivery(CmsDbContext dbc, String storage)	Returns a delivery-capable storage backend by its stable storage identifier.
void	init(CmsDbContext dbc, CmsConfigurationManager configurationManager, List<String> successiveDrivers, CmsDriverManager driverManager)	Initializes the driver.
CmsSqlManager	initSqlManager(String classname)	Initializes the SQL manager for this driver.
CmsSqlManager	initSqlManager(String classname, List<String> additionalQueryProperties)	Initializes the SQL manager for this driver and loads additional SQL query property files.
byte[]	readContent(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId)	Reads the content of a file specified by it's resource ID.
void	readContentFrom(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, I_CmsFileContentStreamHandler handler)	Reads the content of a file specified by it's resource ID and passes it to an input stream handler.
void	readContentTo(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, OutputStream out)	Reads the content of a file specified by it's resource ID and writes it to an output stream.
byte[]	readHistoryContent(CmsDbContext dbc, CmsUUID resourceId, int publishTag)	Reads the historical content of a file specified by its resource ID and publish tag.
CmsStoredContentInfo	readStoredContentInfo(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Reads information about where the content for a file resource is stored without loading the content bytes.
void	removeFile(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)	Removes a file physically in the database.
void	writeContent(CmsDbContext dbc, CmsResource resource, byte[] content)	Writes the resource content for the specified resource.

Methods inherited from class org.opencms.db.generic.CmsVfsDriver

addUrlNameMappingEntry, checkWritePermissionsInFolder, countSiblings, createFolder, createPropertyDefinition, createRelation, createResource, createResource, createSibling, deleteAliases, deletePropertyDefinition, deletePropertyObjects, deleteRelations, deleteRewriteAliases, deleteUrlNameMappingEntries, escapeDbWildcard, getResourceOus, getSqlManager, incrementCounter, insertAlias, insertRewriteAliases, internalCountProperties, internalCreateCounter, internalCreateUrlNameMappingEntry, internalIncrementCounter, internalReadAlias, internalReadCounter, internalReadParentId, internalReadRelation, internalReadResourceState, internalReadStructureState, internalRemoveFolder, internalUpdateVersions, internalValidateResourceLength, moveRelations, moveResource, prepareExpiredTimeRangeCondition, preparePathCondition, prepareProjectCondition, prepareRelationConditions, prepareReleasedTimeRangeCondition, prepareResourceCondition, prepareStateCondition, prepareTimeRangeCondition, prepareTypeCondition, prepareTypesCondition, prepareUrlNameMappingConditions, publishResource, publishVersions, readAliases, readChildResources, readFolder, readFolder, readFolderSizeStats, readParentFolder, readPropertyDefinition, readPropertyDefinitions, readPropertyObject, readPropertyObjects, readRelations, readResource, readResource, readResources, readResourcesForPrincipalACE, readResourcesForPrincipalAttr, readResourcesWithProperty, readResourceTree, readRewriteAliases, readSiblings, readTypesInResourceTree, readUrlNameMappingEntries, readVersions, removeFolder, repairBrokenRelations, replaceResource, setDriverManager, setSqlManager, transferResource, updateBrokenRelations, updateRelations, validateResourceIdExists, validateStructureIdExists, wrapException, writeLastModifiedProjectId, writePropertyObject, writePropertyObjects, writeResource, writeResourceState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opencms.db.I_CmsDriver

toString

Field Details

m_storageManager

protected CmsStorageManager m_storageManager

m_storedContentInfoCache

protected I_CmsStoredContentInfoCache m_storedContentInfoCache

The stored content info cache.

Constructor Details

CmsStorageVfsDriver

public CmsStorageVfsDriver()

Method Details

createContent

public void createContent(CmsDbContext dbc,
 CmsUUID projectId,
 CmsResource resource,
 byte[] content)
                   throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Creates a content entry for the specified resource.

Specified by:

createContent in interface I_CmsVfsDriver

Overrides:

createContent in class CmsVfsDriver

Parameters:

dbc - the current database context

projectId - the id of the current project

resource - the resource to create the content for

content - the content to write

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.createContent(CmsDbContext, CmsUUID, CmsResource, byte[])

createFile

public CmsFile createFile(CmsDbContext dbc,
 ResultSet res,
 CmsUUID projectId)
                   throws CmsDataAccessException,
SQLException

Description copied from interface: I_CmsVfsDriver

Creates a CmsFile instance from a JDBC ResultSet.

Specified by:

createFile in interface I_CmsVfsDriver

Overrides:

createFile in class CmsVfsDriver

Parameters:

dbc - the current database context

res - the JDBC ResultSet

projectId - the project id

Returns:

the created file

Throws:

CmsDataAccessException - if something goes wrong

SQLException - in case the result set does not include a requested table attribute

See Also:

• I_CmsVfsDriver.createFile(CmsDbContext, java.sql.ResultSet, CmsUUID)

createFile

public CmsFile createFile(CmsDbContext dbc,
 ResultSet res,
 CmsUUID projectId,
 boolean hasFileContentInResultSet)
                   throws CmsDataAccessException,
SQLException

Description copied from interface: I_CmsVfsDriver

Creates a CmsFile instance from a JDBC ResultSet.

Specified by:

createFile in interface I_CmsVfsDriver

Overrides:

createFile in class CmsVfsDriver

Parameters:

dbc - the current database context

res - the JDBC ResultSet

projectId - the project id

hasFileContentInResultSet - flag to include the file content

Returns:

the created file

Throws:

CmsDataAccessException - if something goes wrong

SQLException - in case the result set does not include a requested table attribute

See Also:

• I_CmsVfsDriver.createFile(CmsDbContext, java.sql.ResultSet, CmsUUID, boolean)

createOnlineContent

public void createOnlineContent(CmsDbContext dbc,
 CmsUUID resourceId,
 byte[] contents,
 int publishTag,
 boolean keepOnline,
 boolean needToUpdateContent)
                         throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Creates a new content in the offline project.

Specified by:

createOnlineContent in interface I_CmsVfsDriver

Overrides:

createOnlineContent in class CmsVfsDriver

Parameters:

dbc - the current database context

resourceId - the resource id of the content to write

contents - the content to publish

publishTag - the publish tag

keepOnline - if the content is online or has to be put in the history

needToUpdateContent - if the content blob has to be updated

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.createOnlineContent(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, byte[], int, boolean, boolean)

deleteHistoryContent

public void deleteHistoryContent(CmsDbContext dbc,
 CmsUUID resourceId,
 int publishTagToKeep)
                          throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Deletes historical content entries for a resource older than the given publish tag.

Specified by:

deleteHistoryContent in interface I_CmsVfsDriver

Overrides:

deleteHistoryContent in class CmsVfsDriver

Parameters:

dbc - the current database context

resourceId - the id of the resource

publishTagToKeep - the minimal publish tag to keep

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.deleteHistoryContent(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, int)

destroy

public void destroy()
             throws Throwable

Description copied from interface: I_CmsVfsDriver

Destroys this driver.

Specified by:

destroy in interface I_CmsVfsDriver

Overrides:

destroy in class CmsVfsDriver

Throws:

Throwable - if something goes wrong

See Also:

• I_CmsVfsDriver.destroy()

getStoredContentDelivery

public I_CmsStorageDelivery getStoredContentDelivery(CmsDbContext dbc,
 String storage)
                                              throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Returns a delivery-capable storage backend by its stable storage identifier.

Parameters:

dbc - the current database context

storage - the stable storage identifier

Returns:

the delivery-capable storage backend, or null if not supported by the VFS driver

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.getStoredContentDelivery(org.opencms.db.CmsDbContext, java.lang.String)

init

public void init(CmsDbContext dbc,
 CmsConfigurationManager configurationManager,
 List<String> successiveDrivers,
 CmsDriverManager driverManager)

Description copied from interface: I_CmsDriver

Initializes the driver.

Specified by:

init in interface I_CmsDriver

Overrides:

init in class CmsVfsDriver

Parameters:

dbc - the current database context

configurationManager - the configuration manager

successiveDrivers - a list of successive drivers to be initialized

driverManager - the initialized OpenCms driver manager

See Also:

• I_CmsDriver.init(org.opencms.db.CmsDbContext, org.opencms.configuration.CmsConfigurationManager, java.util.List, org.opencms.db.CmsDriverManager)

initSqlManager

public CmsSqlManager initSqlManager(String classname)

Description copied from interface: I_CmsVfsDriver

Initializes the SQL manager for this driver.

To obtain JDBC connections from different pools, further {online|offline|history} pool Urls have to be specified.

Specified by:

initSqlManager in interface I_CmsVfsDriver

Overrides:

initSqlManager in class CmsVfsDriver

Parameters:

classname - the class name of the SQL manager

Returns:

the SQL manager for this driver

See Also:

• I_CmsVfsDriver.initSqlManager(String)

initSqlManager

public CmsSqlManager initSqlManager(String classname,
 List<String> additionalQueryProperties)

Description copied from class: CmsVfsDriver

Initializes the SQL manager for this driver and loads additional SQL query property files.

Overrides:

initSqlManager in class CmsVfsDriver

Parameters:

classname - the class name of the SQL manager

additionalQueryProperties - the additional SQL query property files to load

Returns:

the SQL manager for this driver

See Also:

• CmsVfsDriver.initSqlManager(String, List)

readContent

public byte[] readContent(CmsDbContext dbc,
 CmsUUID projectId,
 CmsUUID resourceId)
                   throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Reads the content of a file specified by it's resource ID.

Specified by:

readContent in interface I_CmsVfsDriver

Overrides:

readContent in class CmsVfsDriver

Parameters:

dbc - the current database context

projectId - the ID of the current project

resourceId - the id of the resource

Returns:

the file content

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.readContent(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID)

readContentFrom

public void readContentFrom(CmsDbContext dbc,
 CmsUUID projectId,
 CmsUUID resourceId,
 I_CmsFileContentStreamHandler handler)
                     throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Reads the content of a file specified by it's resource ID and passes it to an input stream handler.

Parameters:

dbc - the current database context

projectId - the ID of the current project

resourceId - the id of the resource

handler - the stream handler

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.readContentFrom(CmsDbContext, CmsUUID, CmsUUID, I_CmsFileContentStreamHandler)

readContentTo

public void readContentTo(CmsDbContext dbc,
 CmsUUID projectId,
 CmsUUID resourceId,
 OutputStream out)
                   throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Reads the content of a file specified by it's resource ID and writes it to an output stream.

Parameters:

dbc - the current database context

projectId - the ID of the current project

resourceId - the id of the resource

out - the output stream to write to

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.readContentTo(CmsDbContext, CmsUUID, CmsUUID, OutputStream)

readHistoryContent

public byte[] readHistoryContent(CmsDbContext dbc,
 CmsUUID resourceId,
 int publishTag)
                          throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Reads the historical content of a file specified by its resource ID and publish tag.

Specified by:

readHistoryContent in interface I_CmsVfsDriver

Overrides:

readHistoryContent in class CmsVfsDriver

Parameters:

dbc - the current database context

resourceId - the id of the resource

publishTag - the publish tag of the historical content

Returns:

the historical file content

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.readHistoryContent(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, int)

readStoredContentInfo

public CmsStoredContentInfo readStoredContentInfo(CmsDbContext dbc,
 CmsUUID projectId,
 CmsResource resource)
                                           throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Reads information about where the content for a file resource is stored without loading the content bytes.

Parameters:

dbc - the current database context

projectId - the ID of the current project

resource - the resource

Returns:

the stored content info

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.readStoredContentInfo(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, org.opencms.file.CmsResource)

removeFile

public void removeFile(CmsDbContext dbc,
 CmsUUID projectId,
 CmsResource resource)
                throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Removes a file physically in the database.

Specified by:

removeFile in interface I_CmsVfsDriver

Overrides:

removeFile in class CmsVfsDriver

Parameters:

dbc - the current database context

projectId - the id of the current project

resource - the resource

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.removeFile(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.file.CmsResource)

writeContent

public void writeContent(CmsDbContext dbc,
 CmsResource resource,
 byte[] content)
                  throws CmsDataAccessException

Description copied from interface: I_CmsVfsDriver

Writes the resource content for the specified resource.

Specified by:

writeContent in interface I_CmsVfsDriver

Overrides:

writeContent in class CmsVfsDriver

Parameters:

dbc - the current database context

resource - the resource used to identify the content to update

content - the new content of the file

Throws:

CmsDataAccessException - if something goes wrong

See Also:

• I_CmsVfsDriver.writeContent(org.opencms.db.CmsDbContext, org.opencms.file.CmsResource, byte[])

createStoredContentInfoCache

protected I_CmsStoredContentInfoCache createStoredContentInfoCache(CmsStoredContentInfoCacheConfiguration configuration)
                                                            throws Exception

Creates the stored content info cache.

Parameters:

configuration - the cache configuration

Returns:

the cache

Throws:

Exception - if the configured factory can not be created

getAdditionalSqlQueryProperties

protected List<String> getAdditionalSqlQueryProperties(CmsParameterConfiguration configuration)

Description copied from class: CmsVfsDriver

Returns additional SQL query property files to load between the generic and database-specific queries.

Overrides:

getAdditionalSqlQueryProperties in class CmsVfsDriver

Parameters:

configuration - the OpenCms parameter configuration

Returns:

the additional SQL query property files

See Also:

• CmsVfsDriver.getAdditionalSqlQueryProperties(CmsParameterConfiguration)