Interface DeploymentService
-
- All Known Implementing Classes:
DeploymentServiceImpl
public interface DeploymentService
// document
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
bulkGoLive(String site, String environment, String path, String comment)
Start executing bulk publish for given site, path on given environmentvoid
cancelWorkflow(String site, String path)
void
cancelWorkflowBulk(String site, Set<String> paths)
void
delete(String site, List<String> paths, String approver, ZonedDateTime scheduledDate, String submissionComment)
Delete contentvoid
deleteDeploymentDataForSite(String site)
void
deploy(String site, String environment, List<String> paths, ZonedDateTime scheduledDate, String approver, String submissionComment, boolean scheduleDateNow)
boolean
enablePublishing(String site, boolean enabled)
Enable/Disable publishing for given siteList<PublishRequest>
getScheduledItems(String site, String filterType)
List<ContentItemTO>
getScheduledItems(String site, String sort, boolean ascending, String subSort, boolean subAscending, String filterType)
void
publishCommits(String site, String environment, List<String> commitIds, String comment)
Publish given commit IDs on given environment for given sitevoid
publishItems(String site, String environment, ZonedDateTime schedule, List<String> paths, String submissionComment)
Publish items in given environment for given sitevoid
resetStagingEnvironment(String siteId)
Reset staging environment to live for given sitevoid
syncAllContentToPreview(String site, boolean waitTillDone)
-
-
-
Method Detail
-
deploy
void deploy(String site, String environment, List<String> paths, ZonedDateTime scheduledDate, String approver, String submissionComment, boolean scheduleDateNow) throws DeploymentException, ServiceLayerException, UserNotFoundException
-
delete
void delete(String site, List<String> paths, String approver, ZonedDateTime scheduledDate, String submissionComment) throws DeploymentException, SiteNotFoundException
Delete content- Parameters:
site
- site identifierpaths
- list of paths to deleteapprover
- user that approved deletionscheduledDate
- scheduled date to execute deletionsubmissionComment
- submission comment- Throws:
DeploymentException
- general deployment errorSiteNotFoundException
- if site does not exist
-
getScheduledItems
List<PublishRequest> getScheduledItems(String site, String filterType)
-
cancelWorkflow
void cancelWorkflow(String site, String path) throws DeploymentException
- Throws:
DeploymentException
-
cancelWorkflowBulk
void cancelWorkflowBulk(String site, Set<String> paths) throws DeploymentException
- Throws:
DeploymentException
-
deleteDeploymentDataForSite
void deleteDeploymentDataForSite(String site)
-
getScheduledItems
List<ContentItemTO> getScheduledItems(String site, String sort, boolean ascending, String subSort, boolean subAscending, String filterType) throws ServiceLayerException
- Throws:
ServiceLayerException
-
syncAllContentToPreview
void syncAllContentToPreview(String site, boolean waitTillDone) throws ServiceLayerException
- Throws:
ServiceLayerException
-
bulkGoLive
void bulkGoLive(String site, String environment, String path, String comment) throws ServiceLayerException
Start executing bulk publish for given site, path on given environment- Parameters:
site
- site identifierenvironment
- environment to publish topath
- base path for bulk publishcomment
- submission comment- Throws:
ServiceLayerException
- exception is case of en error
-
enablePublishing
boolean enablePublishing(String site, boolean enabled) throws SiteNotFoundException, AuthenticationException
Enable/Disable publishing for given site- Parameters:
site
- site idenabled
- true to enable publishing, false to disable publishing- Throws:
SiteNotFoundException
AuthenticationException
-
publishCommits
void publishCommits(String site, String environment, List<String> commitIds, String comment) throws SiteNotFoundException, EnvironmentNotFoundException, CommitNotFoundException
Publish given commit IDs on given environment for given site- Parameters:
site
- site id to use for publishingenvironment
- environment to use for publishingcommitIds
- commit IDs to publish- Throws:
SiteNotFoundException
EnvironmentNotFoundException
CommitNotFoundException
-
publishItems
void publishItems(String site, String environment, ZonedDateTime schedule, List<String> paths, String submissionComment) throws ServiceLayerException, DeploymentException, UserNotFoundException
Publish items in given environment for given site- Parameters:
site
- site id to use for publishingenvironment
- environment to use for publishingpaths
- item paths to publish- Throws:
SiteNotFoundException
EnvironmentNotFoundException
ServiceLayerException
DeploymentException
UserNotFoundException
-
resetStagingEnvironment
void resetStagingEnvironment(String siteId) throws ServiceLayerException, org.craftercms.commons.crypto.CryptoException
Reset staging environment to live for given site- Parameters:
siteId
- site id to use for resetting- Throws:
ServiceLayerException
org.craftercms.commons.crypto.CryptoException
-
-