org.opencms.db.generic

类 CmsSubscriptionDriver

java.lang.Object

org.opencms.db.generic.CmsSubscriptionDriver

所有已实现的接口:

I_CmsDriver, I_CmsSubscriptionDriver

直接已知子类:

CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver, CmsSubscriptionDriver

public class CmsSubscriptionDriver
extends java.lang.Object
implements I_CmsDriver, I_CmsSubscriptionDriver

Generic implementation of the user tracking and subscription driver interface.

从以下版本开始:

8.0.0

字段概要

字段

限定符和类型	字段和说明
protected CmsDriverManager	m_driverManager A reference to the driver manager used by this driver.
protected CmsSqlManager	m_sqlManager The SQL manager used by this driver.

从接口继承的字段 org.opencms.db.I_CmsDriver

AND_CONDITION, BEGIN_CONDITION, BEGIN_EXCLUDE_CONDITION, BEGIN_INCLUDE_CONDITION, END_CONDITION, OR_CONDITION

从接口继承的字段 org.opencms.db.I_CmsSubscriptionDriver

DRIVER_TYPE_ID

构造器概要

构造器

构造器和说明
CmsSubscriptionDriver()

方法概要

方法

限定符和类型	方法和说明
protected void	addVisit(CmsDbContext dbc, java.lang.String poolName, CmsVisitEntry visit) Adds an entry to the table of visits.
void	deleteVisits(CmsDbContext dbc, java.lang.String poolName, CmsVisitEntryFilter filter) Deletes visit entries matching the given filter.
long	getDateLastVisitedBy(CmsDbContext dbc, java.lang.String poolName, CmsUser user, CmsResource resource) Returns the date when the resource was last visited by the user.
CmsSqlManager	getSqlManager() Returns the SQL manager of this driver, if possible.
void	init(CmsDbContext dbc, CmsConfigurationManager configurationManager, java.util.List<java.lang.String> successiveDrivers, CmsDriverManager driverManager) Initializes the driver.
CmsSqlManager	initSqlManager(java.lang.String classname) Initializes the SQL manager for this driver.
protected CmsVisitEntry	internalReadVisitEntry(java.sql.ResultSet res) Creates a new CmsVisitEntry object from the given result set entry.
void	markResourceAsVisitedBy(CmsDbContext dbc, java.lang.String poolName, CmsResource resource, CmsUser user) Mark the given resource as visited by the user.
protected CmsPair<java.lang.String,java.util.List<I_CmsPreparedStatementParameter>>	prepareVisitConditions(CmsVisitEntryFilter filter) Build the whole WHERE SQL statement part for the given visit entry filter.
java.util.List<CmsResource>	readAllSubscribedResources(CmsDbContext dbc, java.lang.String poolName, CmsPrincipal principal) Returns all resources subscribed by the given user or group.
java.util.List<CmsResource>	readResourcesVisitedBy(CmsDbContext dbc, java.lang.String poolName, CmsVisitedByFilter filter) Returns the resources that were visited by a user set in the filter.
java.util.List<I_CmsHistoryResource>	readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
java.util.List<CmsResource>	readSubscribedResources(CmsDbContext dbc, java.lang.String poolName, CmsSubscriptionFilter filter) Returns the resources that were subscribed by a user or group set in the filter.
java.util.List<CmsVisitEntry>	readVisits(CmsDbContext dbc, java.lang.String poolName, CmsVisitEntryFilter filter) Reads CmsVisitEntry objects from the database.
void	setSubscribedResourceAsDeleted(CmsDbContext dbc, java.lang.String poolName, CmsResource resource) Marks a subscribed resource as deleted.
void	subscribeResourceFor(CmsDbContext dbc, java.lang.String poolName, CmsPrincipal principal, CmsResource resource) Subscribes the user or group to the resource.
void	unsubscribeAllDeletedResources(CmsDbContext dbc, java.lang.String poolName, long deletedTo) Unsubscribes all deleted resources that were deleted before the specified time stamp.
void	unsubscribeAllResourcesFor(CmsDbContext dbc, java.lang.String poolName, CmsPrincipal principal) Unsubscribes the principal from all resources.
void	unsubscribeResourceFor(CmsDbContext dbc, java.lang.String poolName, CmsPrincipal principal, CmsResource resource) Unsubscribes the principal from the resource.
void	unsubscribeResourceForAll(CmsDbContext dbc, java.lang.String poolName, CmsResource resource) Unsubscribes all groups and users from the resource.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.db.I_CmsDriver

toString

字段详细资料

m_driverManager

protected CmsDriverManager m_driverManager

A reference to the driver manager used by this driver.

m_sqlManager

protected CmsSqlManager m_sqlManager

The SQL manager used by this driver.

构造器详细资料

CmsSubscriptionDriver

public CmsSubscriptionDriver()

方法详细资料

deleteVisits

public void deleteVisits(CmsDbContext dbc,
                java.lang.String poolName,
                CmsVisitEntryFilter filter)
                  throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Deletes visit entries matching the given filter.

指定者:

deleteVisits 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use, if null, the default pool is used

filter - the log entry filter

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.deleteVisits(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.db.CmsVisitEntryFilter)

getDateLastVisitedBy

public long getDateLastVisitedBy(CmsDbContext dbc,
                        java.lang.String poolName,
                        CmsUser user,
                        CmsResource resource)
                          throws CmsException

从接口复制的说明: I_CmsSubscriptionDriver

Returns the date when the resource was last visited by the user.

指定者:

getDateLastVisitedBy 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

user - the user to check the date

resource - the resource to check the date

返回:

the date when the resource was last visited by the user

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.getDateLastVisitedBy(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsUser, org.opencms.file.CmsResource)

getSqlManager

public CmsSqlManager getSqlManager()

从接口复制的说明: I_CmsSubscriptionDriver

Returns the SQL manager of this driver, if possible.

指定者:

getSqlManager 在接口中 I_CmsSubscriptionDriver

返回:

an SQL manager

另请参阅:

I_CmsSubscriptionDriver.getSqlManager()

init

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

从接口复制的说明: I_CmsDriver

Initializes the driver.

指定者:

init 在接口中 I_CmsDriver

参数:

dbc - the current database context

configurationManager - the configuration manager

successiveDrivers - a list of successive drivers to be initialized

driverManager - the initialized OpenCms driver manager

另请参阅:

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

initSqlManager

public CmsSqlManager initSqlManager(java.lang.String classname)

从接口复制的说明: I_CmsSubscriptionDriver

Initializes the SQL manager for this driver.

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

指定者:

initSqlManager 在接口中 I_CmsSubscriptionDriver

参数:

classname - the classname of the SQL manager

返回:

the SQL manager for this driver

另请参阅:

I_CmsSubscriptionDriver.initSqlManager(java.lang.String)

markResourceAsVisitedBy

public void markResourceAsVisitedBy(CmsDbContext dbc,
                           java.lang.String poolName,
                           CmsResource resource,
                           CmsUser user)
                             throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Mark the given resource as visited by the user.

指定者:

markResourceAsVisitedBy 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

resource - the resource to mark as visited

user - the user that visited the resource

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.markResourceAsVisitedBy(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsResource, org.opencms.file.CmsUser)

readAllSubscribedResources

public java.util.List<CmsResource> readAllSubscribedResources(CmsDbContext dbc,
                                                     java.lang.String poolName,
                                                     CmsPrincipal principal)
                                                       throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Returns all resources subscribed by the given user or group.

指定者:

readAllSubscribedResources 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

principal - the principal to read the subscribed resources

返回:

all resources subscribed by the given user or group

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.readAllSubscribedResources(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.security.CmsPrincipal)

readResourcesVisitedBy

public java.util.List<CmsResource> readResourcesVisitedBy(CmsDbContext dbc,
                                                 java.lang.String poolName,
                                                 CmsVisitedByFilter filter)
                                                   throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Returns the resources that were visited by a user set in the filter.

指定者:

readResourcesVisitedBy 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

filter - the filter that is used to get the visited resources

返回:

the resources that were visited by a user set in the filter

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.readResourcesVisitedBy(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.db.CmsVisitedByFilter)

readSubscribedDeletedResources

public java.util.List<I_CmsHistoryResource> readSubscribedDeletedResources(CmsDbContext dbc,
                                                                  java.lang.String poolName,
                                                                  CmsUser user,
                                                                  java.util.List<CmsGroup> groups,
                                                                  CmsResource parent,
                                                                  boolean includeSubFolders,
                                                                  long deletedFrom)
                                                                    throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Returns the subscribed history resources that were deleted.

指定者:

readSubscribedDeletedResources 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

user - the user that subscribed to the resource

groups - the groups to check subscribed resources for

parent - the parent resource (folder) of the deleted resources, if null all deleted resources will be returned

includeSubFolders - indicates if the sub folders of the specified folder path should be considered, too

deletedFrom - the time stamp from which the resources should have been deleted

返回:

the subscribed history resources that were deleted

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.readSubscribedDeletedResources(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsUser, java.util.List, org.opencms.file.CmsResource, boolean, long)

readSubscribedResources

public java.util.List<CmsResource> readSubscribedResources(CmsDbContext dbc,
                                                  java.lang.String poolName,
                                                  CmsSubscriptionFilter filter)
                                                    throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Returns the resources that were subscribed by a user or group set in the filter.

指定者:

readSubscribedResources 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

filter - the filter that is used to get the subscribed resources

返回:

the resources that were subscribed by a user or group set in the filter

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.readSubscribedResources(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.db.CmsSubscriptionFilter)

readVisits

public java.util.List<CmsVisitEntry> readVisits(CmsDbContext dbc,
                                       java.lang.String poolName,
                                       CmsVisitEntryFilter filter)
                                         throws CmsDataAccessException

Reads CmsVisitEntry objects from the database.

参数:

dbc - the database context to use

poolName - the name of the pool which should be used for the database operation

filter - a filter for constraining the list of results

返回:

a list of visit entries

抛出:

CmsDataAccessException - if the database operation fails

setSubscribedResourceAsDeleted

public void setSubscribedResourceAsDeleted(CmsDbContext dbc,
                                  java.lang.String poolName,
                                  CmsResource resource)
                                    throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Marks a subscribed resource as deleted.

指定者:

setSubscribedResourceAsDeleted 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

resource - the subscribed resource to mark as deleted

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.setSubscribedResourceAsDeleted(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsResource)

subscribeResourceFor

public void subscribeResourceFor(CmsDbContext dbc,
                        java.lang.String poolName,
                        CmsPrincipal principal,
                        CmsResource resource)
                          throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Subscribes the user or group to the resource.

指定者:

subscribeResourceFor 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

principal - the principal that subscribes to the resource

resource - the resource to subscribe to

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.subscribeResourceFor(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.security.CmsPrincipal, org.opencms.file.CmsResource)

unsubscribeAllDeletedResources

public void unsubscribeAllDeletedResources(CmsDbContext dbc,
                                  java.lang.String poolName,
                                  long deletedTo)
                                    throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Unsubscribes all deleted resources that were deleted before the specified time stamp.

指定者:

unsubscribeAllDeletedResources 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

deletedTo - the time stamp to which the resources have been deleted

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.unsubscribeAllDeletedResources(org.opencms.db.CmsDbContext, java.lang.String, long)

unsubscribeAllResourcesFor

public void unsubscribeAllResourcesFor(CmsDbContext dbc,
                              java.lang.String poolName,
                              CmsPrincipal principal)
                                throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Unsubscribes the principal from all resources.

指定者:

unsubscribeAllResourcesFor 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

principal - the principal that unsubscribes from all resources

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.unsubscribeAllResourcesFor(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.security.CmsPrincipal)

unsubscribeResourceFor

public void unsubscribeResourceFor(CmsDbContext dbc,
                          java.lang.String poolName,
                          CmsPrincipal principal,
                          CmsResource resource)
                            throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Unsubscribes the principal from the resource.

指定者:

unsubscribeResourceFor 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

principal - the principal that unsubscribes from the resource

resource - the resource to unsubscribe from

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.unsubscribeResourceFor(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.security.CmsPrincipal, org.opencms.file.CmsResource)

unsubscribeResourceForAll

public void unsubscribeResourceForAll(CmsDbContext dbc,
                             java.lang.String poolName,
                             CmsResource resource)
                               throws CmsDataAccessException

从接口复制的说明: I_CmsSubscriptionDriver

Unsubscribes all groups and users from the resource.

指定者:

unsubscribeResourceForAll 在接口中 I_CmsSubscriptionDriver

参数:

dbc - the database context

poolName - the name of the database pool to use

resource - the resource to unsubscribe all groups and users from

抛出:

CmsDataAccessException - if something goes wrong

另请参阅:

I_CmsSubscriptionDriver.unsubscribeResourceForAll(org.opencms.db.CmsDbContext, java.lang.String, org.opencms.file.CmsResource)

addVisit

protected void addVisit(CmsDbContext dbc,
            java.lang.String poolName,
            CmsVisitEntry visit)
                 throws CmsDbSqlException

Adds an entry to the table of visits.

参数:

dbc - the database context to use

poolName - the name of the database pool to use

visit - the visit bean

抛出:

CmsDbSqlException - if the database operation fails

internalReadVisitEntry

protected CmsVisitEntry internalReadVisitEntry(java.sql.ResultSet res)
                                        throws java.sql.SQLException

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

参数:

res - the result set

返回:

the new CmsVisitEntry object

抛出:

java.sql.SQLException - if something goes wrong

prepareVisitConditions

protected CmsPair<java.lang.String,java.util.List<I_CmsPreparedStatementParameter>> prepareVisitConditions(CmsVisitEntryFilter filter)

Build the whole WHERE SQL statement part for the given visit entry filter.

参数:

filter - the filter

返回:

a pair containing both the SQL and the parameters for it