Package org.craftercms.studio.api.v2.service.publish.internal

Interface PublishServiceInternal

All Known Implementing Classes:
PublishServiceInternalImpl
public interface PublishServiceInternal

  • Method Details

    • getPublishingPackagesTotal

      int getPublishingPackagesTotal(String siteId, String environment, String path, List<String> states)
      Get total number of publishing packages for given search parameters
      Parameters:
      siteId - site identifier
      environment - publishing environment
      path - regular expression for paths
      states - publishing package states
      Returns:
      total number of publishing packages

    • getPublishingPackages

      List<PublishingPackage> getPublishingPackages(String siteId, String environment, String path, List<String> states, int offset, int limit)
      Get publishing packages for given search parameters
      Parameters:
      siteId - site identifier
      environment - publishing environment
      path - regular expression for paths
      states - publishing package state
      offset - offset for pagination
      limit - limit for pagination
      Returns:
      list of publishing packages

    • getPublishingPackageDetails

      PublishingPackageDetails getPublishingPackageDetails(String siteId, String packageId)
      Get publishing package details
      Parameters:
      siteId - site identifier
      packageId - package identifier
      Returns:
      publishing package details

    • cancelPublishingPackages

      void cancelPublishingPackages(String siteId, List<String> packageIds)
      Cancel publishing packages
      Parameters:
      siteId - site identifier
      packageIds - list of package identifiers

    • getPublishingHistoryTotal

      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
      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

      List<PublishingHistoryItem> 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
      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

    • getPublishingHistoryDetailTotalItems

      int getPublishingHistoryDetailTotalItems(String siteId, String packageId)
      Get publishing history package detail total items
      Parameters:
      siteId - site identifier
      packageId - package identifier
      Returns:
      number of package items

    • getPublishingHistoryDetail

      List<PublishRequest> getPublishingHistoryDetail(String siteId, String packageId, int offset, int limit)
      Get publishing history package detail items
      Parameters:
      siteId - site identifier
      packageId - package identifier
      offset - offset of the first result
      limit - limit number of results
      Returns:
      publishing history package's items

    • getDeploymentHistory

      List<DeploymentHistoryItem> getDeploymentHistory(String siteId, List<String> environments, ZonedDateTime fromDate, ZonedDateTime toDate, String filterType, int numberOfItems)
      Get deployment history from database
      Parameters:
      siteId - site identifier
      environments - list of environments
      fromDate - starting date for filtering results
      toDate - end date for filtering results
      filterType - filter type
      numberOfItems - number of items to get
      Returns:

    • cancelScheduledQueueItems

      void cancelScheduledQueueItems(String siteId, List<String> paths)
      Cancel scheduled items from publishing queue
      Parameters:
      siteId - site identifier
      paths - list of paths of content items to be cancelled

    • isSitePublished

      boolean isSitePublished(String siteId)
      Check if site has ever been published.
      Parameters:
      siteId - site identifier
      Returns:
      true if site has been published at least once, otherwise false

    • initialPublish

      void initialPublish(String siteId) throws SiteNotFoundException
      Execute initial publish for given site.
      Parameters:
      siteId - site identifier
      Throws:
      SiteNotFoundException

    • getPublishingItemsScheduledTotal

      int getPublishingItemsScheduledTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, List<String> systemTypes)
      Get total number of scheduled publishing items for given filters
      Parameters:
      siteId - site identifier
      publishingTarget - publishing target
      approver - approver
      dateFrom - lower boundary for schedule
      dateTo - upper boundary for schedule
      systemTypes - system types
      Returns:
      total number of results

    • getPublishingItemsScheduled

      List<PublishRequest> getPublishingItemsScheduled(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 scheduled publishing items
      Parameters:
      siteId - site identifier
      publishingTarget - publishing target
      approver - approver
      dateFrom - lower boundary for schedule
      dateTo - upper boundary for schedule
      systemTypes - system types
      sortFields - sort fields
      offset - offset of the first result
      limit - limit number of results
      Returns:
      list of publishing request items

    • getPublishingPackagesHistoryTotal

      int getPublishingPackagesHistoryTotal(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo)
      Get total number of publishing packages for given filters
      Parameters:
      siteId - site identifier
      publishingTarget - publishing target
      approver - approver
      dateFrom - lower boundary for history
      dateTo - upper boundary for history
      Returns:
      total number of results

    • getPublishingPackagesHistory

      List<DashboardPublishingPackage> getPublishingPackagesHistory(String siteId, String publishingTarget, String approver, ZonedDateTime dateFrom, ZonedDateTime dateTo, int offset, int limit)
      Get publishing packages history
      Parameters:
      siteId - site identifier
      publishingTarget - publishing target
      approver - approver
      dateFrom - lower boundary for history
      dateTo - upper boundary for history
      offset - offset of the first result
      limit - limit number of results
      Returns:
      list of dashboard publishing packages

    • getNumberOfPublishes

      int getNumberOfPublishes(String siteId, int days)
      Get number of publishes for site in given number of days
      Parameters:
      siteId - site identifiers
      days - number of days
      Returns:
      number of publishes

    • getNumberOfPublishedItemsByState

      int getNumberOfPublishedItemsByState(String siteId, int days, String activityAction, String publishState, String publishAction)
      Get number of published items for site in given number of days filtered by their previous state
      Parameters:
      siteId - site identifier
      days - number of days
      activityAction - the activity action to filter
      publishState - the publishing state to filter
      publishAction - the publishing action to filter
      Returns:
      number of newly created and published items

    • publishAll

      RepositoryChanges publishAll(String siteId, String publishingTarget, String comment) throws ServiceLayerException
      Publishes all changes for the given site & target
      Parameters:
      siteId - the id of the site
      publishingTarget - the publishing target
      Throws:
      ServiceLayerException - if there is any error during publishing