java.lang.Object

org.opencms.db.generic.CmsVfsDriver

All Implemented Interfaces:: I_CmsDriver, I_CmsVfsDriver

Direct Known Subclasses:: CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver, CmsVfsDriver

public class CmsVfsDriver extends Object implements I_CmsDriver, I_CmsVfsDriver

Generic (ANSI-SQL) database server implementation of the VFS driver methods.

Since:: 6.0.0

Field Summary

Fields

Modifier and Type

Field

Description

protected CmsDriverManager

m_driverManager

The driver manager.

protected List<CmsUUID>

m_resOp

This field is temporarily used to compute the versions during publishing.

protected CmsSqlManager

m_sqlManager

The sql manager.

protected static final String

OFFLINE

Contains the macro replacement value for the offline project.

protected static final String

ONLINE

Contains the macro replacement value for the online project.

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

CmsVfsDriver()
Method Summary

Modifier and Type

Method

Description

void

addUrlNameMappingEntry(CmsDbContext dbc, boolean online, CmsUrlNameMappingEntry entry)

Adds a new URL name mapping entry.

protected void

checkWritePermissionsInFolder(CmsDbContext dbc, CmsResource folder)

Checks that the current user has write permissions for all subresources of the given folder.

int

countSiblings(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId)

Counts the number of siblings of a resource.

void

createContent(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, byte[] content)

Creates a content entry for the resource identified by the specified resource id.

CmsFile

createFile(ResultSet res, CmsUUID projectId)

Creates a CmsFile instance from a JDBC ResultSet.

CmsFile

createFile(ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet)

Creates a CmsFile instance from a JDBC ResultSet.

CmsFolder

createFolder(ResultSet res, CmsUUID projectId, boolean hasProjectIdInResultSet)

Creates a CmsFolder 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.

CmsPropertyDefinition

createPropertyDefinition(CmsDbContext dbc, CmsUUID projectId, String name, CmsPropertyDefinition.CmsPropertyType type)

Creates a new property definition in the database.

void

createRelation(CmsDbContext dbc, CmsUUID projectId, CmsRelation relation)

Creates a new CmsRelation object in the database.

CmsResource

createResource(ResultSet res, CmsUUID projectId)

Creates a CmsResource instance from a JDBC ResultSet.

CmsResource

createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content)

Creates a new resource from a given CmsResource object.

void

createSibling(CmsDbContext dbc, CmsProject project, CmsResource resource)

Creates a new sibling for a specified resource.

void

deleteAliases(CmsDbContext dbc, CmsProject project, CmsAliasFilter filter)

Deletes the aliases matching a given filter.

void

deletePropertyDefinition(CmsDbContext dbc, CmsPropertyDefinition metadef)

Deletes a property definition.

void

deletePropertyObjects(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int deleteOption)

Deletes all property values of a file or folder.

void

deleteRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)

Deletes all relations with the given filter for the given resource.

void

deleteRewriteAliases(CmsDbContext dbc, CmsRewriteAliasFilter filter)

Deletes rewrite aliases matching a given filter.

void

deleteUrlNameMappingEntries(CmsDbContext dbc, boolean online, CmsUrlNameMappingFilter filter)

Deletes the URL name mapping entries which match a given filter.

void

destroy()

Destroys this driver.

protected static String

escapeDbWildcard(String path)

Escapes the database wildcards within the resource path.

List<CmsOrganizationalUnit>

getResourceOus(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)

Returns all organizational units for the given resource.

CmsSqlManager

getSqlManager()

Returns the SqlManager of this driver.

int

incrementCounter(CmsDbContext dbc, String name)

Gets the current value of a counter, creates it if it doesn't already exist, and increments it.

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.

void

insertAlias(CmsDbContext dbc, CmsProject project, CmsAlias alias)

Adds an alias to the database.

void

insertRewriteAliases(CmsDbContext dbc, Collection<CmsRewriteAlias> rewriteAliases)

Adds a list of rewrite aliases.

protected int

internalCountProperties(CmsDbContext dbc, CmsPropertyDefinition propertyDefinition, CmsUUID projectId)

Returns the count of properties for a property definition.

protected void

internalCreateCounter(CmsDbContext dbc, String name, int value)

Creates a new counter.

protected CmsUrlNameMappingEntry

internalCreateUrlNameMappingEntry(ResultSet resultSet)

Creates an URL name mapping entry from a result set.

protected void

internalIncrementCounter(CmsDbContext dbc, String name)

Increments a counter.

protected CmsAlias

internalReadAlias(ResultSet resultset)

Helper method to create an alias object from a result set.

protected Integer

internalReadCounter(CmsDbContext dbc, String name)

Reads the current value of a counter.

protected String

internalReadParentId(CmsDbContext dbc, CmsUUID projectId, String resourcename)

Returns the parent id of the given resource.

protected CmsRelation

internalReadRelation(ResultSet res)

Creates a new CmsRelation object from the given result set entry.

protected CmsResourceState

internalReadResourceState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)

Returns the resource state of the given resource.

protected CmsResourceState

internalReadStructureState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)

Returns the structure state of the given resource.

protected void

internalRemoveFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource)

Removes a resource physically in the database.

protected void

internalUpdateVersions(CmsDbContext dbc, CmsResource resource)

Updates the offline version numbers.

protected void

internalValidateResourceLength(CmsResource resource)

Validates that the length setting of a resource is always correct.

protected void

moveRelations(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, String rootPath)

Moves all relations of a resource to the new path.

void

moveResource(CmsDbContext dbc, CmsUUID projectId, CmsResource source, String destinationPath)

Moves the given resource to the specified destination path.

protected void

prepareExpiredTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the expiration date.

protected void

preparePathCondition(CmsUUID projectId, String parent, int mode, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the parentPath.

protected void

prepareProjectCondition(CmsUUID projectId, int mode, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the projectId.

protected String

prepareRelationConditions(CmsUUID projectId, CmsRelationFilter filter, CmsResource resource, List<Object> params, boolean checkSource)

Build the whole WHERE sql statement part for the given relation filter.

protected void

prepareReleasedTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the released date.

protected void

prepareResourceCondition(CmsUUID projectId, int mode, StringBuffer conditions)

Appends the appropriate selection criteria related with the read mode.

protected void

prepareStateCondition(CmsUUID projectId, CmsResourceState state, int mode, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the resource state.

protected void

prepareTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the date of the last modification.

protected void

prepareTypeCondition(CmsUUID projectId, int type, int mode, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the resource type.

protected void

prepareTypesCondition(CmsUUID projectId, List<Integer> types, int mode, StringBuffer conditions, List<Object> params)

Appends the appropriate selection criteria related with the resource type.

static CmsPair<String,List<I_CmsPreparedStatementParameter>>

prepareUrlNameMappingConditions(CmsUrlNameMappingFilter filter)

This method prepares the SQL conditions for mapping entries for a given URL name mapping filter.

void

publishResource(CmsDbContext dbc, CmsProject onlineProject, CmsResource onlineResource, CmsResource offlineResource)

Publishes the structure and resource records of an offline resource into it's online counterpart.

void

publishVersions(CmsDbContext dbc, CmsResource resource, boolean firstSibling)

Copies the version number from the offline resource to the online resource, this has to be done during publishing, direct after copying the resource itself.

List<CmsAlias>

readAliases(CmsDbContext dbc, CmsProject project, CmsAliasFilter filter)

Reads the aliases matching a given filter.

List<CmsResource>

readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles)

Reads all child-files and/or child-folders of a specified parent resource.

byte[]

readContent(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId)

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

CmsFolder

readFolder(CmsDbContext dbc, CmsUUID projectId, String folderPath)

Reads a folder specified by it's resource name.

CmsFolder

readFolder(CmsDbContext dbc, CmsUUID projectId, CmsUUID folderId)

Reads a folder specified by it's structure ID.

List<CmsFolderSizeEntry>

readFolderSizeStats(CmsDbContext dbc, boolean online, CmsFolderSizeOptions options)

Reads folder size statistics for the subtree at a given root path.

CmsFolder

readParentFolder(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId)

Reads the parent folder of a resource specified by it's structure ID.

CmsPropertyDefinition

readPropertyDefinition(CmsDbContext dbc, String name, CmsUUID projectId)

Reads a property definition for the specified resource type.

List<CmsPropertyDefinition>

readPropertyDefinitions(CmsDbContext dbc, CmsUUID projectId)

Reads all property definitions for the specified mapping type.

CmsProperty

readPropertyObject(CmsDbContext dbc, String key, CmsProject project, CmsResource resource)

Reads a property object from the database specified by it's key name mapped to a resource.

List<CmsProperty>

readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource)

Reads all property objects mapped to a specified resource from the database.

List<CmsRelation>

readRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter)

Reads all relations with the given filter for the given resource.

CmsResource

readResource(CmsDbContext dbc, CmsUUID projectId, String path, boolean includeDeleted)

Reads a resource specified by it's resource name.

CmsResource

readResource(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, boolean includeDeleted)

Reads a resource specified by it's structure ID.

List<CmsResource>

readResources(CmsDbContext dbc, CmsUUID projectId, CmsResourceState state, int mode)

Reads all resources inside a given project and with a given state.

List<CmsResource>

readResourcesForPrincipalACE(CmsDbContext dbc, CmsProject project, CmsUUID principalId)

Returns all resources associated to a given principal via an ACE.

List<CmsResource>

readResourcesForPrincipalAttr(CmsDbContext dbc, CmsProject project, CmsUUID principalId)

Returns all resources associated to a given principal through some of following attributes.

List<CmsResource>

readResourcesWithProperty(CmsDbContext dbc, CmsUUID projectId, CmsUUID propertyDef, String path, String value)

Reads all resources that have a value (containing the specified value) set for the specified property (definition), in the given path.

List<CmsResource>

readResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, int type, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode)

Reads all resources inside a given project matching the criteria specified by parameter values.

List<CmsRewriteAlias>

readRewriteAliases(CmsDbContext dbc, CmsRewriteAliasFilter filter)

Reads the rewrite aliases matching a given filter.

List<CmsResource>

readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted)

Reads all siblings that point to the resource record of a specified resource.

protected List<CmsResource>

readTypesInResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, List<Integer> types, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode)

Reads all resources inside a given project matching the criteria specified by parameter values.

List<CmsUrlNameMappingEntry>

readUrlNameMappingEntries(CmsDbContext dbc, boolean online, CmsUrlNameMappingFilter filter)

Reads the URL name mapping entries which match a given filter.

Map<String,Integer>

readVersions(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, CmsUUID structureId)

Reads a resource version numbers.

void

removeFile(CmsDbContext dbc, CmsUUID projectId, CmsResource resource)

Removes a file physically in the database.

void

removeFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource)

Removes a folder physically in the database.

protected void

repairBrokenRelations(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, String rootPath)

Repairs broken links.

void

replaceResource(CmsDbContext dbc, CmsResource newResource, byte[] resContent, int newResourceType)

Replaces the content and properties of an existing resource.

void

setDriverManager(CmsDriverManager driverManager)

Sets the driver manager for this driver if possible.

void

setSqlManager(CmsSqlManager sqlManager)

Sets the SQL manager for this driver if possible.

void

transferResource(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsUUID createdUser, CmsUUID lastModifiedUser)

Transfers the attributes of a resource from to the given users.

protected void

updateBrokenRelations(CmsDbContext dbc, CmsUUID projectId, String rootPath)

Updates broken links.

void

updateRelations(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource)

Updates the relations on the online project copying the relations from the offline project.

boolean

validateResourceIdExists(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId)

Validates if the specified resource ID in the tables of the specified project {offline|online} exists.

boolean

validateStructureIdExists(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId)

Validates if the specified structure ID in the tables of the specified project {offline|online} exists.

protected CmsDbSqlException

wrapException(PreparedStatement stmt, SQLException e)

Wrap a SQL exception into a CmsDbSqlException.

void

writeContent(CmsDbContext dbc, CmsUUID resourceId, byte[] content)

Writes the resource content with the specified resource id.

void

writeLastModifiedProjectId(CmsDbContext dbc, CmsProject project, CmsUUID projectId, CmsResource resource)

Writes the "last-modified-in-project" ID of a resource.

void

writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property)

Writes a property object to the database mapped to a specified resource.

void

writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, List<CmsProperty> properties)

Writes a list of property objects to the database mapped to a specified resource.

void

writeResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int changed)

Writes the structure and/or resource record(s) of an existing file.

void

writeResourceState(CmsDbContext dbc, CmsProject project, CmsResource resource, int changed, boolean isPublishing)

Writes file state in either the structure or resource record, or both of them.

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
- OFFLINE
  
  protected static final String OFFLINE
  
  Contains the macro replacement value for the offline project.
  See Also:
  
  Constant Field Values
- ONLINE
  
  protected static final String ONLINE
  
  Contains the macro replacement value for the online project.
  See Also:
  
  Constant Field Values
- m_driverManager
  
  protected CmsDriverManager m_driverManager
  
  The driver manager.
- m_resOp
  
  protected List<CmsUUID> m_resOp
  
  This field is temporarily used to compute the versions during publishing.
  See Also:
  
  publishVersions(CmsDbContext, CmsResource, boolean)
- m_sqlManager
  
  protected CmsSqlManager m_sqlManager
  
  The sql manager.
Constructor Details
- CmsVfsDriver
  
  public CmsVfsDriver()
Method Details
- prepareUrlNameMappingConditions
  
  public static CmsPair<String,List<I_CmsPreparedStatementParameter>> prepareUrlNameMappingConditions(CmsUrlNameMappingFilter filter)
  
  This method prepares the SQL conditions for mapping entries for a given URL name mapping filter.
  
  Parameters:
  
  filter - the filter from which the SQL conditions should be generated
  
  Returns:
  
  a pair consisting of an SQL string and a list of the prepared statement parameters for the SQL
- escapeDbWildcard
  
  protected static String escapeDbWildcard(String path)
  Escapes the database wildcards within the resource path.
  This method is required to ensure chars in the resource path that have a special meaning in SQL (for example "_", which is the "any char" operator) are escaped.
  It will escape the following chars:
  
  "_" to "|_"
  Parameters:
  
  path - the resource path
  
  Returns:
  
  the escaped resource path
- addUrlNameMappingEntry
  
  public void addUrlNameMappingEntry(CmsDbContext dbc, boolean online, CmsUrlNameMappingEntry entry) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Adds a new URL name mapping entry.
  Specified by:
  
  addUrlNameMappingEntry in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  online - if true, writes to the online tables, else to the offline tables
  
  entry - the entry to add
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.addUrlNameMappingEntry(org.opencms.db.CmsDbContext, boolean, org.opencms.db.urlname.CmsUrlNameMappingEntry)
- countSiblings
  
  public int countSiblings(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId) throws CmsDataAccessException
  
  Counts the number of siblings of a resource.
  
  Specified by:
  
  countSiblings in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the current project id
  
  resourceId - the resource id to count the number of siblings from
  
  Returns:
  
  number of siblings
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- createContent
  
  public void createContent(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, byte[] content) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a content entry for the resource identified by the specified resource id.
  Specified by:
  
  createContent in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the current project
  
  resourceId - the resource id of 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, CmsUUID, byte[])
- createFile
  
  public CmsFile createFile(ResultSet res, CmsUUID projectId) throws SQLException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a CmsFile instance from a JDBC ResultSet.
  Specified by:
  
  createFile in interface I_CmsVfsDriver
  
  Parameters:
  
  res - the JDBC ResultSet
  
  projectId - the project id
  
  Returns:
  
  the created file
  
  Throws:
  
  SQLException - in case the result set does not include a requested table attribute
  
  See Also:
  
  I_CmsVfsDriver.createFile(java.sql.ResultSet, CmsUUID)
- createFile
  
  public CmsFile createFile(ResultSet res, CmsUUID projectId, boolean hasFileContentInResultSet) throws SQLException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a CmsFile instance from a JDBC ResultSet.
  Specified by:
  
  createFile in interface I_CmsVfsDriver
  
  Parameters:
  
  res - the JDBC ResultSet
  
  projectId - the project id
  
  hasFileContentInResultSet - flag to include the file content
  
  Returns:
  
  the created file
  
  Throws:
  
  SQLException - in case the result set does not include a requested table attribute
  
  See Also:
  
  I_CmsVfsDriver.createFile(java.sql.ResultSet, CmsUUID, boolean)
- createFolder
  
  public CmsFolder createFolder(ResultSet res, CmsUUID projectId, boolean hasProjectIdInResultSet) throws SQLException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a CmsFolder instance from a JDBC ResultSet.
  Specified by:
  
  createFolder in interface I_CmsVfsDriver
  
  Parameters:
  
  res - the JDBC ResultSet
  
  projectId - the ID of the current project
  
  hasProjectIdInResultSet - true if the SQL select query includes the PROJECT_ID table attribute
  
  Returns:
  
  the created folder
  
  Throws:
  
  SQLException - in case the result set does not include a requested table attribute
  
  See Also:
  
  I_CmsVfsDriver.createFolder(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
  
  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)
- createPropertyDefinition
  
  public CmsPropertyDefinition createPropertyDefinition(CmsDbContext dbc, CmsUUID projectId, String name, CmsPropertyDefinition.CmsPropertyType type) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a new property definition in the database.
  Specified by:
  
  createPropertyDefinition in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project in which the property definition is created
  
  name - the name of the property definition
  
  type - the type of the property definition
  
  Returns:
  
  the new property definition
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.createPropertyDefinition(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, java.lang.String, org.opencms.file.CmsPropertyDefinition.CmsPropertyType)
- createRelation
  
  public void createRelation(CmsDbContext dbc, CmsUUID projectId, CmsRelation relation) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a new CmsRelation object in the database.
  Specified by:
  
  createRelation in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project to execute the query in
  
  relation - the relation to create
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.createRelation(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.relations.CmsRelation)
- createResource
  
  public CmsResource createResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, byte[] content) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a new resource from a given CmsResource object.
  This method works for both files and folders. Existing resources get overwritten.
  Specified by:
  
  createResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the current project
  
  resource - the resource to be created
  
  content - the file content, or null in case of a folder
  
  Returns:
  
  the created Cms resource
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.createResource(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.file.CmsResource, byte[])
- createResource
  
  public CmsResource createResource(ResultSet res, CmsUUID projectId) throws SQLException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a CmsResource instance from a JDBC ResultSet.
  Specified by:
  
  createResource in interface I_CmsVfsDriver
  
  Parameters:
  
  res - the JDBC ResultSet
  
  projectId - the ID of the current project to adjust the modification date in case the resource is a VFS link
  
  Returns:
  
  the created resource
  
  Throws:
  
  SQLException - in case the result set does not include a requested table attribute
  
  See Also:
  
  I_CmsVfsDriver.createResource(java.sql.ResultSet, CmsUUID)
- createSibling
  
  public void createSibling(CmsDbContext dbc, CmsProject project, CmsResource resource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Creates a new sibling for a specified resource.
  Specified by:
  
  createSibling in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the project where to create the link
  
  resource - the link prototype
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.createSibling(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource)
- deleteAliases
  
  public void deleteAliases(CmsDbContext dbc, CmsProject project, CmsAliasFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes the aliases matching a given filter.
  Specified by:
  
  deleteAliases in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the database context
  
  project - the current project
  
  filter - the alias filter
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deleteAliases(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.db.CmsAliasFilter)
- deletePropertyDefinition
  
  public void deletePropertyDefinition(CmsDbContext dbc, CmsPropertyDefinition metadef) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes a property definition.
  Specified by:
  
  deletePropertyDefinition in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  metadef - the property definitions to be deleted
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deletePropertyDefinition(org.opencms.db.CmsDbContext, org.opencms.file.CmsPropertyDefinition)
- deletePropertyObjects
  
  public void deletePropertyObjects(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int deleteOption) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes all property values of a file or folder.
  You may specify which whether just structure or resource property values should be deleted, or both of them.
  Specified by:
  
  deletePropertyObjects in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project
  
  resource - the resource
  
  deleteOption - determines which property values should be deleted
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deletePropertyObjects(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.file.CmsResource, int)
- deleteRelations
  
  public void deleteRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes all relations with the given filter for the given resource.
  Specified by:
  
  deleteRelations in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project to execute the query in
  
  resource - the base resource. May be null for all
  
  filter - the filter to restrict the relations to remove
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deleteRelations(org.opencms.db.CmsDbContext, CmsUUID, CmsResource, org.opencms.relations.CmsRelationFilter)
- deleteRewriteAliases
  
  public void deleteRewriteAliases(CmsDbContext dbc, CmsRewriteAliasFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes rewrite aliases matching a given filter.
  Specified by:
  
  deleteRewriteAliases in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  filter - the filter describing which rewrite aliases to delete
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deleteRewriteAliases(org.opencms.db.CmsDbContext, org.opencms.db.CmsRewriteAliasFilter)
- deleteUrlNameMappingEntries
  
  public void deleteUrlNameMappingEntries(CmsDbContext dbc, boolean online, CmsUrlNameMappingFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Deletes the URL name mapping entries which match a given filter.
  Specified by:
  
  deleteUrlNameMappingEntries in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  online - if true, changes the online URL name mappings, else the offline URL name mappings
  
  filter - the URL name mapping entries to delete
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.deleteUrlNameMappingEntries(org.opencms.db.CmsDbContext, boolean, org.opencms.db.urlname.CmsUrlNameMappingFilter)
- destroy
  
  public void destroy() throws Throwable
  
  Description copied from interface: I_CmsVfsDriver
  
  Destroys this driver.
  Specified by:
  
  destroy in interface I_CmsVfsDriver
  
  Throws:
  
  Throwable - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.destroy()
- getResourceOus
  
  public List<CmsOrganizationalUnit> getResourceOus(CmsDbContext dbc, CmsUUID projectId, CmsResource resource) throws CmsDbSqlException
  
  Returns all organizational units for the given resource.
  
  Specified by:
  
  getResourceOus in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the database context
  
  projectId - the id of the project
  
  resource - the resource
  
  Returns:
  
  a list of CmsOrganizationalUnit objects
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- getSqlManager
  
  public CmsSqlManager getSqlManager()
  
  Description copied from interface: I_CmsVfsDriver
  
  Returns the SqlManager of this driver.
  Specified by:
  
  getSqlManager in interface I_CmsVfsDriver
  
  Returns:
  
  the SqlManager of this driver
  
  See Also:
  
  I_CmsVfsDriver.getSqlManager()
- incrementCounter
  
  public int incrementCounter(CmsDbContext dbc, String name) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Gets the current value of a counter, creates it if it doesn't already exist, and increments it.
  Specified by:
  
  incrementCounter in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the database context
  
  name - the name of the counter
  
  Returns:
  
  the counter value before incrementing
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.incrementCounter(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
  
  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
  
  Parameters:
  
  classname - the class name of the SQL manager
  
  Returns:
  
  the SQL manager for this driver
  
  See Also:
  
  I_CmsVfsDriver.initSqlManager(String)
- insertAlias
  
  public void insertAlias(CmsDbContext dbc, CmsProject project, CmsAlias alias) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Adds an alias to the database.
  Specified by:
  
  insertAlias in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  alias - the alias to write
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.insertAlias(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.db.CmsAlias)
- insertRewriteAliases
  
  public void insertRewriteAliases(CmsDbContext dbc, Collection<CmsRewriteAlias> rewriteAliases) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Adds a list of rewrite aliases.
  When adding a rewrite alias, make sure that no alias with the same id is present in the database.
  Specified by:
  
  insertRewriteAliases in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  rewriteAliases - the rewrite aliases to save
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.insertRewriteAliases(org.opencms.db.CmsDbContext, java.util.Collection)
- moveResource
  
  public void moveResource(CmsDbContext dbc, CmsUUID projectId, CmsResource source, String destinationPath) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Moves the given resource to the specified destination path.
  Specified by:
  
  moveResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the Id of the project
  
  source - the resource to move
  
  destinationPath - the root path of the destination resource
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.moveResource(CmsDbContext, CmsUUID, CmsResource, String)
- publishResource
  
  public void publishResource(CmsDbContext dbc, CmsProject onlineProject, CmsResource onlineResource, CmsResource offlineResource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Publishes the structure and resource records of an offline resource into it's online counterpart.
  Specified by:
  
  publishResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  onlineProject - the online project
  
  onlineResource - the online resource
  
  offlineResource - the offline resource
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.publishResource(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, org.opencms.file.CmsResource)
- publishVersions
  
  public void publishVersions(CmsDbContext dbc, CmsResource resource, boolean firstSibling) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Copies the version number from the offline resource to the online resource, this has to be done during publishing, direct after copying the resource itself.
  Specified by:
  
  publishVersions in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  resource - the resource that has been publish
  
  firstSibling - if this is the first sibling to be publish
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.publishVersions(org.opencms.db.CmsDbContext, org.opencms.file.CmsResource, boolean)
- readAliases
  
  public List<CmsAlias> readAliases(CmsDbContext dbc, CmsProject project, CmsAliasFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads the aliases matching a given filter.
  Specified by:
  
  readAliases in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the database context
  
  project - the current project
  
  filter - the alias filter
  
  Returns:
  
  the list of aliases which were read
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readAliases(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.db.CmsAliasFilter)
- readChildResources
  
  public List<CmsResource> readChildResources(CmsDbContext dbc, CmsProject currentProject, CmsResource resource, boolean getFolders, boolean getFiles) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all child-files and/or child-folders of a specified parent resource.
  Specified by:
  
  readChildResources in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  currentProject - the current project
  
  resource - the parent folder
  
  getFolders - if true the child folders of the parent folder are returned in the result set
  
  getFiles - if true the child files of the parent folder are returned in the result set
  
  Returns:
  
  a list of all sub folders or sub files
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readChildResources(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, boolean, boolean)
- 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
  
  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)
- readFolder
  
  public CmsFolder readFolder(CmsDbContext dbc, CmsUUID projectId, CmsUUID folderId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a folder specified by it's structure ID.
  Specified by:
  
  readFolder in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project in which the resource will be used
  
  folderId - the structure id of the folder to be read
  
  Returns:
  
  the read folder
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readFolder(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID)
- readFolder
  
  public CmsFolder readFolder(CmsDbContext dbc, CmsUUID projectId, String folderPath) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a folder specified by it's resource name.
  Specified by:
  
  readFolder in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project in which the resource will be used
  
  folderPath - the name of the folder to be read
  
  Returns:
  
  the read folder
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readFolder(org.opencms.db.CmsDbContext, CmsUUID, java.lang.String)
- readFolderSizeStats
  
  public List<CmsFolderSizeEntry> readFolderSizeStats(CmsDbContext dbc, boolean online, CmsFolderSizeOptions options) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads folder size statistics for the subtree at a given root path.
  
  Specified by:
  
  readFolderSizeStats in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - tje database context
  
  online - true if we want the online data, false for the offline data
  
  options - the options on what exactly to read
  
  Returns:
  
  the list of folder size beans
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- readParentFolder
  
  public CmsFolder readParentFolder(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads the parent folder of a resource specified by it's structure ID.
  The parent folder for the root '/' is defined as null.
  Specified by:
  
  readParentFolder in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project in which the resource will be used
  
  structureId - the id of the resource to read the parent folder for
  
  Returns:
  
  the read folder, or null
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readParentFolder(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID)
- readPropertyDefinition
  
  public CmsPropertyDefinition readPropertyDefinition(CmsDbContext dbc, String name, CmsUUID projectId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a property definition for the specified resource type.
  If no property definition with the given name is found, null is returned.
  Specified by:
  
  readPropertyDefinition in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  name - the name of the property definition to read
  
  projectId - the id of the project
  
  Returns:
  
  the property definition that was read
  
  Throws:
  
  CmsDataAccessException - a CmsDbEntryNotFoundException is thrown if the property definition does not exist
  
  See Also:
  
  I_CmsVfsDriver.readPropertyDefinition(org.opencms.db.CmsDbContext, java.lang.String, CmsUUID)
- readPropertyDefinitions
  
  public List<CmsPropertyDefinition> readPropertyDefinitions(CmsDbContext dbc, CmsUUID projectId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all property definitions for the specified mapping type.
  Specified by:
  
  readPropertyDefinitions in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project
  
  Returns:
  
  a list with the CmsPropertyDefinition objects (may be empty)
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readPropertyDefinitions(org.opencms.db.CmsDbContext, CmsUUID)
- readPropertyObject
  
  public CmsProperty readPropertyObject(CmsDbContext dbc, String key, CmsProject project, CmsResource resource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a property object from the database specified by it's key name mapped to a resource.
  The implementation must return CmsProperty.getNullProperty() if the property is not found.
  TODO: change project parameter to project id
  Specified by:
  
  readPropertyObject in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  key - the key of the property
  
  project - the current project
  
  resource - the resource where the property is attached to
  
  Returns:
  
  a CmsProperty object containing both the structure and resource value of the property
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readPropertyObject(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsProject, org.opencms.file.CmsResource)
- readPropertyObjects
  
  public List<CmsProperty> readPropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all property objects mapped to a specified resource from the database.
  The implementation must return an empty list if no properties are found at all.
  TODO: change project parameter to project id
  Specified by:
  
  readPropertyObjects in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  resource - the resource where the property is attached to
  
  Returns:
  
  a list with CmsProperty objects containing both the structure and resource value of the property
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readPropertyObjects(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource)
- readRelations
  
  public List<CmsRelation> readRelations(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, CmsRelationFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all relations with the given filter for the given resource.
  Specified by:
  
  readRelations in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project to execute the query in
  
  resource - the resource to read the relations for, may be null for all
  
  filter - the filter to restrict the relations to retrieve
  
  Returns:
  
  the read relations
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readRelations(org.opencms.db.CmsDbContext, CmsUUID, CmsResource, org.opencms.relations.CmsRelationFilter)
- readResource
  
  public CmsResource readResource(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, boolean includeDeleted) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a resource specified by it's structure ID.
  Specified by:
  
  readResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the Id of the project
  
  structureId - the Id of the resource
  
  includeDeleted - true if already deleted files are included
  
  Returns:
  
  the resource that was read
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResource(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID, boolean)
- readResource
  
  public CmsResource readResource(CmsDbContext dbc, CmsUUID projectId, String path, boolean includeDeleted) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a resource specified by it's resource name.
  Specified by:
  
  readResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the Id of the project in which the resource will be used
  
  path - the name of the file
  
  includeDeleted - true if already deleted files are included
  
  Returns:
  
  the resource that was read
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResource(org.opencms.db.CmsDbContext, CmsUUID, java.lang.String, boolean)
- readResources
  
  public List<CmsResource> readResources(CmsDbContext dbc, CmsUUID projectId, CmsResourceState state, int mode) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all resources inside a given project and with a given state.
  Specified by:
  
  readResources in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the current project
  
  state - the state to match
  
  mode - flag signaling the read mode
  
  Returns:
  
  a list with all resources that where read
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResources(org.opencms.db.CmsDbContext, CmsUUID, CmsResourceState, int)
- readResourcesForPrincipalACE
  
  public List<CmsResource> readResourcesForPrincipalACE(CmsDbContext dbc, CmsProject project, CmsUUID principalId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Returns all resources associated to a given principal via an ACE.
  Specified by:
  
  readResourcesForPrincipalACE in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the to read the entries from
  
  principalId - the id of the principal
  
  Returns:
  
  a list of CmsResource objects
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResourcesForPrincipalACE(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID)
- readResourcesForPrincipalAttr
  
  public List<CmsResource> readResourcesForPrincipalAttr(CmsDbContext dbc, CmsProject project, CmsUUID principalId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  Returns all resources associated to a given principal through some of following attributes.
  
  User Created
  
  User Last Modified
  Specified by:
  
  readResourcesForPrincipalAttr in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the to read the entries from
  
  principalId - the id of the principal
  
  Returns:
  
  a list of CmsResource objects
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResourcesForPrincipalAttr(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.util.CmsUUID)
- readResourcesWithProperty
  
  public List<CmsResource> readResourcesWithProperty(CmsDbContext dbc, CmsUUID projectId, CmsUUID propertyDef, String path, String value) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all resources that have a value (containing the specified value) set for the specified property (definition), in the given path.
  Both individual and shared properties of a resource are checked.
  If the value parameter is null, all resources having the given property set are returned.
  Specified by:
  
  readResourcesWithProperty in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project
  
  propertyDef - the id of the property definition
  
  path - the folder to get the resources with the property from
  
  value - the string to search in the value of the property
  
  Returns:
  
  a list of all CmsResource objects that have a value set for the specified property.
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResourcesWithProperty(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID, String, String)
- readResourceTree
  
  public List<CmsResource> readResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, int type, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all resources inside a given project matching the criteria specified by parameter values.
  Important: If CmsDriverManager.READMODE_EXCLUDE_TREE is true (or CmsDriverManager.READMODE_INCLUDE_TREE is false), the provided parent String must be the UUID of the parent folder, NOT the parent folder path.
  Specified by:
  
  readResourceTree in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project id for matching resources
  
  parentPath - the path to the resource used as root of the searched subtree or CmsDriverManager.READ_IGNORE_PARENT, CmsDriverManager.READMODE_EXCLUDE_TREE means to read immediate children only
  
  type - the resource type of matching resources or CmsDriverManager.READ_IGNORE_TYPE (meaning inverted by CmsDriverManager.READMODE_EXCLUDE_TYPE
  
  state - the state of matching resources (meaning inverted by CmsDriverManager.READMODE_EXCLUDE_STATE or null to ignore
  
  lastModifiedAfter - the start of the time range for the last modification date of matching resources or READ_IGNORE_TIME
  
  lastModifiedBefore - the end of the time range for the last modification date of matching resources or READ_IGNORE_TIME
  
  releasedAfter - the start of the time range for the release date of matching resources
  
  releasedBefore - the end of the time range for the release date of matching resources
  
  expiredAfter - the start of the time range for the expire date of matching resources
  
  expiredBefore - the end of the time range for the expire date of matching resources
  
  mode - additional mode flags:
  
  CmsDriverManager.READMODE_INCLUDE_TREE
  CmsDriverManager.READMODE_EXCLUDE_TREE
  CmsDriverManager.READMODE_INCLUDE_PROJECT
  CmsDriverManager.READMODE_EXCLUDE_TYPE
  CmsDriverManager.READMODE_EXCLUDE_STATE
  
  Returns:
  
  a list of CmsResource objects matching the given criteria
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readResourceTree(org.opencms.db.CmsDbContext, CmsUUID, java.lang.String, int, CmsResourceState, long, long, long, long, long, long, int)
- readRewriteAliases
  
  public List<CmsRewriteAlias> readRewriteAliases(CmsDbContext dbc, CmsRewriteAliasFilter filter) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads the rewrite aliases matching a given filter.
  Specified by:
  
  readRewriteAliases in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  filter - the filter describing which rewrite aliases should be returned
  
  Returns:
  
  the rewrite aliases which were found
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readRewriteAliases(org.opencms.db.CmsDbContext, org.opencms.db.CmsRewriteAliasFilter)
- readSiblings
  
  public List<CmsResource> readSiblings(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, boolean includeDeleted) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads all siblings that point to the resource record of a specified resource.
  Specified by:
  
  readSiblings in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the current project
  
  resource - the specified resource
  
  includeDeleted - true if deleted siblings should be included in the result list
  
  Returns:
  
  a list of CmsResources that are siblings to the specified resource, including the specified resource itself.
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readSiblings(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.file.CmsResource, boolean)
- readUrlNameMappingEntries
  
  public List<CmsUrlNameMappingEntry> readUrlNameMappingEntries(CmsDbContext dbc, boolean online, CmsUrlNameMappingFilter filter) throws CmsDataAccessException
  
  Reads the URL name mapping entries which match a given filter.
  
  Specified by:
  
  readUrlNameMappingEntries in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the database context
  
  online - if true, reads from the online mapping, else from the offline mapping
  
  filter - the filter which the entries to be read should match
  
  Returns:
  
  the mapping entries which match the given filter
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- readVersions
  
  public Map<String,Integer> readVersions(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId, CmsUUID structureId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Reads a resource version numbers.
  Specified by:
  
  readVersions in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project to read the versions from
  
  resourceId - the resource id of the resource to read the versions from
  
  structureId - the structure id of the resource to read the versions from
  
  Returns:
  
  a map with two entries with keys "structure" and "resource" for the structure and resource version number respectively, the values are Integer objects and may be -1 if an entry could be found
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.readVersions(org.opencms.db.CmsDbContext, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
- 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
  
  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)
- removeFolder
  
  public void removeFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Removes a folder physically in the database.
  Specified by:
  
  removeFolder in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  currentProject - the current project
  
  resource - the folder
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.removeFolder(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource)
- replaceResource
  
  public void replaceResource(CmsDbContext dbc, CmsResource newResource, byte[] resContent, int newResourceType) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Replaces the content and properties of an existing resource.
  Specified by:
  
  replaceResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  newResource - the new resource
  
  resContent - the new content
  
  newResourceType - the resource type
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.replaceResource(org.opencms.db.CmsDbContext, org.opencms.file.CmsResource, byte[], int)
- setDriverManager
  
  public void setDriverManager(CmsDriverManager driverManager)
  
  Description copied from interface: I_CmsVfsDriver
  
  Sets the driver manager for this driver if possible.
  Specified by:
  
  setDriverManager in interface I_CmsVfsDriver
  
  Parameters:
  
  driverManager - the new driver manager
  
  See Also:
  
  I_CmsVfsDriver.setDriverManager(org.opencms.db.CmsDriverManager)
- setSqlManager
  
  public void setSqlManager(CmsSqlManager sqlManager)
  
  Description copied from interface: I_CmsVfsDriver
  
  Sets the SQL manager for this driver if possible.
  Specified by:
  
  setSqlManager in interface I_CmsVfsDriver
  
  Parameters:
  
  sqlManager - the new SQL manager
  
  See Also:
  
  I_CmsVfsDriver.setSqlManager(org.opencms.db.CmsSqlManager)
- transferResource
  
  public void transferResource(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsUUID createdUser, CmsUUID lastModifiedUser) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Transfers the attributes of a resource from to the given users.
  Specified by:
  
  transferResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  resource - the resource to modify
  
  createdUser - the id of the user to be set as the creator of the resource
  
  lastModifiedUser - the id of the user to be set as the last modificator of the resource
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.transferResource(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, org.opencms.util.CmsUUID, org.opencms.util.CmsUUID)
- updateRelations
  
  public void updateRelations(CmsDbContext dbc, CmsProject onlineProject, CmsResource offlineResource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Updates the relations on the online project copying the relations from the offline project.
  TODO: add offlineProject parameter
  Specified by:
  
  updateRelations in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  onlineProject - the online project
  
  offlineResource - the resource to update the relations for
  
  Throws:
  
  CmsDataAccessException - is something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.updateRelations(CmsDbContext, CmsProject, CmsResource)
- validateResourceIdExists
  
  public boolean validateResourceIdExists(CmsDbContext dbc, CmsUUID projectId, CmsUUID resourceId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Validates if the specified resource ID in the tables of the specified project {offline|online} exists.
  Specified by:
  
  validateResourceIdExists in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project id
  
  resourceId - the resource id to test for
  
  Returns:
  
  true if a resource with the given id was found, false otherwise
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.validateResourceIdExists(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID)
- validateStructureIdExists
  
  public boolean validateStructureIdExists(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Validates if the specified structure ID in the tables of the specified project {offline|online} exists.
  Specified by:
  
  validateStructureIdExists in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the ID of current project
  
  structureId - the structure id
  
  Returns:
  
  true, if the specified structure ID in the tables of the specified project {offline|online} exists
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.validateStructureIdExists(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.util.CmsUUID)
- writeContent
  
  public void writeContent(CmsDbContext dbc, CmsUUID resourceId, byte[] content) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes the resource content with the specified resource id.
  Specified by:
  
  writeContent in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  resourceId - the id of 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.util.CmsUUID, byte[])
- writeLastModifiedProjectId
  
  public void writeLastModifiedProjectId(CmsDbContext dbc, CmsProject project, CmsUUID projectId, CmsResource resource) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes the "last-modified-in-project" ID of a resource.
  Specified by:
  
  writeLastModifiedProjectId in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the resource record is updated with the ID of this project
  
  projectId - the project id to write into the resource
  
  resource - the resource that gets updated
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.writeLastModifiedProjectId(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, CmsUUID, org.opencms.file.CmsResource)
- writePropertyObject
  
  public void writePropertyObject(CmsDbContext dbc, CmsProject project, CmsResource resource, CmsProperty property) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes a property object to the database mapped to a specified resource.
  Specified by:
  
  writePropertyObject in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  resource - the resource where the property should be attached to
  
  property - a CmsProperty object containing both the structure and resource value of the property
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.writePropertyObject(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, org.opencms.file.CmsProperty)
- writePropertyObjects
  
  public void writePropertyObjects(CmsDbContext dbc, CmsProject project, CmsResource resource, List<CmsProperty> properties) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes a list of property objects to the database mapped to a specified resource.
  Specified by:
  
  writePropertyObjects in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  resource - the resource where the property should be attached to
  
  properties - a list of CmsProperty objects
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.writePropertyObjects(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, java.util.List)
- writeResource
  
  public void writeResource(CmsDbContext dbc, CmsUUID projectId, CmsResource resource, int changed) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes the structure and/or resource record(s) of an existing file.
  Common usages of this method are saving the resource information after creating, importing or restoring complete files where all file header attributes are changed. Both the structure and resource records get written. Thus, using this method affects all siblings of a resource! Use I_CmsVfsDriver.writeResourceState(CmsDbContext, CmsProject, CmsResource, int, boolean) instead if you just want to update the file state, e.g. of a single sibling.
  The file state is set to "changed", unless the current state is "new" or "deleted". The "changed" argument allows to choose whether the structure or resource state, or none of them, is set to "changed".
  The rating of the file state values is as follows:
  unchanged < changed < new < deleted
  Second, the "state" of the resource is the structure state, if the structure state has a higher file state value than the resource state. Otherwise the file state is the resource state.
  Specified by:
  
  writeResource in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the current project
  
  resource - the resource to be updated
  
  changed - determines whether the structure or resource state, or none of them, is set to "changed"
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.writeResource(org.opencms.db.CmsDbContext, CmsUUID, org.opencms.file.CmsResource, int)
- writeResourceState
  
  public void writeResourceState(CmsDbContext dbc, CmsProject project, CmsResource resource, int changed, boolean isPublishing) throws CmsDataAccessException
  
  Description copied from interface: I_CmsVfsDriver
  
  Writes file state in either the structure or resource record, or both of them.
  This method allows to change the resource state to any state by setting the desired state value in the specified CmsResource instance.
  This method is frequently used while resources are published to set the file state back to "unchanged".
  Only file state attributes. get updated here. Use I_CmsVfsDriver.writeResource(CmsDbContext, CmsUUID, CmsResource, int) instead to write the complete file header.
  Please refer to the javadoc of I_CmsVfsDriver.writeResource(CmsDbContext, CmsUUID, CmsResource, int) to read how setting resource state values affects the file state.
  Specified by:
  
  writeResourceState in interface I_CmsVfsDriver
  
  Parameters:
  
  dbc - the current database context
  
  project - the current project
  
  resource - the resource to be updated
  
  changed - determines whether the structure or resource state, or none of them, is set to "changed"
  
  isPublishing - if this method is called during publishing to version numbers are updated
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
  
  See Also:
  
  I_CmsVfsDriver.writeResourceState(org.opencms.db.CmsDbContext, org.opencms.file.CmsProject, org.opencms.file.CmsResource, int, boolean)
- checkWritePermissionsInFolder
  
  protected void checkWritePermissionsInFolder(CmsDbContext dbc, CmsResource folder) throws CmsDataAccessException
  
  Checks that the current user has write permissions for all subresources of the given folder.
  
  Parameters:
  
  dbc - the current database context
  
  folder - the folder to check
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- internalCountProperties
  
  protected int internalCountProperties(CmsDbContext dbc, CmsPropertyDefinition propertyDefinition, CmsUUID projectId) throws CmsDataAccessException
  
  Returns the count of properties for a property definition.
  
  Parameters:
  
  dbc - the current database context
  
  propertyDefinition - the property definition to test
  
  projectId - the ID of the current project
  
  Returns:
  
  the amount of properties for a property definition
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- internalCreateCounter
  
  protected void internalCreateCounter(CmsDbContext dbc, String name, int value) throws CmsDbSqlException
  
  Creates a new counter.
  
  Parameters:
  
  dbc - the database context
  
  name - the name of the counter to create
  
  value - the inital value of the counter
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- internalCreateUrlNameMappingEntry
  
  protected CmsUrlNameMappingEntry internalCreateUrlNameMappingEntry(ResultSet resultSet) throws SQLException
  
  Creates an URL name mapping entry from a result set.
  
  Parameters:
  
  resultSet - a result set
  
  Returns:
  
  the URL name mapping entry created from the result set
  
  Throws:
  
  SQLException - if something goes wrong
- internalIncrementCounter
  
  protected void internalIncrementCounter(CmsDbContext dbc, String name) throws CmsDbSqlException
  
  Increments a counter.
  
  Parameters:
  
  dbc - the current db context
  
  name - the name of the counter which should be incremented
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- internalReadAlias
  
  protected CmsAlias internalReadAlias(ResultSet resultset) throws SQLException
  
  Helper method to create an alias object from a result set.
  
  Parameters:
  
  resultset - the result set
  
  Returns:
  
  the alias object created from the result set
  
  Throws:
  
  SQLException - if something goes wrong
- internalReadCounter
  
  protected Integer internalReadCounter(CmsDbContext dbc, String name) throws CmsDbSqlException
  
  Reads the current value of a counter.
  
  Parameters:
  
  dbc - the database context
  
  name - the name of the counter
  
  Returns:
  
  the current value of the counter, or null if the counter was not found
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- internalReadParentId
  
  protected String internalReadParentId(CmsDbContext dbc, CmsUUID projectId, String resourcename) throws CmsDataAccessException
  
  Returns the parent id of the given resource.
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the current project id
  
  resourcename - the resource name to read the parent id for
  
  Returns:
  
  the parent id of the given resource
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- internalReadRelation
  
  protected CmsRelation internalReadRelation(ResultSet res) throws SQLException
  
  Creates a new CmsRelation object from the given result set entry.
  
  Parameters:
  
  res - the result set
  
  Returns:
  
  the new CmsRelation object
  
  Throws:
  
  SQLException - if something goes wrong
- internalReadResourceState
  
  protected CmsResourceState internalReadResourceState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource) throws CmsDbSqlException
  
  Returns the resource state of the given resource.
  
  Parameters:
  
  dbc - the database context
  
  projectId - the id of the project
  
  resource - the resource to read the resource state for
  
  Returns:
  
  the resource state of the given resource
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- internalReadStructureState
  
  protected CmsResourceState internalReadStructureState(CmsDbContext dbc, CmsUUID projectId, CmsResource resource) throws CmsDbSqlException
  
  Returns the structure state of the given resource.
  
  Parameters:
  
  dbc - the database context
  
  projectId - the id of the project
  
  resource - the resource to read the structure state for
  
  Returns:
  
  the structure state of the given resource
  
  Throws:
  
  CmsDbSqlException - if something goes wrong
- internalRemoveFolder
  
  protected void internalRemoveFolder(CmsDbContext dbc, CmsProject currentProject, CmsResource resource) throws CmsDataAccessException
  
  Removes a resource physically in the database.
  
  Parameters:
  
  dbc - the current database context
  
  currentProject - the current project
  
  resource - the folder to remove
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- internalUpdateVersions
  
  protected void internalUpdateVersions(CmsDbContext dbc, CmsResource resource) throws CmsDataAccessException
  
  Updates the offline version numbers.
  
  Parameters:
  
  dbc - the current database context
  
  resource - the resource to update the version number for
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- internalValidateResourceLength
  
  protected void internalValidateResourceLength(CmsResource resource) throws CmsDataAccessException
  
  Validates that the length setting of a resource is always correct.
  Files need to have a resource length of >= 0, while folders require a resource length of -1.
  
  Parameters:
  
  resource - the resource to check the length for
  
  Throws:
  
  CmsDataAccessException - if the resource length is not correct
- moveRelations
  
  protected void moveRelations(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, String rootPath) throws CmsDataAccessException
  
  Moves all relations of a resource to the new path.
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the id of the project to apply the changes
  
  structureId - the structure id of the resource to apply the changes to
  
  rootPath - the new root path
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- prepareExpiredTimeRangeCondition
  
  protected void prepareExpiredTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the expiration date.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  startTime - the start time
  
  endTime - the end time
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- preparePathCondition
  
  protected void preparePathCondition(CmsUUID projectId, String parent, int mode, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the parentPath.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  parent - the parent path or UUID (if mode is C_READMODE_EXCLUDE_TREE)
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareProjectCondition
  
  protected void prepareProjectCondition(CmsUUID projectId, int mode, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the projectId.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareRelationConditions
  
  protected String prepareRelationConditions(CmsUUID projectId, CmsRelationFilter filter, CmsResource resource, List<Object> params, boolean checkSource)
  
  Build the whole WHERE sql statement part for the given relation filter.
  
  Parameters:
  
  projectId - the current project id
  
  filter - the filter
  
  resource - the resource (may be null, if you want to delete all relations for the resource in the filter)
  
  params - the parameter values (return parameter)
  
  checkSource - if the query is for the source relations
  
  Returns:
  
  the WHERE sql statement part string
- prepareReleasedTimeRangeCondition
  
  protected void prepareReleasedTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the released date.
  
  Parameters:
  
  projectId - the id of the project
  
  startTime - the start time
  
  endTime - the stop time
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareResourceCondition
  
  protected void prepareResourceCondition(CmsUUID projectId, int mode, StringBuffer conditions)
  
  Appends the appropriate selection criteria related with the read mode.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
- prepareStateCondition
  
  protected void prepareStateCondition(CmsUUID projectId, CmsResourceState state, int mode, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the resource state.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  state - the resource state
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareTimeRangeCondition
  
  protected void prepareTimeRangeCondition(CmsUUID projectId, long startTime, long endTime, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the date of the last modification.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  startTime - start of the time range
  
  endTime - end of the time range
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareTypeCondition
  
  protected void prepareTypeCondition(CmsUUID projectId, int type, int mode, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the resource type.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  type - the resource type
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- prepareTypesCondition
  
  protected void prepareTypesCondition(CmsUUID projectId, List<Integer> types, int mode, StringBuffer conditions, List<Object> params)
  
  Appends the appropriate selection criteria related with the resource type.
  
  Parameters:
  
  projectId - the id of the project of the resources
  
  types - the resource type id's
  
  mode - the selection mode
  
  conditions - buffer to append the selection criteria
  
  params - list to append the selection parameters
- readTypesInResourceTree
  
  protected List<CmsResource> readTypesInResourceTree(CmsDbContext dbc, CmsUUID projectId, String parentPath, List<Integer> types, CmsResourceState state, long lastModifiedAfter, long lastModifiedBefore, long releasedAfter, long releasedBefore, long expiredAfter, long expiredBefore, int mode) throws CmsDataAccessException
  
  Reads all resources inside a given project matching the criteria specified by parameter values.
  Important: If CmsDriverManager.READMODE_EXCLUDE_TREE is true (or CmsDriverManager.READMODE_INCLUDE_TREE is false), the provided parent String must be the UUID of the parent folder, NOT the parent folder path.
  Parameters:
  
  dbc - the current database context
  
  projectId - the project id for matching resources
  
  parentPath - the path to the resource used as root of the searched subtree or CmsDriverManager.READ_IGNORE_PARENT, CmsDriverManager.READMODE_EXCLUDE_TREE means to read immediate children only
  
  types - the resource types of matching resources or null (meaning inverted by CmsDriverManager.READMODE_EXCLUDE_TYPE
  
  state - the state of matching resources (meaning inverted by CmsDriverManager.READMODE_EXCLUDE_STATE or null to ignore
  
  lastModifiedAfter - the start of the time range for the last modification date of matching resources or READ_IGNORE_TIME
  
  lastModifiedBefore - the end of the time range for the last modification date of matching resources or READ_IGNORE_TIME
  
  releasedAfter - the start of the time range for the release date of matching resources
  
  releasedBefore - the end of the time range for the release date of matching resources
  
  expiredAfter - the start of the time range for the expire date of matching resources
  
  expiredBefore - the end of the time range for the expire date of matching resources
  
  mode - additional mode flags:
  
  CmsDriverManager.READMODE_INCLUDE_TREE
  CmsDriverManager.READMODE_EXCLUDE_TREE
  CmsDriverManager.READMODE_INCLUDE_PROJECT
  CmsDriverManager.READMODE_EXCLUDE_TYPE
  CmsDriverManager.READMODE_EXCLUDE_STATE
  
  Returns:
  
  a list of CmsResource objects matching the given criteria
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- repairBrokenRelations
  
  protected void repairBrokenRelations(CmsDbContext dbc, CmsUUID projectId, CmsUUID structureId, String rootPath) throws CmsDataAccessException
  
  Repairs broken links.
  When a resource is created any relation pointing to it is updated to use the right id.
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project id
  
  structureId - the structure id of the resource that may help to repair broken links
  
  rootPath - the path of the resource that may help to repair broken links
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- updateBrokenRelations
  
  protected void updateBrokenRelations(CmsDbContext dbc, CmsUUID projectId, String rootPath) throws CmsDataAccessException
  
  Updates broken links.
  When a resource is deleted, then the relations pointing to the deleted resource are set to the null uuid.
  
  Parameters:
  
  dbc - the current database context
  
  projectId - the project id
  
  rootPath - the root path of the resource that has been deleted
  
  Throws:
  
  CmsDataAccessException - if something goes wrong
- wrapException
  
  protected CmsDbSqlException wrapException(PreparedStatement stmt, SQLException e)
  
  Wrap a SQL exception into a CmsDbSqlException.
  
  Parameters:
  
  stmt - the used statement
  
  e - the exception
  
  Returns:
  
  the CmsDbSqlException

Class CmsVfsDriver

Field Summary

Fields inherited from interface org.opencms.db.I_CmsDriver

Fields inherited from interface org.opencms.db.I_CmsVfsDriver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.opencms.db.I_CmsDriver

Field Details

OFFLINE

ONLINE

m_driverManager

m_resOp

m_sqlManager

Constructor Details

CmsVfsDriver

Method Details

prepareUrlNameMappingConditions

escapeDbWildcard

addUrlNameMappingEntry

countSiblings

createContent

createFile

createFile

createFolder

createOnlineContent

createPropertyDefinition

createRelation

createResource

createResource

createSibling

deleteAliases

deletePropertyDefinition

deletePropertyObjects

deleteRelations

deleteRewriteAliases

deleteUrlNameMappingEntries

destroy

getResourceOus

getSqlManager

incrementCounter

init

initSqlManager

insertAlias

insertRewriteAliases

moveResource

publishResource

publishVersions

readAliases

readChildResources

readContent

readFolder

readFolder

readFolderSizeStats

readParentFolder

readPropertyDefinition

readPropertyDefinitions

readPropertyObject

readPropertyObjects

readRelations

readResource

readResource

readResources

readResourcesForPrincipalACE

readResourcesForPrincipalAttr

readResourcesWithProperty

readResourceTree

readRewriteAliases

readSiblings

readUrlNameMappingEntries

readVersions

removeFile

removeFolder

replaceResource

setDriverManager

setSqlManager

transferResource

updateRelations

validateResourceIdExists

validateStructureIdExists