Package org.opencms.db

Interface I_CmsProjectDriver

All Known Implementing Classes:

CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver, CmsProjectDriver

public interface I_CmsProjectDriver

Definitions of all required project driver methods.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	DRIVER_TYPE_ID	The type ID to identify project driver implementations.
static java.lang.String	SETUP_PROJECT_NAME	Name of the setup project.
static java.lang.String	TEMP_FILE_PROJECT_NAME	The name of the temp file project.

Method Summary

Modifier and Type	Method	Description
int	cleanupPublishHistory(CmsDbContext dbc, CmsPublishHistoryCleanupFilter filter)	Cleans up the publish history entries according to the given filter.
CmsProject	createProject(CmsDbContext dbc, CmsUUID id, CmsUser owner, CmsGroup group, CmsGroup managergroup, java.lang.String name, java.lang.String description, int flags, CmsProject.CmsProjectType type)	Creates a new project.
void	createProjectResource(CmsDbContext dbc, CmsUUID projectId, java.lang.String resourceName)	Creates a new projectResource from a given CmsResource object.
void	createPublishJob(CmsDbContext dbc, CmsPublishJobInfoBean publishJob)	Inserts an entry for a publish job .
void	deleteAllStaticExportPublishedResources(CmsDbContext dbc, int linkType)	Deletes all entries in the published resource table.
void	deleteLog(CmsDbContext dbc, CmsLogFilter filter)	Deletes log entries matching the given filter.
void	deleteProject(CmsDbContext dbc, CmsProject project)	Deletes a project from the cms.
void	deleteProjectResource(CmsDbContext dbc, CmsUUID projectId, java.lang.String resourceName)	Delete a projectResource from an given CmsResource object.
void	deleteProjectResources(CmsDbContext dbc, CmsProject project)	Deletes a specified project.
void	deletePublishHistory(CmsDbContext dbc, CmsUUID projectId, int maxPublishTag)	Deletes all publish history entries with publish tags >=0 and < the specified max.
void	deletePublishHistoryEntry(CmsDbContext dbc, CmsUUID publishHistoryId, CmsPublishedResource publishResource)	Deletes a publish history entry with publish tags >=0 and < the specified max.
void	deletePublishJob(CmsDbContext dbc, CmsUUID publishHistoryId)	Deletes a publish job identified by its history id.
void	deletePublishList(CmsDbContext dbc, CmsUUID publishHistoryId)	Deletes the publish list assigned to a publish job.
void	deleteStaticExportPublishedResource(CmsDbContext dbc, java.lang.String resourceName, int linkType, java.lang.String linkParameter)	Deletes an entry in the published resource table.
void	deleteUserPublishListEntries(CmsDbContext dbc, java.util.List<CmsUserPublishListEntry> publishListDeletions)	Deletes multiple publish list entries from the database.
void	destroy()	Destroys this driver.
void	fillDefaults(CmsDbContext dbc)	Fills the OpenCms database tables with default values.
CmsSqlManager	getSqlManager()	Returns the SqlManager of this driver.
java.util.List<CmsResource>	getUsersPubList(CmsDbContext dbc, CmsUUID userId)	Returns the given user's publish list.
CmsSqlManager	initSqlManager(java.lang.String classname)	Initializes the SQL manager for this driver.
void	log(CmsDbContext dbc, java.util.List<CmsLogEntry> logEntries)	Logs the given log entries.
void	publishDeletedFolder(CmsDbContext dbc, I_CmsReport report, int m, int n, CmsProject onlineProject, CmsFolder offlineFolder, CmsUUID publishHistoryId, int publishTag)	Publishes a deleted folder.
void	publishFile(CmsDbContext dbc, I_CmsReport report, int m, int n, CmsProject onlineProject, CmsResource offlineResource, java.util.Set<CmsUUID> publishedContentIds, CmsUUID publishHistoryId, int publishTag)	Publishes a new, changed or deleted file.
CmsFile	publishFileContent(CmsDbContext dbc, CmsProject offlineProject, CmsProject onlineProject, CmsResource offlineFileHeader, java.util.Set<CmsUUID> publishedResourceIds, boolean needToUpdateContent, int publishTag)	Publishes the content record of a file.
void	publishFolder(CmsDbContext dbc, I_CmsReport report, int m, int n, CmsProject onlineProject, CmsFolder currentFolder, CmsUUID publishHistoryId, int publishTag)	Publishes a new or changed folder.
void	publishProject(CmsDbContext dbc, I_CmsReport report, CmsProject onlineProject, CmsPublishList publishList, int publishTag)	Publishes a specified project to the online project.
java.util.List<CmsLock>	readLocks(CmsDbContext dbc)	Reads the List<CmsLock;> that were saved to the database in the previous run of OpenCms.
java.util.List<CmsLogEntry>	readLog(CmsDbContext dbc, CmsLogFilter filter)	Reads log entries matching the given filter.
CmsProject	readProject(CmsDbContext dbc, java.lang.String name)	Reads a project.
CmsProject	readProject(CmsDbContext dbc, CmsUUID id)	Reads a project given the projects id.
java.lang.String	readProjectResource(CmsDbContext dbc, CmsUUID projectId, java.lang.String resourcename)	Reads the project resource path for a given project and resource path, to validate if a resource path for a given project already exists.
java.util.List<java.lang.String>	readProjectResources(CmsDbContext dbc, CmsProject project)	Reads the project resources for a specified project.
java.util.List<CmsProject>	readProjects(CmsDbContext dbc, java.lang.String ouFqn)	Returns all projects in the given organizational unit.
java.util.List<CmsProject>	readProjectsForGroup(CmsDbContext dbc, CmsGroup group)	Returns all projects, which are accessible by a group.
java.util.List<CmsProject>	readProjectsForManagerGroup(CmsDbContext dbc, CmsGroup group)	Returns all projects, which are manageable by a group.
java.util.List<CmsProject>	readProjectsForUser(CmsDbContext dbc, CmsUser user)	Reads all projects which are owned by a specified user.
java.util.List<CmsPublishedResource>	readPublishedResources(CmsDbContext dbc, CmsUUID publishHistoryId)	Reads the resources that were published during a publish process for a given publish history ID.
CmsPublishJobInfoBean	readPublishJob(CmsDbContext dbc, CmsUUID publishHistoryId)	Reads a single publish job identified by its publish history id.
java.util.List<CmsPublishJobInfoBean>	readPublishJobs(CmsDbContext dbc, long startTime, long endTime)	Reads all publish jobs finished in the given time range.
CmsPublishList	readPublishList(CmsDbContext dbc, CmsUUID publishHistoryId)	Reads the publish list assigned to a publish job.
byte[]	readPublishReportContents(CmsDbContext dbc, CmsUUID publishHistoryId)	Reads the publish report assigned to a publish job.
java.lang.String	readStaticExportPublishedResourceParameters(CmsDbContext dbc, java.lang.String rfsName)	Returns the parameters of a resource in the table of all published template resources.
java.util.List<java.lang.String>	readStaticExportResources(CmsDbContext dbc, int parameterResources, long timestamp)	Returns a list of all template resources which must be processed during a static export.
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	unmarkProjectResources(CmsDbContext dbc, CmsProject project)	Removes the project id from all resources within a project.
void	writeLocks(CmsDbContext dbc, java.util.List<CmsLock> locks)	Writes the List<CmsLock;> to the database for reuse in the next run of OpenCms.
void	writeProject(CmsDbContext dbc, CmsProject project)	Writes an already existing project.
void	writePublishHistory(CmsDbContext dbc, CmsUUID publishId, CmsPublishedResource resource)	Inserts an entry in the publish history for a published VFS resource.
void	writePublishJob(CmsDbContext dbc, CmsPublishJobInfoBean publishJob)	Writes a publish job.
void	writePublishReport(CmsDbContext dbc, CmsUUID publishId, byte[] content)	Writes a publish report for a publish job.
void	writeStaticExportPublishedResource(CmsDbContext dbc, java.lang.String resourceName, int linkType, java.lang.String linkParameter, long timestamp)	Inserts an entry in the published resource table.
void	writeUserPublishListEntries(CmsDbContext dbc, java.util.List<CmsUserPublishListEntry> publishListAdditions)	Writes multiple user publish list entries to the database.

Field Detail

DRIVER_TYPE_ID

static final int DRIVER_TYPE_ID

The type ID to identify project driver implementations.

See Also:

Constant Field Values

SETUP_PROJECT_NAME

static final java.lang.String SETUP_PROJECT_NAME

Name of the setup project.

See Also:

Constant Field Values

TEMP_FILE_PROJECT_NAME

static final java.lang.String TEMP_FILE_PROJECT_NAME

The name of the temp file project.

See Also:

Constant Field Values

Method Detail

cleanupPublishHistory

int cleanupPublishHistory(CmsDbContext dbc,
                          CmsPublishHistoryCleanupFilter filter)
                   throws CmsDataAccessException

Cleans up the publish history entries according to the given filter.

Parameters:

dbc - the DB context

filter - the filter to describe what to clean up

Returns:

the number of removed entries

Throws:

CmsDataAccessException - if something goes wrong

createProject

CmsProject createProject(CmsDbContext dbc,
                         CmsUUID id,
                         CmsUser owner,
                         CmsGroup group,
                         CmsGroup managergroup,
                         java.lang.String name,
                         java.lang.String description,
                         int flags,
                         CmsProject.CmsProjectType type)
                  throws CmsDataAccessException

Creates a new project.

Parameters:

dbc - the current database context

id - the project id

owner - the owner of the project

group - the group for the project

managergroup - the manager group for the project

name - the name of the project to create

description - the description for the project

flags - the flags for the project

type - the type for the project

Returns:

the created CmsProject instance

Throws:

CmsDataAccessException - if something goes wrong

createProjectResource

void createProjectResource(CmsDbContext dbc,
                           CmsUUID projectId,
                           java.lang.String resourceName)
                    throws CmsDataAccessException

Creates a new projectResource from a given CmsResource object.

Parameters:

dbc - the current database context

projectId - The project in which the resource will be used

resourceName - The resource to be written to the Cms

Throws:

CmsDataAccessException - if something goes wrong

createPublishJob

void createPublishJob(CmsDbContext dbc,
                      CmsPublishJobInfoBean publishJob)
               throws CmsDataAccessException

Inserts an entry for a publish job .

Parameters:

dbc - the current database context

publishJob - the publish job data

Throws:

CmsDataAccessException - if something goes wrong

deleteAllStaticExportPublishedResources

void deleteAllStaticExportPublishedResources(CmsDbContext dbc,
                                             int linkType)
                                      throws CmsDataAccessException

Deletes all entries in the published resource table.

Parameters:

dbc - the current database context

linkType - the type of resource deleted (0= non-paramter, 1=parameter)

Throws:

CmsDataAccessException - if something goes wrong

deleteLog

void deleteLog(CmsDbContext dbc,
               CmsLogFilter filter)
        throws CmsDataAccessException

Deletes log entries matching the given filter.

Parameters:

dbc - the database context

filter - the log entry filter

Throws:

CmsDataAccessException - if something goes wrong

deleteProject

void deleteProject(CmsDbContext dbc,
                   CmsProject project)
            throws CmsDataAccessException

Deletes a project from the cms.

Therefore it deletes all files, resources and properties.

Parameters:

dbc - the current database context

project - the project to delete

Throws:

CmsDataAccessException - if something goes wrong

deleteProjectResource

void deleteProjectResource(CmsDbContext dbc,
                           CmsUUID projectId,
                           java.lang.String resourceName)
                    throws CmsDataAccessException

Delete a projectResource from an given CmsResource object.

Parameters:

dbc - the current database context

projectId - id of the project in which the resource is used

resourceName - name of the resource to be deleted from the Cms

Throws:

CmsDataAccessException - if something goes wrong

deleteProjectResources

void deleteProjectResources(CmsDbContext dbc,
                            CmsProject project)
                     throws CmsDataAccessException

Deletes a specified project.

Parameters:

dbc - the current database context

project - the project to be deleted

Throws:

CmsDataAccessException - if operation was not succesful

deletePublishHistory

void deletePublishHistory(CmsDbContext dbc,
                          CmsUUID projectId,
                          int maxPublishTag)
                   throws CmsDataAccessException

Deletes all publish history entries with publish tags >=0 and < the specified max. publish tag.

Parameters:

dbc - the current database context

projectId - the ID of the current project

maxPublishTag - entries with publish tags >=0 and < this max. publish tag get deleted

Throws:

CmsDataAccessException - if something goes wrong

deletePublishHistoryEntry

void deletePublishHistoryEntry(CmsDbContext dbc,
                               CmsUUID publishHistoryId,
                               CmsPublishedResource publishResource)
                        throws CmsDataAccessException

Deletes a publish history entry with publish tags >=0 and < the specified max. publish tag.

Parameters:

dbc - the current database context

publishHistoryId - the id of the history to delete the entry from

publishResource - the entry to delete

Throws:

CmsDataAccessException - if something goes wrong

deletePublishJob

void deletePublishJob(CmsDbContext dbc,
                      CmsUUID publishHistoryId)
               throws CmsDataAccessException

Deletes a publish job identified by its history id.

Parameters:

dbc - the current database context

publishHistoryId - the history id identifying the publish job

Throws:

CmsDataAccessException - if something goes wrong

deletePublishList

void deletePublishList(CmsDbContext dbc,
                       CmsUUID publishHistoryId)
                throws CmsDataAccessException

Deletes the publish list assigned to a publish job.

Parameters:

dbc - the current database context

publishHistoryId - the history id identifying the publish job

Throws:

CmsDataAccessException - if something goes wrong

deleteStaticExportPublishedResource

void deleteStaticExportPublishedResource(CmsDbContext dbc,
                                         java.lang.String resourceName,
                                         int linkType,
                                         java.lang.String linkParameter)
                                  throws CmsDataAccessException

Deletes an entry in the published resource table.

Parameters:

dbc - the current database context

resourceName - The name of the resource to be deleted in the static export

linkType - the type of resource deleted (0= non-paramter, 1=parameter)

linkParameter - the parameters of the resource

Throws:

CmsDataAccessException - if something goes wrong

deleteUserPublishListEntries

void deleteUserPublishListEntries(CmsDbContext dbc,
                                  java.util.List<CmsUserPublishListEntry> publishListDeletions)
                           throws CmsDataAccessException

Deletes multiple publish list entries from the database.

Parameters:

dbc - the current database context

publishListDeletions - the publish list entries to remove from the database

Throws:

CmsDataAccessException - if something goes wrong

destroy

void destroy()
      throws java.lang.Throwable

Destroys this driver.

Throws:

java.lang.Throwable - if something goes wrong

fillDefaults

void fillDefaults(CmsDbContext dbc)
           throws CmsDataAccessException

Fills the OpenCms database tables with default values.

Parameters:

dbc - the current database context

Throws:

CmsDataAccessException - if something goes wrong

getSqlManager

CmsSqlManager getSqlManager()

Returns the SqlManager of this driver.

Returns:

the SqlManager of this driver

getUsersPubList

java.util.List<CmsResource> getUsersPubList(CmsDbContext dbc,
                                            CmsUUID userId)
                                     throws CmsDataAccessException

Returns the given user's publish list.

Parameters:

dbc - the database context

userId - the user's id

Returns:

the given user's publish list

Throws:

CmsDataAccessException - if something goes wrong

initSqlManager

CmsSqlManager initSqlManager(java.lang.String classname)

Initializes the SQL manager for this driver.

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

Parameters:

classname - the classname of the SQL manager

Returns:

the SQL manager for this driver

log

void log(CmsDbContext dbc,
         java.util.List<CmsLogEntry> logEntries)
  throws CmsDataAccessException

Logs the given log entries.

Parameters:

dbc - the database context

logEntries - the log entries to write

Throws:

CmsDataAccessException - if something goes wrong

publishDeletedFolder

void publishDeletedFolder(CmsDbContext dbc,
                          I_CmsReport report,
                          int m,
                          int n,
                          CmsProject onlineProject,
                          CmsFolder offlineFolder,
                          CmsUUID publishHistoryId,
                          int publishTag)
                   throws CmsDataAccessException

Publishes a deleted folder.

Parameters:

dbc - the current database context

report - the report to log the output to

m - the number of the folder to publish

n - the number of all folders to publish

onlineProject - the online project

offlineFolder - the offline folder to publish

publishHistoryId - the publish history id

publishTag - the publish tag

Throws:

CmsDataAccessException - if something goes wrong

publishFile

void publishFile(CmsDbContext dbc,
                 I_CmsReport report,
                 int m,
                 int n,
                 CmsProject onlineProject,
                 CmsResource offlineResource,
                 java.util.Set<CmsUUID> publishedContentIds,
                 CmsUUID publishHistoryId,
                 int publishTag)
          throws CmsDataAccessException

Publishes a new, changed or deleted file.

Parameters:

dbc - the current database context

report - the report to log the output to

m - the number of the file to publish

n - the number of all files to publish

onlineProject - the online project

offlineResource - the offline file to publish

publishedContentIds - contains the UUIDs of already published content records

publishHistoryId - the publish history id

publishTag - the publish tag

Throws:

CmsDataAccessException - if something goes wrong

publishFileContent

CmsFile publishFileContent(CmsDbContext dbc,
                           CmsProject offlineProject,
                           CmsProject onlineProject,
                           CmsResource offlineFileHeader,
                           java.util.Set<CmsUUID> publishedResourceIds,
                           boolean needToUpdateContent,
                           int publishTag)
                    throws CmsDataAccessException

Publishes the content record of a file.

The content record is only published unless it's UUID is not contained in publishedContentIds. The calling method has to take care about whether an existing content record has to be deleted before or not.

The intention of this method is to get overloaded in a project driver for a specific DB server to shift the binary content from the offline into the online table in a more sophisticated way than in the generic ANSI-SQL implementation of this interface.

Parameters:

dbc - the current database context

offlineProject - the offline project to read data

onlineProject - the online project to write data

offlineFileHeader - the offline header of the file of which the content gets published

publishedResourceIds - a Set with the UUIDs of the already published content records

needToUpdateContent - true if the content record has to be updated

publishTag - the publish tag

Returns:

the published file (online)

Throws:

CmsDataAccessException - if something goes wrong

publishFolder

void publishFolder(CmsDbContext dbc,
                   I_CmsReport report,
                   int m,
                   int n,
                   CmsProject onlineProject,
                   CmsFolder currentFolder,
                   CmsUUID publishHistoryId,
                   int publishTag)
            throws CmsDataAccessException

Publishes a new or changed folder.

Parameters:

dbc - the current database context

report - the report to log the output to

m - the number of the folder to publish

n - the number of all folders to publish

onlineProject - the online project

currentFolder - the offline folder to publish

publishHistoryId - the publish history id

publishTag - the publish tag

Throws:

CmsDataAccessException - if something goes wrong

publishProject

void publishProject(CmsDbContext dbc,
                    I_CmsReport report,
                    CmsProject onlineProject,
                    CmsPublishList publishList,
                    int publishTag)
             throws CmsException

Publishes a specified project to the online project.

Parameters:

dbc - the current database context

report - an I_CmsReport instance to print output messages

onlineProject - the online project

publishList - a Cms publish list

publishTag - the publish tag

Throws:

CmsException - if something goes wrong

readLocks

java.util.List<CmsLock> readLocks(CmsDbContext dbc)
                           throws CmsDataAccessException

Reads the List<CmsLock;> that were saved to the database in the previous run of OpenCms.

Parameters:

dbc - the current database context

Returns:

the List<CmsLock;> that were saved to the database in the previous run of OpenCms.

Throws:

CmsDataAccessException - if something goes wrong

readLog

java.util.List<CmsLogEntry> readLog(CmsDbContext dbc,
                                    CmsLogFilter filter)
                             throws CmsDataAccessException

Reads log entries matching the given filter.

Parameters:

dbc - the database context

filter - the log entry filter

Returns:

the list of log entries

Throws:

CmsDataAccessException - if something goes wrong

readProject

CmsProject readProject(CmsDbContext dbc,
                       CmsUUID id)
                throws CmsDataAccessException

Reads a project given the projects id.

Parameters:

dbc - the current database context

id - the id of the project

Returns:

the project read

Throws:

CmsDataAccessException - if something goes wrong

readProject

CmsProject readProject(CmsDbContext dbc,
                       java.lang.String name)
                throws CmsDataAccessException

Reads a project.

Parameters:

dbc - the current database context

name - the name of the project

Returns:

the project with the given name

Throws:

CmsDataAccessException - if something goes wrong

readProjectResource

java.lang.String readProjectResource(CmsDbContext dbc,
                                     CmsUUID projectId,
                                     java.lang.String resourcename)
                              throws CmsDataAccessException

Reads the project resource path for a given project and resource path, to validate if a resource path for a given project already exists.

Parameters:

dbc - the current database context

projectId - the ID of the project for which the resource path is read

resourcename - the project's resource path

Returns:

String the project's resource path

Throws:

CmsDataAccessException - if something goes wrong

readProjectResources

java.util.List<java.lang.String> readProjectResources(CmsDbContext dbc,
                                                      CmsProject project)
                                               throws CmsDataAccessException

Reads the project resources for a specified project.

Parameters:

dbc - the current database context

project - the project for which the resource path is read

Returns:

a list of all project resource paths

Throws:

CmsDataAccessException - if something goes wrong

readProjects

java.util.List<CmsProject> readProjects(CmsDbContext dbc,
                                        java.lang.String ouFqn)
                                 throws CmsDataAccessException

Returns all projects in the given organizational unit.

Parameters:

dbc - the current database context

ouFqn - the fully qualified name of the organizational unit to get the projects for

Returns:

a list of objects of type CmsProject

Throws:

CmsDataAccessException - if something goes wrong

readProjectsForGroup

java.util.List<CmsProject> readProjectsForGroup(CmsDbContext dbc,
                                                CmsGroup group)
                                         throws CmsDataAccessException

Returns all projects, which are accessible by a group.

Parameters:

dbc - the current database context

group - the requesting group

Returns:

a Vector of projects

Throws:

CmsDataAccessException - if something goes wrong

readProjectsForManagerGroup

java.util.List<CmsProject> readProjectsForManagerGroup(CmsDbContext dbc,
                                                       CmsGroup group)
                                                throws CmsDataAccessException

Returns all projects, which are manageable by a group.

Parameters:

dbc - the current database context

group - The requesting group

Returns:

a Vector of projects

Throws:

CmsDataAccessException - if something goes wrong

readProjectsForUser

java.util.List<CmsProject> readProjectsForUser(CmsDbContext dbc,
                                               CmsUser user)
                                        throws CmsDataAccessException

Reads all projects which are owned by a specified user.

Parameters:

dbc - the current database context

user - the user

Returns:

a list of objects of type CmsProject

Throws:

CmsDataAccessException - if something goes wrong

readPublishedResources

java.util.List<CmsPublishedResource> readPublishedResources(CmsDbContext dbc,
                                                            CmsUUID publishHistoryId)
                                                     throws CmsDataAccessException

Reads the resources that were published during a publish process for a given publish history ID.

Parameters:

dbc - the current database context

publishHistoryId - unique int ID to identify the publish process in the publish history

Returns:

a list of CmsPublishedResource objects

Throws:

CmsDataAccessException - if something goes wrong

readPublishJob

CmsPublishJobInfoBean readPublishJob(CmsDbContext dbc,
                                     CmsUUID publishHistoryId)
                              throws CmsDataAccessException

Reads a single publish job identified by its publish history id.

Parameters:

dbc - the current database context

publishHistoryId - unique id to identify the publish job in the publish history

Returns:

an object of type CmsPublishJobInfoBean

Throws:

CmsDataAccessException - if something goes wrong

readPublishJobs

java.util.List<CmsPublishJobInfoBean> readPublishJobs(CmsDbContext dbc,
                                                      long startTime,
                                                      long endTime)
                                               throws CmsDataAccessException

Reads all publish jobs finished in the given time range.

If (0L, 0L) is passed as time range, all pending jobs are returned.

Parameters:

dbc - the current database context

startTime - the start of the time range for finish time

endTime - the end of the time range for finish time

Returns:

a list of objects of type CmsPublishJobInfoBean

Throws:

CmsDataAccessException - if something goes wrong

readPublishList

CmsPublishList readPublishList(CmsDbContext dbc,
                               CmsUUID publishHistoryId)
                        throws CmsDataAccessException

Reads the publish list assigned to a publish job.

Parameters:

dbc - the current database context

publishHistoryId - the history id identifying the publish job

Returns:

the assigned publish list

Throws:

CmsDataAccessException - if something goes wrong

readPublishReportContents

byte[] readPublishReportContents(CmsDbContext dbc,
                                 CmsUUID publishHistoryId)
                          throws CmsDataAccessException

Reads the publish report assigned to a publish job.

Parameters:

dbc - the current database context

publishHistoryId - the history id identifying the publish job

Returns:

the content of the assigned publish report

Throws:

CmsDataAccessException - if something goes wrong

readStaticExportPublishedResourceParameters

java.lang.String readStaticExportPublishedResourceParameters(CmsDbContext dbc,
                                                             java.lang.String rfsName)
                                                      throws CmsDataAccessException

Returns the parameters of a resource in the table of all published template resources.

Parameters:

dbc - the current database context

rfsName - the rfs name of the resource

Returns:

the paramter string of the requested resource

Throws:

CmsDataAccessException - if something goes wrong

readStaticExportResources

java.util.List<java.lang.String> readStaticExportResources(CmsDbContext dbc,
                                                           int parameterResources,
                                                           long timestamp)
                                                    throws CmsDataAccessException

Returns a list of all template resources which must be processed during a static export.

Parameters:

dbc - the current database context

parameterResources - flag for reading resources with parameters (1) or without (0)

timestamp - the time stamp information

Returns:

a list of template resources as String objects

Throws:

CmsDataAccessException - if something goes wrong

setDriverManager

void setDriverManager(CmsDriverManager driverManager)

Sets the driver manager for this driver if possible.

Parameters:

driverManager - the new driver manager

setSqlManager

void setSqlManager(CmsSqlManager sqlManager)

Sets the SQL manager for this driver if possible.

Parameters:

sqlManager - the new SQL manager

unmarkProjectResources

void unmarkProjectResources(CmsDbContext dbc,
                            CmsProject project)
                     throws CmsDataAccessException

Removes the project id from all resources within a project.

This must be done when a project will deleted

Parameters:

dbc - the current database context

project - the project to delete

Throws:

CmsDataAccessException - if something goes wrong

writeLocks

void writeLocks(CmsDbContext dbc,
                java.util.List<CmsLock> locks)
         throws CmsDataAccessException

Writes the List<CmsLock;> to the database for reuse in the next run of OpenCms.

This method must only be called at startup or the in-memory locking will overwritten.

Parameters:

dbc - the current database context

locks - the List<CmsLock;> that currently exist in OpenCms (CmsLockManager)

Throws:

CmsDataAccessException - if something goes wrong

writeProject

void writeProject(CmsDbContext dbc,
                  CmsProject project)
           throws CmsDataAccessException

Writes an already existing project.

The project id has to be a valid OpenCms project id.
The project with the given id will be completely overriden by the given data.

Parameters:

dbc - the current database context

project - the project that should be written

Throws:

CmsDataAccessException - if operation was not successful

writePublishHistory

void writePublishHistory(CmsDbContext dbc,
                         CmsUUID publishId,
                         CmsPublishedResource resource)
                  throws CmsDataAccessException

Inserts an entry in the publish history for a published VFS resource.

Parameters:

dbc - the current database context

publishId - the ID of the current publishing process

resource - the state of the resource *before* it was published

Throws:

CmsDataAccessException - if something goes wrong

writePublishJob

void writePublishJob(CmsDbContext dbc,
                     CmsPublishJobInfoBean publishJob)
              throws CmsDataAccessException

Writes a publish job.

Parameters:

dbc - the current database context

publishJob - the publish job to write

Throws:

CmsDataAccessException - if something goes wrong

writePublishReport

void writePublishReport(CmsDbContext dbc,
                        CmsUUID publishId,
                        byte[] content)
                 throws CmsDataAccessException

Writes a publish report for a publish job.

Parameters:

dbc - the current database context

publishId - the ID of the current publishing process

content - the report output

Throws:

CmsDataAccessException - if something goes wrong

writeStaticExportPublishedResource

void writeStaticExportPublishedResource(CmsDbContext dbc,
                                        java.lang.String resourceName,
                                        int linkType,
                                        java.lang.String linkParameter,
                                        long timestamp)
                                 throws CmsDataAccessException

Inserts an entry in the published resource table.

This is done during static export.

Parameters:

dbc - the current database context

resourceName - The name of the resource to be added to the static export

linkType - the type of resource exported (0= non-paramter, 1=parameter)

linkParameter - the parameters added to the resource

timestamp - a timestamp for writing the data into the db

Throws:

CmsDataAccessException - if something goes wrong

writeUserPublishListEntries

void writeUserPublishListEntries(CmsDbContext dbc,
                                 java.util.List<CmsUserPublishListEntry> publishListAdditions)
                          throws CmsDataAccessException

Writes multiple user publish list entries to the database.

Parameters:

dbc - the current database context

publishListAdditions - the user publish list entries to write

Throws:

CmsDataAccessException - if something goes wrong