org.alfresco.wcm.sandbox
Interface SandboxService

All Known Implementing Classes:
SandboxServiceImpl

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

createAuthorSandbox

@Auditable(parameters="wpStoreId")
SandboxInfo createAuthorSandbox(java.lang.String wpStoreId)
Create author/user sandbox within a web project for the current user

If the author sandbox already exists for this web project then it will be returned

Parameters:
wpStoreId - web project store id
Returns:
SandboxInfo the created user sandbox info

createAuthorSandbox

@Auditable(parameters={"wpStoreId", "userName"})
SandboxInfo createAuthorSandbox(java.lang.String wpStoreId,
                                          java.lang.String userName)
Create author/user sandbox within a web project for the given user

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

Parameters:
wpStoreId - web project store id
userName - user name
Returns:
SandboxInfo the created user sandbox info

listSandboxes

@NotAuditable
java.util.List listSandboxes(java.lang.String wpStoreId)
List the available sandboxes for the current user and given web project

Parameters:
wpStoreId - web project store id
Returns:
List list of sandbox info

listSandboxes

@NotAuditable
java.util.List listSandboxes(java.lang.String wpStoreId,
                                          java.lang.String userName)
List the available sandboxes for the given user and web project

Current user must be a content manager for the web project

Parameters:
wpStoreId - web project store id
userName - user name
Returns:
List list of sandbox info

isSandboxType

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

eg. isSandboxType("test123--myusername", SandboxConstants.PROP_SANDBOX_AUTHOR_MAIN)

Parameters:
sbStoreId - sandbox store id
sandboxType - sandbox type (see SandboxConstants)
Returns:
boolean true, if sandbox exists with given type

getSandbox

@NotAuditable
SandboxInfo getSandbox(java.lang.String sbStoreId)
Get sandbox info

Parameters:
sbStoreId - sandbox store id
Returns:
SandboxInfo null if sandbox does not exist or is not visible to the current user

getAuthorSandbox

@NotAuditable
SandboxInfo getAuthorSandbox(java.lang.String wpStoreId)
Gets author/user sandbox info for the current user

Returns null if the author sandbox can not be found

Parameters:
wpStoreId - web project store id
Returns:
SandboxInfo author sandbox info

getAuthorSandbox

@NotAuditable
SandboxInfo getAuthorSandbox(java.lang.String wpStoreId,
                                          java.lang.String userName)
Gets author/user sandbox info for the given user

Returns null if the user sandbox can not be found

Current user must be a content manager for the web project

Parameters:
wpStoreId - web project store id
userName - userName
Returns:
SandboxInfo author sandbox info

getStagingSandbox

@NotAuditable
SandboxInfo getStagingSandbox(java.lang.String wpStoreId)
Gets staging sandbox info

Returns null if the staging sandbox can not be found

Parameters:
wpStoreId - web project store id
Returns:
SandboxInfo staging sandbox info

deleteSandbox

@Auditable(parameters="sbStoreId")
void deleteSandbox(java.lang.String sbStoreId)
Delete the sandbox

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)

Parameters:
sbStoreId - sandbox store id

listChangedAll

@NotAuditable
java.util.List listChangedAll(java.lang.String sbStoreId,
                                           boolean includeDeleted)
List all changed assets for given sandbox (eg. for user sandbox compared to staging sandbox)

Note: This will list all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps

Parameters:
sbStoreId - sandbox store id
includeDeleted - if true, include deleted assets as well as new/modified assets
Returns:
List list of all changed assets

listChangedWebApp

@NotAuditable
java.util.List listChangedWebApp(java.lang.String sbStoreId,
                                              java.lang.String webApp,
                                              boolean includeDeleted)
List changed assets for given sandbox and web app (eg. in user sandbox)

Note: This will list new/modified/deleted assets for the given web app

Parameters:
sbStoreId - sandbox store id
webApp - web app to filter by
includeDeleted - if true, include deleted assets as well as new/modified assets
Returns:
List list of changed assets

listChanged

@NotAuditable
java.util.List listChanged(java.lang.String sbStoreId,
                                        java.lang.String relativePath,
                                        boolean includeDeleted)
List changed assets for given sandbox path (eg. between user sandbox and staging sandbox)

Note: This will list new/modified/deleted assets from the directory and below. The destination path will be dervied.

Parameters:
sbStoreId - sandbox store id
relativePath - relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)
includeDeleted - if true, include deleted assets as well as new/modified assets
Returns:
List list of changed assets

listChanged

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

Parameters:
srcSandboxStoreId - source sandbox store id
srcRelativePath - source relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)
dstSandboxStoreId - destination sandbox store id
dstRelativePath - destination relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToList)
includeDeleted - if true, include deleted assets as well as new/modified assets
Returns:
List list of changed assets

submitAll

@Auditable(parameters={"sbStoreId", "submitLabel", "submitDescription"})
void submitAll(java.lang.String sbStoreId,
                         java.lang.String submitLabel,
                         java.lang.String submitDescription)
Submit all changed assets for given sandbox (eg. from user sandbox to staging sandbox)

Note: This will submit all new/modified/deleted assets from the sandbox root directory (eg. /www/avm_webapps) - ie. across all web apps

Parameters:
sbStoreId - sandbox store id
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot

submitWebApp

@Auditable(parameters={"sbStoreId", "webApp", "submitLabel", "submitDescription"})
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. in user sandbox)

Note: This will submit new/modified/deleted assets for the given web app

Parameters:
sbStoreId - sandbox store id
webApp - web app to filter by
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot

submit

@Auditable(parameters={"sbStoreId", "relativePath", "submitLabel", "submitDescription"})
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. in user sandbox)

Note: This will submit new/modified/deleted asset(s) for given path (either file or directory and below)

Parameters:
sbStoreId - sandbox store id
relativePath - relative path to filter by (eg. /www/avm_webapps or /www/avm_webapps/ROOT/MyFolderToSubmit)
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot

submitList

@Auditable(parameters={"sbStoreId", "relativePath", "submitLabel", "submitDescription"})
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. in user sandbox)

Parameters:
sbStoreId - sandbox store id
assetPaths - list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit)
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot

submitListAssets

@Auditable(parameters={"sbStoreId", "assets", "submitLabel", "submitDescription"})
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. from user sandbox to staging sandbox)

Parameters:
sbStoreId - sandbox store id
assetNodes - list of assets
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot

submitListAssets

@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)
Deprecated. subject to change

Submit list of changed assets for given sandbox (eg. from user sandbox to staging sandbox) NOTE: for backwards compatibility - subject to change - hence deprecated for now

Parameters:
sbStoreId - sandbox store id
assetPaths - list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToSubmit)
workflowName - selected workflow name - if null, will use default submit direct workflow
workflowParams - configured workflow params
submitLabel - label for submitted snapshot
submitDescription - description for submitted snapshot
expirationDates - optional map of for those assets set with an expiration date, or can be null (if no expiration dates)
launchDate - optional launch date
autoDeploy - if true then will auto-deploy on workflow approval

revertAll

@Auditable(parameters="sbStoreId")
void revertAll(java.lang.String sbStoreId)
Revert all changed assets for given sandbox (eg. in user sandbox)

Note: This will revert all new/modified/deleted assets from the sandbox store root directory (eg. /www/avm_webapps) - ie. across all web apps

Parameters:
sbStoreId - sandbox store id

revertWebApp

@Auditable(parameters={"sbStoreId", "webApp"})
void revertWebApp(java.lang.String sbStoreId,
                            java.lang.String webApp)
Revert changed assets for given sandbox and web app (eg. in user sandbox)

Note: This will revert new/modified/deleted assets for the given web app

Parameters:
sbStoreId - sandbox store id
webApp - web app to filter by

revert

@NotAuditable
void revert(java.lang.String sbStoreId,
                         java.lang.String relativePath)
Revert changed asset(s) for given sandbox path (eg. in user sandbox)

Note: This will revert new/modified/deleted asset(s) for given path (either file or directory and below)

Parameters:
sbStoreId - sandbox store id
relativePath - relative path to filter by (eg. /www/avm_webapps/ROOT/MyFolderToRevert)

revertList

@NotAuditable
void revertList(java.lang.String sbStoreId,
                             java.util.List relativePaths)
Revert list of changed assets for given sandbox (eg. in user sandbox)

Parameters:
sbStoreId - sandbox store id
assetPaths - list of assets, as relative paths (eg. /www/avm_webapps/ROOT/MyFolderToRevert)

revertListAssets

@NotAuditable
void revertListAssets(java.lang.String sbStoreId,
                                   java.util.List assets)
Revert list of changed assets for given sandbox (eg. in user sandbox)

Parameters:
assets - list of assets

revertSnapshot

@NotAuditable
void revertSnapshot(java.lang.String sbStoreId,
                                 int version)
Revert sandbox to a specific snapshot version ID (ie. for staging sandbox)

Current user must be a content manager for the web project

Parameters:
sbStoreId - staging sandbox store id
version - version

listSnapshots

@NotAuditable
java.util.List listSnapshots(java.lang.String sbStoreId,
                                          boolean includeSystemGenerated)
List all snapshots (sandbox versions) for the given sandbox (ie. for staging sandbox)

Current user must be a content manager for the web project

Parameters:
sbStoreId - staging sandbox store id
includeSystemGenerated - if false will ignore system generated snapshots else true to get all snapshots
Returns:
List list of sandbox versions

listSnapshots

@NotAuditable
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. for staging sandbox)

Current user must be a content manager for the web project

Parameters:
sbStoreId - staging sandbox store id
from - from date
to - to date
includeSystemGenerated - if false will ignore system generated snapshots else true to get all snapshots
Returns:
List list of sandbox versions


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.