|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.wcm.sandbox.SandboxServiceImpl
public class SandboxServiceImpl
Sandbox Service fundamental API.
This service API is designed to support the public facing Sandbox APIs.
Constructor Summary | |
---|---|
SandboxServiceImpl()
|
Method Summary | |
---|---|
SandboxInfo |
createAuthorSandbox(java.lang.String wpStoreId)
Create author/user sandbox within a web project for the current user |
SandboxInfo |
createAuthorSandbox(java.lang.String wpStoreId,
java.lang.String userName)
Create author/user sandbox within a web project for the given user |
protected org.alfresco.util.Pair |
createWorkflowSandbox(java.lang.String workflowName,
java.util.Map workflowParams,
java.lang.String stagingSandboxId,
java.util.List srcPaths,
java.util.Map expirationDates)
Creates a workflow sandbox for all the submitted items |
void |
deleteSandbox(java.lang.String sbStoreId)
Delete the sandbox |
SandboxInfo |
getAuthorSandbox(java.lang.String wpStoreId)
Gets author/user sandbox info for the current user |
SandboxInfo |
getAuthorSandbox(java.lang.String wpStoreId,
java.lang.String userName)
Gets author/user sandbox info for the given user |
SandboxInfo |
getSandbox(java.lang.String sbStoreId)
Get sandbox info |
SandboxInfo |
getStagingSandbox(java.lang.String wpStoreId)
Gets staging sandbox info |
boolean |
isSandboxType(java.lang.String sbStoreId,
org.alfresco.service.namespace.QName sandboxType)
Return true if sandbox is visible to user and is of given type |
java.util.List |
listChanged(java.lang.String sbStoreId,
java.lang.String relativePath,
boolean includeDeleted)
List changed assets for given sandbox path (eg. |
java.util.List |
listChanged(java.lang.String srcSandboxStoreId,
java.lang.String srcRelativePath,
java.lang.String dstSandboxStoreId,
java.lang.String dstRelativePath,
boolean includeDeleted)
List changed (new/modified/deleted) assets between any two sandbox paths |
java.util.List |
listChangedAll(java.lang.String sbStoreId,
boolean includeDeleted)
List all changed assets for given sandbox (eg. |
java.util.List |
listChangedWebApp(java.lang.String sbStoreId,
java.lang.String webApp,
boolean includeDeleted)
List changed assets for given sandbox and web app (eg. |
java.util.List |
listSandboxes(java.lang.String wpStoreId)
List the available sandboxes for the current user and given web project |
java.util.List |
listSandboxes(java.lang.String wpStoreId,
java.lang.String userName)
List the available sandboxes for the given user and web project |
java.util.List |
listSnapshots(java.lang.String sbStoreId,
boolean includeSystemGenerated)
List all snapshots (sandbox versions) for the given sandbox (ie. |
java.util.List |
listSnapshots(java.lang.String sbStoreId,
java.util.Date from,
java.util.Date to,
boolean includeSystemGenerated)
List snapshots (sandbox versions) for the given sandbox between given dates (ie. |
void |
revert(java.lang.String sbStoreId,
java.lang.String relativePath)
Revert changed asset(s) for given sandbox path (eg. |
void |
revertAll(java.lang.String sbStoreId)
Revert all changed assets for given sandbox (eg. |
void |
revertList(java.lang.String sbStoreId,
java.util.List relativePaths)
Revert list of changed assets for given sandbox (eg. |
void |
revertListAssets(java.lang.String sbStoreId,
java.util.List assets)
Revert list of changed assets for given sandbox (eg. |
void |
revertSnapshot(java.lang.String sbStoreId,
int revertVersion)
Revert sandbox to a specific snapshot version ID (ie. |
void |
revertWebApp(java.lang.String sbStoreId,
java.lang.String webApp)
Revert changed assets for given sandbox and web app (eg. |
void |
setAssetService(AssetService assetService)
|
void |
setAvmLockingService(AVMLockingService avmLockingService)
|
void |
setAvmService(AVMService avmService)
|
void |
setAvmSyncService(AVMSyncService avmSyncService)
|
void |
setNameMatcher(org.alfresco.util.NameMatcher nameMatcher)
|
void |
setSandboxFactory(SandboxFactory sandboxFactory)
|
void |
setTransactionService(TransactionService transactionService)
|
void |
setVirtServerRegistry(org.alfresco.mbeans.VirtServerRegistry virtServerRegistry)
|
void |
setWebProjectService(WebProjectService wpService)
|
void |
setWorkflowService(WorkflowService workflowService)
|
protected void |
startWorkflow(java.lang.String wpStoreId,
java.lang.String sbStoreId,
SandboxInfo wfSandboxInfo,
java.lang.String webApp,
java.lang.String workflowName,
java.util.Map workflowParams,
java.lang.String submitLabel,
java.lang.String submitComment,
java.util.Date launchDate,
boolean autoDeploy)
Starts the configured workflow to allow the submitted items to be link checked and reviewed. |
void |
submit(java.lang.String sbStoreId,
java.lang.String relativePath,
java.lang.String submitLabel,
java.lang.String submitComment)
Submit changed asset(s) for given sandbox path (eg. |
void |
submitAll(java.lang.String sbStoreId,
java.lang.String submitLabel,
java.lang.String submitComment)
Submit all changed assets for given sandbox (eg. |
void |
submitList(java.lang.String sbStoreId,
java.util.List relativePaths,
java.lang.String submitLabel,
java.lang.String submitComment)
Submit list of changed assets for given sandbox (eg. |
void |
submitListAssets(java.lang.String sbStoreId,
java.util.List relativePaths,
java.lang.String workflowName,
java.util.Map workflowParams,
java.lang.String submitLabel,
java.lang.String submitComment,
java.util.Map expirationDates,
java.util.Date launchDate,
boolean autoDeploy)
Submit list of changed assets for given sandbox (eg. |
void |
submitListAssets(java.lang.String sbStoreId,
java.util.List assets,
java.lang.String submitLabel,
java.lang.String submitComment)
Submit list of changed assets for given sandbox (eg. |
void |
submitWebApp(java.lang.String sbStoreId,
java.lang.String webApp,
java.lang.String submitLabel,
java.lang.String submitComment)
Submit changed assets for given sandbox and web app (eg. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SandboxServiceImpl()
Method Detail |
---|
public void setWebProjectService(WebProjectService wpService)
public void setSandboxFactory(SandboxFactory sandboxFactory)
public void setAvmService(AVMService avmService)
public void setAvmLockingService(AVMLockingService avmLockingService)
public void setAvmSyncService(AVMSyncService avmSyncService)
public void setNameMatcher(org.alfresco.util.NameMatcher nameMatcher)
public void setVirtServerRegistry(org.alfresco.mbeans.VirtServerRegistry virtServerRegistry)
public void setWorkflowService(WorkflowService workflowService)
public void setAssetService(AssetService assetService)
public void setTransactionService(TransactionService transactionService)
public SandboxInfo createAuthorSandbox(java.lang.String wpStoreId)
SandboxService
If the author sandbox already exists for this web project then it will be returned
createAuthorSandbox
in interface SandboxService
wpStoreId
- web project store id
public SandboxInfo createAuthorSandbox(java.lang.String wpStoreId, java.lang.String userName)
SandboxService
If the author sandbox already exists for this web project then it will be returned
Current user must be a content manager for the web project
createAuthorSandbox
in interface SandboxService
wpStoreId
- web project store iduserName
- user name
public java.util.List listSandboxes(java.lang.String wpStoreId)
SandboxService
listSandboxes
in interface SandboxService
wpStoreId
- web project store id
public java.util.List listSandboxes(java.lang.String wpStoreId, java.lang.String userName)
SandboxService
Current user must be a content manager for the web project
listSandboxes
in interface SandboxService
wpStoreId
- web project store iduserName
- user name
public boolean isSandboxType(java.lang.String sbStoreId, org.alfresco.service.namespace.QName sandboxType)
SandboxService
eg. isSandboxType("test123--myusername", SandboxConstants.PROP_SANDBOX_AUTHOR_MAIN)
isSandboxType
in interface SandboxService
sbStoreId
- sandbox store idsandboxType
- sandbox type (see SandboxConstants)
public SandboxInfo getSandbox(java.lang.String sbStoreId)
SandboxService
getSandbox
in interface SandboxService
sbStoreId
- sandbox store id
public SandboxInfo getAuthorSandbox(java.lang.String wpStoreId)
SandboxService
Returns null if the author sandbox can not be found
getAuthorSandbox
in interface SandboxService
wpStoreId
- web project store id
public SandboxInfo getAuthorSandbox(java.lang.String wpStoreId, java.lang.String userName)
SandboxService
Returns null if the user sandbox can not be found
Current user must be a content manager for the web project
getAuthorSandbox
in interface SandboxService
wpStoreId
- web project store iduserName
- userName
public SandboxInfo getStagingSandbox(java.lang.String wpStoreId)
SandboxService
Returns null if the staging sandbox can not be found
getStagingSandbox
in interface SandboxService
wpStoreId
- web project store id
public void deleteSandbox(java.lang.String sbStoreId)
SandboxService
If the sandbox does not exist, will log a warning and succeed
Current user must be a content manager for the web project (associated with the sandbox)
deleteSandbox
in interface SandboxService
sbStoreId
- sandbox store idpublic java.util.List listChangedAll(java.lang.String sbStoreId, boolean includeDeleted)
SandboxService
Note: This will list all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps
listChangedAll
in interface SandboxService
sbStoreId
- sandbox store idincludeDeleted
- if true, include deleted assets as well as new/modified assets
public java.util.List listChangedWebApp(java.lang.String sbStoreId, java.lang.String webApp, boolean includeDeleted)
SandboxService
Note: This will list new/modified/deleted assets for the given web app
listChangedWebApp
in interface SandboxService
sbStoreId
- sandbox store idwebApp
- web app to filter byincludeDeleted
- if true, include deleted assets as well as new/modified assets
public java.util.List listChanged(java.lang.String sbStoreId, java.lang.String relativePath, boolean includeDeleted)
SandboxService
Note: This will list new/modified/deleted assets from the directory and below. The destination path will be dervied.
listChanged
in interface SandboxService
sbStoreId
- sandbox store idrelativePath
- relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)includeDeleted
- if true, include deleted assets as well as new/modified assets
public java.util.List listChanged(java.lang.String srcSandboxStoreId, java.lang.String srcRelativePath, java.lang.String dstSandboxStoreId, java.lang.String dstRelativePath, boolean includeDeleted)
SandboxService
listChanged
in interface SandboxService
srcSandboxStoreId
- source sandbox store idsrcRelativePath
- source relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)dstSandboxStoreId
- destination sandbox store iddstRelativePath
- destination relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)includeDeleted
- if true, include deleted assets as well as new/modified assets
public void submitAll(java.lang.String sbStoreId, java.lang.String submitLabel, java.lang.String submitComment)
SandboxService
Note: This will submit all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps
submitAll
in interface SandboxService
sbStoreId
- sandbox store idsubmitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotpublic void submitWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String submitLabel, java.lang.String submitComment)
SandboxService
Note: This will submit new/modified/deleted assets for the given web app
submitWebApp
in interface SandboxService
sbStoreId
- sandbox store idwebApp
- web app to filter bysubmitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotpublic void submit(java.lang.String sbStoreId, java.lang.String relativePath, java.lang.String submitLabel, java.lang.String submitComment)
SandboxService
Note: This will submit new/modified/deleted asset(s) for given path (either file or directory and below)
submit
in interface SandboxService
sbStoreId
- sandbox store idrelativePath
- relative path to filter by (eg. /www/avm_webapps or /www/avm_webapps/ROOT/MyFolderToSubmit)submitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotpublic void submitList(java.lang.String sbStoreId, java.util.List relativePaths, java.lang.String submitLabel, java.lang.String submitComment)
SandboxService
submitList
in interface SandboxService
sbStoreId
- sandbox store idsubmitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotpublic void submitListAssets(java.lang.String sbStoreId, java.util.List assets, java.lang.String submitLabel, java.lang.String submitComment)
SandboxService
submitListAssets
in interface SandboxService
sbStoreId
- sandbox store idsubmitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotpublic void submitListAssets(java.lang.String sbStoreId, java.util.List relativePaths, java.lang.String workflowName, java.util.Map workflowParams, java.lang.String submitLabel, java.lang.String submitComment, java.util.Map expirationDates, java.util.Date launchDate, boolean autoDeploy)
SandboxService
submitListAssets
in interface SandboxService
sbStoreId
- sandbox store idworkflowName
- selected workflow name - if null, will use default submit direct workflowworkflowParams
- configured workflow paramssubmitLabel
- label for submitted snapshotsubmitComment
- description for submitted snapshotexpirationDates
- optional map of launchDate
- optional launch dateautoDeploy
- if true then will auto-deploy on workflow approvalprotected org.alfresco.util.Pair createWorkflowSandbox(java.lang.String workflowName, java.util.Map workflowParams, java.lang.String stagingSandboxId, java.util.List srcPaths, java.util.Map expirationDates)
context
- Faces contextprotected void startWorkflow(java.lang.String wpStoreId, java.lang.String sbStoreId, SandboxInfo wfSandboxInfo, java.lang.String webApp, java.lang.String workflowName, java.util.Map workflowParams, java.lang.String submitLabel, java.lang.String submitComment, java.util.Date launchDate, boolean autoDeploy)
public void revertAll(java.lang.String sbStoreId)
SandboxService
Note: This will revert all new/modified/deleted assets from the sandbox store root directory (eg. /www/avm_webapps) - ie. across all web apps
revertAll
in interface SandboxService
sbStoreId
- sandbox store idpublic void revertWebApp(java.lang.String sbStoreId, java.lang.String webApp)
SandboxService
Note: This will revert new/modified/deleted assets for the given web app
revertWebApp
in interface SandboxService
sbStoreId
- sandbox store idwebApp
- web app to filter bypublic void revert(java.lang.String sbStoreId, java.lang.String relativePath)
SandboxService
Note: This will revert new/modified/deleted asset(s) for given path (either file or directory and below)
revert
in interface SandboxService
sbStoreId
- sandbox store idrelativePath
- relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToRevert)public void revertList(java.lang.String sbStoreId, java.util.List relativePaths)
SandboxService
revertList
in interface SandboxService
sbStoreId
- sandbox store idpublic void revertListAssets(java.lang.String sbStoreId, java.util.List assets)
SandboxService
revertListAssets
in interface SandboxService
assets
- list of assetspublic java.util.List listSnapshots(java.lang.String sbStoreId, boolean includeSystemGenerated)
SandboxService
Current user must be a content manager for the web project
listSnapshots
in interface SandboxService
sbStoreId
- staging sandbox store idincludeSystemGenerated
- if false will ignore system generated snapshots else true to get all snapshots
public java.util.List listSnapshots(java.lang.String sbStoreId, java.util.Date from, java.util.Date to, boolean includeSystemGenerated)
SandboxService
Current user must be a content manager for the web project
listSnapshots
in interface SandboxService
sbStoreId
- staging sandbox store idfrom
- from dateto
- to dateincludeSystemGenerated
- if false will ignore system generated snapshots else true to get all snapshots
public void revertSnapshot(java.lang.String sbStoreId, int revertVersion)
SandboxService
Current user must be a content manager for the web project
revertSnapshot
in interface SandboxService
sbStoreId
- staging sandbox store idrevertVersion
- version
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |