org.opencms.db

Class CmsSubscriptionManager

java.lang.Object

org.opencms.db.CmsSubscriptionManager

public class CmsSubscriptionManager
extends java.lang.Object

Manager that provides methods to subscribe resources to users, read subscribed or unvisited resources and more.

Since:

8.0

Field Summary

Fields

Modifier and Type	Field and Description
protected CmsSecurityManager	m_securityManager The security manager to access the cms.

Constructor Summary

Constructors

Constructor and Description
CmsSubscriptionManager() Initializes a new CmsSubscriptionManager, called from the configuration.

Method Summary

Methods

Modifier and Type	Method and Description
long	getDateLastVisitedBy(CmsObject cms, CmsUser user, CmsResource resource) Returns the date when the resource was last visited by the user.
long	getDateLastVisitedBy(CmsObject cms, CmsUser user, java.lang.String resourcePath) Returns the date when the resource was last visited by the user.
int	getMaxVisitedCount() Returns the maximum number of visited resources to store per user.
java.lang.String	getPoolName() Returns the name of the database pool to use.
void	initialize(CmsObject cms) Initializes this subscription manager with the OpenCms system configuration.
boolean	isEnabled() Returns if the subscription functionality is enabled.
void	markResourceAsVisitedBy(CmsObject cms, CmsResource resource, CmsUser user) Mark the given resource as visited by the user.
void	markResourceAsVisitedBy(CmsObject cms, java.lang.String resourcePath, CmsUser user) Mark the given resource as visited by the user.
java.util.List<CmsResource>	readAllSubscribedResources(CmsObject cms, CmsPrincipal principal) Returns all resources subscribed by the given user or group.
java.util.List<CmsResource>	readResourcesVisitedBy(CmsObject cms, CmsVisitedByFilter filter) Returns the resources that were visited by a user set in the filter.
java.util.List<I_CmsHistoryResource>	readSubscribedDeletedResources(CmsObject cms, CmsUser user, boolean includeGroups, java.lang.String folderPath, boolean includeSubFolders, long deletedFrom) Returns the subscribed history resources that were deleted.
java.util.List<CmsResource>	readSubscribedResources(CmsObject cms, CmsSubscriptionFilter filter) Returns the resources that were subscribed by a user or group set in the filter.
void	setEnabled(boolean enabled) Sets if the subscription functionality is enabled.
void	setEnabled(java.lang.String enabled) Sets if the subscription functionality is enabled.
void	setMaxVisitedCount(java.lang.String maxVisitedCount) Sets the maximum number of visited resources to store per user.
void	setPoolName(java.lang.String poolName) Sets the name of the database pool to use.
void	setSecurityManager(CmsSecurityManager securityManager) Sets the security manager during initialization.
void	setSubscribedResourceAsDeleted(CmsObject cms, CmsResource resource) Marks a subscribed resource as deleted.
void	subscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource) Subscribes the user or group to the resource.
void	subscribeResourceFor(CmsObject cms, CmsPrincipal principal, java.lang.String resourcePath) Subscribes the user or group to the resource.
void	unsubscribeAllDeletedResources(CmsObject cms, long deletedTo) Unsubscribes all deleted resources that were deleted before the specified time stamp.
void	unsubscribeAllResourcesFor(CmsObject cms, CmsPrincipal principal) Unsubscribes the user or group from all resources.
void	unsubscribeResourceFor(CmsObject cms, CmsPrincipal principal, CmsResource resource) Unsubscribes the principal from the resource.
void	unsubscribeResourceFor(CmsObject cms, CmsPrincipal principal, java.lang.String resourcePath) Unsubscribes the principal from the resource.
void	unsubscribeResourceForAll(CmsObject cms, CmsResource resource) Unsubscribes all groups and users from the resource.
void	unsubscribeResourceForAll(CmsObject cms, java.lang.String resourcePath) Unsubscribes all groups and users from the resource.

Methods inherited from class java.lang.Object

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

Field Detail

m_securityManager

protected CmsSecurityManager m_securityManager

The security manager to access the cms.

Constructor Detail

CmsSubscriptionManager

public CmsSubscriptionManager()

Initializes a new CmsSubscriptionManager, called from the configuration.

Method Detail

getDateLastVisitedBy

public long getDateLastVisitedBy(CmsObject cms,
                        CmsUser user,
                        CmsResource resource)
                          throws CmsException

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

Parameters:

cms - the current users context

user - the user to check the date

resource - the resource to check the date

Returns:

the date when the resource was last visited by the user

Throws:

CmsException - if something goes wrong

getDateLastVisitedBy

public long getDateLastVisitedBy(CmsObject cms,
                        CmsUser user,
                        java.lang.String resourcePath)
                          throws CmsException

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

Parameters:

cms - the current users context

user - the user to check the date

resourcePath - the name of the resource to check the date

Returns:

the date when the resource was last visited by the user

Throws:

CmsException - if something goes wrong

getMaxVisitedCount

public int getMaxVisitedCount()

Returns the maximum number of visited resources to store per user.

Returns:

the maximum number of visited resources to store per user

getPoolName

public java.lang.String getPoolName()

Returns the name of the database pool to use.

Returns:

the name of the database pool to use

initialize

public void initialize(CmsObject cms)
                throws CmsRoleViolationException

Initializes this subscription manager with the OpenCms system configuration.

Parameters:

cms - an OpenCms context object that must have been initialized with "Admin" permissions

Throws:

CmsRoleViolationException - in case the given opencms object does not have CmsRole.ROOT_ADMIN permissions

isEnabled

public boolean isEnabled()

Returns if the subscription functionality is enabled.

Returns:

true if the subscription functionality is enabled, otherwise false

markResourceAsVisitedBy

public void markResourceAsVisitedBy(CmsObject cms,
                           CmsResource resource,
                           CmsUser user)
                             throws CmsException

Mark the given resource as visited by the user.

Parameters:

cms - the current users context

resource - the resource to mark as visited

user - the user that visited the resource

Throws:

CmsException - if something goes wrong

markResourceAsVisitedBy

public void markResourceAsVisitedBy(CmsObject cms,
                           java.lang.String resourcePath,
                           CmsUser user)
                             throws CmsException

Mark the given resource as visited by the user.

Parameters:

cms - the current users context

resourcePath - the name of the resource to mark as visited

user - the user that visited the resource

Throws:

CmsException - if something goes wrong

readAllSubscribedResources

public java.util.List<CmsResource> readAllSubscribedResources(CmsObject cms,
                                                     CmsPrincipal principal)
                                                       throws CmsException

Returns all resources subscribed by the given user or group.

Parameters:

cms - the current users context

principal - the principal to read the subscribed resources

Returns:

all resources subscribed by the given user or group

Throws:

CmsException - if something goes wrong

readResourcesVisitedBy

public java.util.List<CmsResource> readResourcesVisitedBy(CmsObject cms,
                                                 CmsVisitedByFilter filter)
                                                   throws CmsException

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

Parameters:

cms - the current users context

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

Returns:

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

Throws:

CmsException - if something goes wrong

readSubscribedDeletedResources

public java.util.List<I_CmsHistoryResource> readSubscribedDeletedResources(CmsObject cms,
                                                                  CmsUser user,
                                                                  boolean includeGroups,
                                                                  java.lang.String folderPath,
                                                                  boolean includeSubFolders,
                                                                  long deletedFrom)
                                                                    throws CmsException

Returns the subscribed history resources that were deleted.

Parameters:

cms - the current users context

user - the user that subscribed to the resource

includeGroups - indicates if the users groups should also be checked for subscribed deleted resources

folderPath - the folder path 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

Returns:

the subscribed history resources that were deleted

Throws:

CmsException - if something goes wrong

readSubscribedResources

public java.util.List<CmsResource> readSubscribedResources(CmsObject cms,
                                                  CmsSubscriptionFilter filter)
                                                    throws CmsException

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

Parameters:

cms - the current users context

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

Returns:

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

Throws:

CmsException - if something goes wrong

setEnabled

public void setEnabled(boolean enabled)

Sets if the subscription functionality is enabled.

Parameters:

enabled - the flag indicating if the subscription functionality is enabled

setEnabled

public void setEnabled(java.lang.String enabled)

Sets if the subscription functionality is enabled.

Parameters:

enabled - the flag indicating if the subscription functionality is enabled

setMaxVisitedCount

public void setMaxVisitedCount(java.lang.String maxVisitedCount)

Sets the maximum number of visited resources to store per user.

Parameters:

maxVisitedCount - the maximum number of visited resources to store per user

setPoolName

public void setPoolName(java.lang.String poolName)

Sets the name of the database pool to use.

Parameters:

poolName - the name of the database pool to use

setSecurityManager

public void setSecurityManager(CmsSecurityManager securityManager)

Sets the security manager during initialization.

Parameters:

securityManager - the security manager

setSubscribedResourceAsDeleted

public void setSubscribedResourceAsDeleted(CmsObject cms,
                                  CmsResource resource)
                                    throws CmsException

Marks a subscribed resource as deleted.

Parameters:

cms - the current users context

resource - the subscribed resource to mark as deleted

Throws:

CmsException - if something goes wrong

subscribeResourceFor

public void subscribeResourceFor(CmsObject cms,
                        CmsPrincipal principal,
                        CmsResource resource)
                          throws CmsException

Subscribes the user or group to the resource.

Parameters:

cms - the current users context

principal - the principal that subscribes to the resource

resource - the resource to subscribe to

Throws:

CmsException - if something goes wrong

subscribeResourceFor

public void subscribeResourceFor(CmsObject cms,
                        CmsPrincipal principal,
                        java.lang.String resourcePath)
                          throws CmsException

Subscribes the user or group to the resource.

Parameters:

cms - the current users context

principal - the principal that subscribes to the resource

resourcePath - the name of the resource to subscribe to

Throws:

CmsException - if something goes wrong

unsubscribeAllDeletedResources

public void unsubscribeAllDeletedResources(CmsObject cms,
                                  long deletedTo)
                                    throws CmsException

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

Parameters:

cms - the current users context

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

Throws:

CmsException - if something goes wrong

unsubscribeAllResourcesFor

public void unsubscribeAllResourcesFor(CmsObject cms,
                              CmsPrincipal principal)
                                throws CmsException

Unsubscribes the user or group from all resources.

Parameters:

cms - the current users context

principal - the principal that unsubscribes from all resources

Throws:

CmsException - if something goes wrong

unsubscribeResourceFor

public void unsubscribeResourceFor(CmsObject cms,
                          CmsPrincipal principal,
                          CmsResource resource)
                            throws CmsException

Unsubscribes the principal from the resource.

Parameters:

cms - the current users context

principal - the principal that unsubscribes from the resource

resource - the resource to unsubscribe from

Throws:

CmsException - if something goes wrong

unsubscribeResourceFor

public void unsubscribeResourceFor(CmsObject cms,
                          CmsPrincipal principal,
                          java.lang.String resourcePath)
                            throws CmsException

Unsubscribes the principal from the resource.

Parameters:

cms - the current users context

principal - the principal that unsubscribes from the resource

resourcePath - the name of the resource to unsubscribe from

Throws:

CmsException - if something goes wrong

unsubscribeResourceForAll

public void unsubscribeResourceForAll(CmsObject cms,
                             CmsResource resource)
                               throws CmsException

Unsubscribes all groups and users from the resource.

Parameters:

cms - the current users context

resource - the resource to unsubscribe all groups and users from

Throws:

CmsException - if something goes wrong

unsubscribeResourceForAll

public void unsubscribeResourceForAll(CmsObject cms,
                             java.lang.String resourcePath)
                               throws CmsException

Unsubscribes all groups and users from the resource.

Parameters:

cms - the current users context

resourcePath - the name of the resource to unsubscribe all groups and users from

Throws:

CmsException - if something goes wrong