|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SandboxService
Sandbox Service fundamental API.
This service API is designed to support the public facing Sandbox APIs.
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 |
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 version)
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 |
submit(java.lang.String sbStoreId,
java.lang.String relativePath,
java.lang.String submitLabel,
java.lang.String submitDescription)
Submit changed asset(s) for given sandbox path (eg. |
void |
submitAll(java.lang.String sbStoreId,
java.lang.String submitLabel,
java.lang.String submitDescription)
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 submitDescription)
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 submitDescription,
java.util.Map expirationDates,
java.util.Date launchDate,
boolean autoDeploy)
Deprecated. subject to change |
void |
submitListAssets(java.lang.String sbStoreId,
java.util.List assets,
java.lang.String submitLabel,
java.lang.String submitDescription)
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 submitDescription)
Submit changed assets for given sandbox and web app (eg. |
Method Detail |
---|
@Auditable(parameters="wpStoreId") SandboxInfo createAuthorSandbox(java.lang.String wpStoreId)
If the author sandbox already exists for this web project then it will be returned
wpStoreId
- web project store id
@Auditable(parameters={"wpStoreId", "userName"}) SandboxInfo createAuthorSandbox(java.lang.String wpStoreId, java.lang.String userName)
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
wpStoreId
- web project store iduserName
- user name
@NotAuditable java.util.List listSandboxes(java.lang.String wpStoreId)
wpStoreId
- web project store id
@NotAuditable java.util.List listSandboxes(java.lang.String wpStoreId, java.lang.String userName)
Current user must be a content manager for the web project
wpStoreId
- web project store iduserName
- user name
@NotAuditable boolean isSandboxType(java.lang.String sbStoreId, org.alfresco.service.namespace.QName sandboxType)
eg. isSandboxType("test123--myusername", SandboxConstants.PROP_SANDBOX_AUTHOR_MAIN)
sbStoreId
- sandbox store idsandboxType
- sandbox type (see SandboxConstants)
@NotAuditable SandboxInfo getSandbox(java.lang.String sbStoreId)
sbStoreId
- sandbox store id
@NotAuditable SandboxInfo getAuthorSandbox(java.lang.String wpStoreId)
Returns null if the author sandbox can not be found
wpStoreId
- web project store id
@NotAuditable SandboxInfo getAuthorSandbox(java.lang.String wpStoreId, java.lang.String userName)
Returns null if the user sandbox can not be found
Current user must be a content manager for the web project
wpStoreId
- web project store iduserName
- userName
@NotAuditable SandboxInfo getStagingSandbox(java.lang.String wpStoreId)
Returns null if the staging sandbox can not be found
wpStoreId
- web project store id
@Auditable(parameters="sbStoreId") void deleteSandbox(java.lang.String sbStoreId)
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)
sbStoreId
- sandbox store id@NotAuditable java.util.List listChangedAll(java.lang.String sbStoreId, boolean includeDeleted)
Note: This will list all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps
sbStoreId
- sandbox store idincludeDeleted
- if true, include deleted assets as well as new/modified assets
@NotAuditable java.util.List listChangedWebApp(java.lang.String sbStoreId, java.lang.String webApp, boolean includeDeleted)
Note: This will list new/modified/deleted assets for the given web app
sbStoreId
- sandbox store idwebApp
- web app to filter byincludeDeleted
- if true, include deleted assets as well as new/modified assets
@NotAuditable java.util.List listChanged(java.lang.String sbStoreId, java.lang.String relativePath, boolean includeDeleted)
Note: This will list new/modified/deleted assets from the directory and below. The destination path will be dervied.
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
@NotAuditable java.util.List listChanged(java.lang.String srcSandboxStoreId, java.lang.String srcRelativePath, java.lang.String dstSandboxStoreId, java.lang.String dstRelativePath, boolean includeDeleted)
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
@Auditable(parameters={"sbStoreId", "submitLabel", "submitDescription"}) void submitAll(java.lang.String sbStoreId, java.lang.String submitLabel, java.lang.String submitDescription)
Note: This will submit all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps
sbStoreId
- sandbox store idsubmitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshot@Auditable(parameters={"sbStoreId", "webApp", "submitLabel", "submitDescription"}) void submitWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String submitLabel, java.lang.String submitDescription)
Note: This will submit new/modified/deleted assets for the given web app
sbStoreId
- sandbox store idwebApp
- web app to filter bysubmitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshot@Auditable(parameters={"sbStoreId", "relativePath", "submitLabel", "submitDescription"}) void submit(java.lang.String sbStoreId, java.lang.String relativePath, java.lang.String submitLabel, java.lang.String submitDescription)
Note: This will submit new/modified/deleted asset(s) for given path (either file or directory and below)
sbStoreId
- sandbox store idrelativePath
- relative path to filter by (eg. /www/avm_webapps or /www/avm_webapps/ROOT/MyFolderToSubmit)submitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshot@Auditable(parameters={"sbStoreId", "relativePath", "submitLabel", "submitDescription"}) void submitList(java.lang.String sbStoreId, java.util.List relativePaths, java.lang.String submitLabel, java.lang.String submitDescription)
sbStoreId
- sandbox store idassetPaths
- list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit)submitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshot@Auditable(parameters={"sbStoreId", "assets", "submitLabel", "submitDescription"}) void submitListAssets(java.lang.String sbStoreId, java.util.List assets, java.lang.String submitLabel, java.lang.String submitDescription)
sbStoreId
- sandbox store idassetNodes
- list of assetssubmitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshot@NotAuditable 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 submitDescription, java.util.Map expirationDates, java.util.Date launchDate, boolean autoDeploy)
sbStoreId
- sandbox store idassetPaths
- list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit)workflowName
- selected workflow name - if null, will use default submit direct workflowworkflowParams
- configured workflow paramssubmitLabel
- label for submitted snapshotsubmitDescription
- description for submitted snapshotexpirationDates
- optional map of launchDate
- optional launch dateautoDeploy
- if true then will auto-deploy on workflow approval@Auditable(parameters="sbStoreId") void revertAll(java.lang.String sbStoreId)
Note: This will revert all new/modified/deleted assets from the sandbox store root directory (eg. /www/avm_webapps) - ie. across all web apps
sbStoreId
- sandbox store id@Auditable(parameters={"sbStoreId", "webApp"}) void revertWebApp(java.lang.String sbStoreId, java.lang.String webApp)
Note: This will revert new/modified/deleted assets for the given web app
sbStoreId
- sandbox store idwebApp
- web app to filter by@NotAuditable void revert(java.lang.String sbStoreId, java.lang.String relativePath)
Note: This will revert new/modified/deleted asset(s) for given path (either file or directory and below)
sbStoreId
- sandbox store idrelativePath
- relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToRevert)@NotAuditable void revertList(java.lang.String sbStoreId, java.util.List relativePaths)
sbStoreId
- sandbox store idassetPaths
- list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToRevert)@NotAuditable void revertListAssets(java.lang.String sbStoreId, java.util.List assets)
assets
- list of assets@NotAuditable void revertSnapshot(java.lang.String sbStoreId, int version)
Current user must be a content manager for the web project
sbStoreId
- staging sandbox store idversion
- version@NotAuditable java.util.List listSnapshots(java.lang.String sbStoreId, boolean includeSystemGenerated)
Current user must be a content manager for the web project
sbStoreId
- staging sandbox store idincludeSystemGenerated
- if false will ignore system generated snapshots else true to get all snapshots
@NotAuditable java.util.List listSnapshots(java.lang.String sbStoreId, java.util.Date from, java.util.Date to, boolean includeSystemGenerated)
Current user must be a content manager for the web project
sbStoreId
- staging sandbox store idfrom
- from dateto
- to dateincludeSystemGenerated
- if false will ignore system generated snapshots else true to get all snapshots
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |