Package org.craftercms.studio.impl.v2.service.dashboard

Class DashboardServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.dashboard.DashboardServiceImpl

All Implemented Interfaces:

DashboardService

public class DashboardServiceImpl
extends Object
implements DashboardService

Constructor Summary

Constructors

Constructor	Description
DashboardServiceImpl(ActivityStreamServiceInternal activityStreamServiceInternal, PublishServiceInternal publishServiceInternal, ContentServiceInternal contentServiceInternal, SecurityService securityService, WorkflowServiceInternal workflowServiceInternal, ItemServiceInternal itemServiceInternal, SearchService searchService, StudioConfiguration studioConfiguration)

Method Summary

Modifier and Type	Method	Description
List<Activity>	getActivitiesForUsers(String siteId, List<String> usernames, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get activities for users
int	getActivitiesForUsersTotal(String siteId, List<String> usernames, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for activities of given users
ExpiringContentResult	getContentExpired(String siteId, int offset, int limit)	Get content that expired
ExpiringContentResult	getContentExpiring(String siteId, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get content that is expiring
List<DetailedItem>	getContentPendingApproval(String siteId, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get pending content for approval
List<SandboxItem>	getContentPendingApprovalDetail(String siteId, String publishingPackageId, List<org.craftercms.commons.rest.parameters.SortField> sortFields)	Get content pending approval package details
int	getContentPendingApprovalTotal(String siteId, List<String> systemTypes)	Get total number of content packages pending approval
List<SandboxItem>	getContentUnpublished(String siteId, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get unpublished content items
int	getContentUnpublishedTotal(String siteId, List<String> systemTypes)	Get total number of unpublished content
List<Activity>	getMyActivities(String siteId, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get my activities
int	getMyActivitiesTotal(String siteId, List<String> actions, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for my activities
List<DashboardPublishingPackage>	getPublishingHistory(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)	Get publishing history
List<SandboxItem>	getPublishingHistoryDetail(String siteId, String publishingPackageId, int offset, int limit)	Get publishing package details
int	getPublishingHistoryDetailTotalItems(String siteId, String publishingPackageId)	Get publishing package detail total items
int	getPublishingHistoryTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo)	Get total number of result for publishing history with given filters
List<DetailedItem>	getPublishingScheduled(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<String> systemTypes, List<org.craftercms.commons.rest.parameters.SortField> sortFields, int offset, int limit)	Get publishing scheduled
List<SandboxItem>	getPublishingScheduledDetail(String siteId, String publishingPackageId)	Get publishing package details
int	getPublishingScheduledTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<String> systemTypes)	Get total number of result for publishing scheduled with given filters
PublishingStats	getPublishingStats(String siteId, int days)	Get publishing stats for site for given time period
protected void	prepareSearchParams(SearchParams searchParams, String query, String order, int offset, int limit)
protected ExpiringContentResult	processResults(String siteId, SearchResult results)

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardServiceImpl

@ConstructorProperties({"activityStreamServiceInternal","publishServiceInternal","contentServiceInternal","securityService","workflowServiceInternal","itemServiceInternal","searchService","studioConfiguration"})
public DashboardServiceImpl(ActivityStreamServiceInternal activityStreamServiceInternal,
 PublishServiceInternal publishServiceInternal,
 ContentServiceInternal contentServiceInternal,
 SecurityService securityService,
 WorkflowServiceInternal workflowServiceInternal,
 ItemServiceInternal itemServiceInternal,
 SearchService searchService,
 StudioConfiguration studioConfiguration)

Method Details

getActivitiesForUsersTotal

public int getActivitiesForUsersTotal(String siteId,
 List<String> usernames,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                               throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of result for activities of given users

Specified by:

getActivitiesForUsersTotal in interface DashboardService

Parameters:

siteId - site identifier

usernames - list of usernames

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getActivitiesForUsers

public List<Activity> getActivitiesForUsers(String siteId,
 List<String> usernames,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                                     throws SiteNotFoundException

Description copied from interface: DashboardService

Get activities for users

Specified by:

getActivitiesForUsers in interface DashboardService

Parameters:

siteId - site identifier

usernames - list of usernames (or prefixes)

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

the list of activities

Throws:

SiteNotFoundException

getMyActivitiesTotal

public int getMyActivitiesTotal(String siteId,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                         throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of result for my activities

Specified by:

getMyActivitiesTotal in interface DashboardService

Parameters:

siteId - site identifier

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getMyActivities

public List<Activity> getMyActivities(String siteId,
 List<String> actions,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                               throws SiteNotFoundException

Description copied from interface: DashboardService

Get my activities

Specified by:

getMyActivities in interface DashboardService

Parameters:

siteId - site identifier

actions - list of actions to filter

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

the list of activities

Throws:

SiteNotFoundException

getContentPendingApprovalTotal

public int getContentPendingApprovalTotal(String siteId,
 List<String> systemTypes)
                                   throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of content packages pending approval

Specified by:

getContentPendingApprovalTotal in interface DashboardService

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

Returns:

number of results to return

Throws:

SiteNotFoundException

getContentPendingApproval

public List<DetailedItem> getContentPendingApproval(String siteId,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                             throws ServiceLayerException,
UserNotFoundException

Description copied from interface: DashboardService

Get pending content for approval

Specified by:

getContentPendingApproval in interface DashboardService

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

Returns:

list of DetailedItem waiting for approval

Throws:

ServiceLayerException

UserNotFoundException

getContentPendingApprovalDetail

public List<SandboxItem> getContentPendingApprovalDetail(String siteId,
 String publishingPackageId,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields)
                                                  throws UserNotFoundException,
ServiceLayerException

Description copied from interface: DashboardService

Get content pending approval package details

Specified by:

getContentPendingApprovalDetail in interface DashboardService

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getContentUnpublishedTotal

public int getContentUnpublishedTotal(String siteId,
 List<String> systemTypes)
                               throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of unpublished content

Specified by:

getContentUnpublishedTotal in interface DashboardService

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

Returns:

number of results to return

Throws:

SiteNotFoundException

getContentUnpublished

public List<SandboxItem> getContentUnpublished(String siteId,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                        throws UserNotFoundException,
ServiceLayerException

Description copied from interface: DashboardService

Get unpublished content items

Specified by:

getContentUnpublished in interface DashboardService

Parameters:

siteId - site identifier

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

Returns:

list of unpublished content items

Throws:

UserNotFoundException

ServiceLayerException

prepareSearchParams

protected void prepareSearchParams(SearchParams searchParams,
 String query,
 String order,
 int offset,
 int limit)

getContentExpiring

public ExpiringContentResult getContentExpiring(String siteId,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                                         throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Description copied from interface: DashboardService

Get content that is expiring

Specified by:

getContentExpiring in interface DashboardService

Parameters:

siteId - site identifier

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

list of content items that is expiring

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

getContentExpired

public ExpiringContentResult getContentExpired(String siteId,
 int offset,
 int limit)
                                        throws AuthenticationException,
ServiceLayerException,
UserNotFoundException

Description copied from interface: DashboardService

Get content that expired

Specified by:

getContentExpired in interface DashboardService

Parameters:

siteId - site identifier

offset - offset of the first result item

limit - number of results to return

Returns:

list of content items that expired

Throws:

AuthenticationException

ServiceLayerException

UserNotFoundException

processResults

protected ExpiringContentResult processResults(String siteId,
 SearchResult results)
                                        throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getPublishingScheduledTotal

public int getPublishingScheduledTotal(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 List<String> systemTypes)
                                throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of result for publishing scheduled with given filters

Specified by:

getPublishingScheduledTotal in interface DashboardService

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

systemTypes - list of system types to filter

Returns:

number of results

Throws:

SiteNotFoundException

getPublishingScheduled

public List<DetailedItem> getPublishingScheduled(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 List<String> systemTypes,
 List<org.craftercms.commons.rest.parameters.SortField> sortFields,
 int offset,
 int limit)
                                          throws ServiceLayerException,
UserNotFoundException

Description copied from interface: DashboardService

Get publishing scheduled

Specified by:

getPublishingScheduled in interface DashboardService

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

systemTypes - list of system types to filter

sortFields - list of sort fields

offset - offset of the first result item

limit - number of results to return

Returns:

list of DetailedItem scheduled for publishing

Throws:

ServiceLayerException

UserNotFoundException

getPublishingScheduledDetail

public List<SandboxItem> getPublishingScheduledDetail(String siteId,
 String publishingPackageId)
                                               throws UserNotFoundException,
ServiceLayerException

Description copied from interface: DashboardService

Get publishing package details

Specified by:

getPublishingScheduledDetail in interface DashboardService

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getPublishingHistoryTotal

public int getPublishingHistoryTotal(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo)
                              throws SiteNotFoundException

Description copied from interface: DashboardService

Get total number of result for publishing history with given filters

Specified by:

getPublishingHistoryTotal in interface DashboardService

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

Returns:

number of results

Throws:

SiteNotFoundException

getPublishingHistory

public List<DashboardPublishingPackage> getPublishingHistory(String siteId,
 String publishingTarget,
 String approver,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 int offset,
 int limit)
                                                      throws SiteNotFoundException

Description copied from interface: DashboardService

Get publishing history

Specified by:

getPublishingHistory in interface DashboardService

Parameters:

siteId - site identifier

publishingTarget - publishing target to filter by

approver - approver user to filter by

dateFrom - lower boundary to filter by date-time range

dateTo - upper boundary to filter by date-time range

offset - offset of the first result item

limit - number of results to return

Returns:

Throws:

SiteNotFoundException

getPublishingHistoryDetailTotalItems

public int getPublishingHistoryDetailTotalItems(String siteId,
 String publishingPackageId)
                                         throws SiteNotFoundException

Description copied from interface: DashboardService

Get publishing package detail total items

Specified by:

getPublishingHistoryDetailTotalItems in interface DashboardService

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

Returns:

number of package items

Throws:

SiteNotFoundException

getPublishingHistoryDetail

public List<SandboxItem> getPublishingHistoryDetail(String siteId,
 String publishingPackageId,
 int offset,
 int limit)
                                             throws UserNotFoundException,
ServiceLayerException

Description copied from interface: DashboardService

Get publishing package details

Specified by:

getPublishingHistoryDetail in interface DashboardService

Parameters:

siteId - site identifier

publishingPackageId - publishing package identifier

offset - offset of the first result item

limit - number of results to return

Returns:

list of sandbox items included in given package

Throws:

UserNotFoundException

ServiceLayerException

getPublishingStats

public PublishingStats getPublishingStats(String siteId,
 int days)
                                   throws SiteNotFoundException

Description copied from interface: DashboardService

Get publishing stats for site for given time period

Specified by:

getPublishingStats in interface DashboardService

Parameters:

siteId - site identifier

days - number of days

Returns:

publishing stats

Throws:

SiteNotFoundException