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

Class PublishServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.publish.PublishServiceImpl

All Implemented Interfaces:

PublishService

public class PublishServiceImpl
extends Object
implements PublishService

Constructor Summary

Constructors

Constructor	Description
PublishServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	cancelPublishingPackages(String siteId, List<String> packageIds)	Cancel publishing packages
List<PublishingTarget>	getAvailablePublishingTargets(String siteId)	Get available publishing targets for given site
List<DeploymentHistoryGroup>	getDeploymentHistory(String siteId, int daysFromToday, int numberOfItems, String filterType)	Get deployment history
List<PublishingDashboardItem>	getPublishingHistory(String siteId, String environment, String path, String publisher, ZonedDateTime dateFrom, ZonedDateTime dateTo, String contentType, long state, String sortBy, String order, int offset, int limit)	Get deployment history items for given search parameters
int	getPublishingHistoryTotal(String siteId, String environment, String path, String publisher, ZonedDateTime dateFrom, ZonedDateTime dateTo, String contentType, long state)	Get total number of publishing history items for given search parameters
PublishingPackageDetails	getPublishingPackageDetails(String siteId, String packageId)	Get publishing package details
List<PublishingPackage>	getPublishingPackages(String siteId, String environment, String path, List<String> states, int offset, int limit)	Get publishing packages for given search parameters
int	getPublishingPackagesTotal(String siteId, String environment, String path, List<String> states)	Get total number of publishing packages for given search parameters
boolean	isSitePublished(String siteId)	Check if site has ever been published.
RepositoryChanges	publishAll(String siteId, String publishingTarget, String comment)	Publishes all changes for the given site & target
void	setActivityStreamServiceInternal(ActivityStreamServiceInternal activityStreamServiceInternal)
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setItemServiceInternal(ItemServiceInternal itemServiceInternal)
void	setPublishServiceInternal(PublishServiceInternal publishServiceInternal)
void	setSecurityService(SecurityService securityService)
void	setServicesConfig(ServicesConfig servicesConfig)
void	setSiteService(SiteService siteService)
void	setStudioUtils(StudioUtils studioUtils)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)

Methods inherited from class java.lang.Object

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

Constructor Details

PublishServiceImpl

public PublishServiceImpl()

Method Details

getPublishingPackagesTotal

public int getPublishingPackagesTotal(String siteId,
 String environment,
 String path,
 List<String> states)
                               throws SiteNotFoundException

Description copied from interface: PublishService

Get total number of publishing packages for given search parameters

Specified by:

getPublishingPackagesTotal in interface PublishService

Parameters:

siteId - site identifier

environment - publishing environment

path - regular expression for paths

states - publishing package states

Returns:

total number of publishing packages

Throws:

SiteNotFoundException - site not found

getPublishingPackages

public List<PublishingPackage> getPublishingPackages(String siteId,
 String environment,
 String path,
 List<String> states,
 int offset,
 int limit)
                                              throws SiteNotFoundException

Description copied from interface: PublishService

Get publishing packages for given search parameters

Specified by:

getPublishingPackages in interface PublishService

Parameters:

siteId - site identifier

environment - publishing environment

path - regular expression for paths

states - publishing package states

offset - offset for pagination

limit - limit for pagination

Returns:

list of publishing packages

Throws:

SiteNotFoundException - site not found

getPublishingPackageDetails

public PublishingPackageDetails getPublishingPackageDetails(String siteId,
 String packageId)
                                                     throws SiteNotFoundException,
PublishingPackageNotFoundException

Description copied from interface: PublishService

Get publishing package details

Specified by:

getPublishingPackageDetails in interface PublishService

Parameters:

siteId - site identifier

packageId - package identifier

Returns:

publishing package details

Throws:

SiteNotFoundException - site not found

PublishingPackageNotFoundException

cancelPublishingPackages

public void cancelPublishingPackages(String siteId,
 List<String> packageIds)
                              throws ServiceLayerException,
UserNotFoundException

Description copied from interface: PublishService

Cancel publishing packages

Specified by:

cancelPublishingPackages in interface PublishService

Parameters:

siteId - site identifier

packageIds - list of package identifiers

Throws:

ServiceLayerException

UserNotFoundException

getPublishingHistoryTotal

public int getPublishingHistoryTotal(String siteId,
 String environment,
 String path,
 String publisher,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 String contentType,
 long state)

Description copied from interface: PublishService

Get total number of publishing history items for given search parameters

Specified by:

getPublishingHistoryTotal in interface PublishService

Parameters:

siteId - site identifier

environment - environment to get publishing history

path - regular expression to filter paths

publisher - filter publishing history for specified user

dateFrom - lower boundary for date range

dateTo - upper boundary for date range

contentType - publishing history for specified content type

state - filter items by their state

Returns:

total number of deployment history items

getPublishingHistory

public List<PublishingDashboardItem> getPublishingHistory(String siteId,
 String environment,
 String path,
 String publisher,
 ZonedDateTime dateFrom,
 ZonedDateTime dateTo,
 String contentType,
 long state,
 String sortBy,
 String order,
 int offset,
 int limit)

Description copied from interface: PublishService

Get deployment history items for given search parameters

Specified by:

getPublishingHistory in interface PublishService

Parameters:

siteId - site identifier

environment - environment to get publishing history

path - regular expression to filter paths

publisher - filter publishing history for specified user

dateFrom - lower boundary for date range

dateTo - upper boundary for date range

contentType - publishing history for specified content type

state - filter items by their state

sortBy - sort publishing history

order - apply order to publishing history

offset - offset of the first item in the result set

limit - number of items to return

Returns:

total number of publishing packages

getDeploymentHistory

public List<DeploymentHistoryGroup> getDeploymentHistory(String siteId,
 int daysFromToday,
 int numberOfItems,
 String filterType)
                                                  throws ServiceLayerException,
UserNotFoundException

Description copied from interface: PublishService

Get deployment history

Specified by:

getDeploymentHistory in interface PublishService

Parameters:

siteId - site identifier

daysFromToday - number of days for history

numberOfItems - number of items to display

filterType - filter results by filter type

Returns:

Throws:

ServiceLayerException

UserNotFoundException

publishAll

public RepositoryChanges publishAll(String siteId,
 String publishingTarget,
 String comment)
                             throws ServiceLayerException,
UserNotFoundException

Description copied from interface: PublishService

Publishes all changes for the given site & target

Specified by:

publishAll in interface PublishService

Parameters:

siteId - the id of the site

publishingTarget - the publishing target

comment - submission comment

Returns:

result of the publishing

Throws:

ServiceLayerException - if there is any error during publishing

UserNotFoundException

getAvailablePublishingTargets

public List<PublishingTarget> getAvailablePublishingTargets(String siteId)
                                                     throws SiteNotFoundException

Description copied from interface: PublishService

Get available publishing targets for given site

Specified by:

getAvailablePublishingTargets in interface PublishService

Parameters:

siteId - site identifier

Returns:

list of available publishing targets

Throws:

SiteNotFoundException - Site doesn't exist

isSitePublished

public boolean isSitePublished(String siteId)
                        throws SiteNotFoundException

Description copied from interface: PublishService

Check if site has ever been published.

Specified by:

isSitePublished in interface PublishService

Parameters:

siteId - site identifier

Returns:

true if site has been published at least once, otherwise false

Throws:

SiteNotFoundException - Site doesn't exist

setPublishServiceInternal

public void setPublishServiceInternal(PublishServiceInternal publishServiceInternal)

setSiteService

public void setSiteService(SiteService siteService)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

setSecurityService

public void setSecurityService(SecurityService securityService)

setItemServiceInternal

public void setItemServiceInternal(ItemServiceInternal itemServiceInternal)

setStudioUtils

public void setStudioUtils(StudioUtils studioUtils)

setServicesConfig

public void setServicesConfig(ServicesConfig servicesConfig)

setActivityStreamServiceInternal

public void setActivityStreamServiceInternal(ActivityStreamServiceInternal activityStreamServiceInternal)

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)