org.alfresco.wcm.asset
Interface AssetService

All Known Implementing Classes:
AssetServiceImpl

public interface AssetService

Asset Service fundamental API.

This service API is designed to support the public facing Asset APIs.


Method Summary
 void addAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName, java.util.Map properties)
          Apply aspect to asset, with given properties (can be null)
 void bulkImport(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.io.File zipFile, boolean isHighByteZip)
          Bulk import assets into sandbox
 AssetInfo copyAsset(AssetInfo asset, java.lang.String parentFolderPath)
          Copy asset(s) within sandbox
 org.alfresco.service.cmr.repository.ContentWriter createFile(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.lang.String name, java.util.Map properties)
          Create (empty) file within given sandbox, return content writer for file contents
 org.alfresco.service.cmr.repository.ContentWriter createFileWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPath, java.lang.String name)
          Create (empty) file within given sandbox and webApp, return content writer for file contents
 void createFolder(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.lang.String name, java.util.Map properties)
          Create folder within given sandbox
 void createFolderWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPathRelativeToWebApp, java.lang.String name)
          Create folder within given sandbox and webApp
 void deleteAsset(AssetInfo asset)
          Delete asset
 java.util.Set getAspects(AssetInfo asset)
          Get set of aspects applied to asset
 AssetInfo getAsset(java.lang.String sbStoreId, int version, java.lang.String path, boolean includeDeleted)
          Get asset (file or folder) for given sandbox version and path, optionally include deleted assets
 AssetInfo getAsset(java.lang.String sbStoreId, java.lang.String path)
          Get asset (file or folder) for given sandbox and path
 java.util.Map getAssetProperties(AssetInfo asset)
          Get asset properties
 AssetInfo getAssetWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String pathRelativeToWebApp)
          Get asset (file or folder) for given sandbox, webApp and path (within webApp)
 AssetInfo getAssetWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String pathRelativeToWebApp, boolean includeDeleted)
          Get asset (file or folder) for given sandbox, webApp and path (within webApp), optionally include deleted assets
 org.alfresco.service.cmr.repository.ContentReader getContentReader(AssetInfo fileAsset)
          Get content reader for given file asset, to allow file contents to be read
 org.alfresco.service.cmr.repository.ContentWriter getContentWriter(AssetInfo fileAsset)
          Get content writer for given file asset, to allow file contents to be written or updated
 java.lang.String getLockOwner(AssetInfo fileAsset)
          Runtime check to get lock (and owner) for asset - null if not locked
 boolean hasAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName)
          True, if asset has given aspect applied
 boolean hasLockAccess(AssetInfo fileAsset)
          Runtime check to check if the current user can perform (write) operations on the asset when locked
 java.util.List listAssets(java.lang.String sbStoreId, int version, java.lang.String parentFolderPath, boolean includeDeleted)
          List assets within given sandbox version and path, optionally include deleted
 java.util.List listAssets(java.lang.String sbStoreId, java.lang.String parentFolderPath, boolean includeDeleted)
          List assets within given sandbox and path, optionally include deleted
 java.util.List listAssetsWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPathRelativeToWebApp, boolean includeDeleted)
          List assets within given sandbox and webApp and path (within webApp), optionally include deleted
 AssetInfo moveAsset(AssetInfo asset, java.lang.String parentFolderPath)
          Move asset within sandbox
 void removeAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName)
          Remove aspect from asset, and any related properties
 AssetInfo renameAsset(AssetInfo asset, java.lang.String newName)
          Rename asset
 void setAssetProperties(AssetInfo asset, java.util.Map properties)
          Set asset properties (will replace all existing properties)
 void updateAssetProperties(AssetInfo asset, java.util.Map properties)
          Update asset properties (will replace given set of properties, if they already exist)
 

Method Detail

createFolderWebApp

@NotAuditable
void createFolderWebApp(java.lang.String sbStoreId,
                                     java.lang.String webApp,
                                     java.lang.String parentFolderPathRelativeToWebApp,
                                     java.lang.String name)
Create folder within given sandbox and webApp


createFolder

@NotAuditable
void createFolder(java.lang.String sbStoreId,
                               java.lang.String parentFolderPath,
                               java.lang.String name,
                               java.util.Map properties)
Create folder within given sandbox


createFileWebApp

@NotAuditable
org.alfresco.service.cmr.repository.ContentWriter createFileWebApp(java.lang.String sbStoreId,
                                                                                java.lang.String webApp,
                                                                                java.lang.String parentFolderPath,
                                                                                java.lang.String name)
Create (empty) file within given sandbox and webApp, return content writer for file contents


createFile

@NotAuditable
org.alfresco.service.cmr.repository.ContentWriter createFile(java.lang.String sbStoreId,
                                                                          java.lang.String parentFolderPath,
                                                                          java.lang.String name,
                                                                          java.util.Map properties)
Create (empty) file within given sandbox, return content writer for file contents


getAssetWebApp

@NotAuditable
AssetInfo getAssetWebApp(java.lang.String sbStoreId,
                                      java.lang.String webApp,
                                      java.lang.String pathRelativeToWebApp)
Get asset (file or folder) for given sandbox, webApp and path (within webApp)

Returns null if the asset can not be found


getAssetWebApp

@NotAuditable
AssetInfo getAssetWebApp(java.lang.String sbStoreId,
                                      java.lang.String webApp,
                                      java.lang.String pathRelativeToWebApp,
                                      boolean includeDeleted)
Get asset (file or folder) for given sandbox, webApp and path (within webApp), optionally include deleted assets

Returns null if the asset can not be found


getAsset

@NotAuditable
AssetInfo getAsset(java.lang.String sbStoreId,
                                java.lang.String path)
Get asset (file or folder) for given sandbox and path

Returns null if the asset can not be found

Parameters:
sbStoreId - sandbox store id
path - asset path (eg. /www/avm_webapps/ROOT/myFile)
Returns:
AssetInfo asset info

getAsset

@NotAuditable
AssetInfo getAsset(java.lang.String sbStoreId,
                                int version,
                                java.lang.String path,
                                boolean includeDeleted)
Get asset (file or folder) for given sandbox version and path, optionally include deleted assets

Returns null if the asset can not be found


getContentWriter

@NotAuditable
org.alfresco.service.cmr.repository.ContentWriter getContentWriter(AssetInfo fileAsset)
Get content writer for given file asset, to allow file contents to be written or updated


getContentReader

@NotAuditable
org.alfresco.service.cmr.repository.ContentReader getContentReader(AssetInfo fileAsset)
Get content reader for given file asset, to allow file contents to be read


getAssetProperties

@NotAuditable
java.util.Map getAssetProperties(AssetInfo asset)
Get asset properties


setAssetProperties

@NotAuditable
void setAssetProperties(AssetInfo asset,
                                     java.util.Map properties)
Set asset properties (will replace all existing properties)


updateAssetProperties

@NotAuditable
void updateAssetProperties(AssetInfo asset,
                                        java.util.Map properties)
Update asset properties (will replace given set of properties, if they already exist)


addAspect

@NotAuditable
void addAspect(AssetInfo asset,
                            org.alfresco.service.namespace.QName aspectName,
                            java.util.Map properties)
Apply aspect to asset, with given properties (can be null)


removeAspect

@NotAuditable
void removeAspect(AssetInfo asset,
                               org.alfresco.service.namespace.QName aspectName)
Remove aspect from asset, and any related properties


getAspects

@NotAuditable
java.util.Set getAspects(AssetInfo asset)
Get set of aspects applied to asset


hasAspect

@NotAuditable
boolean hasAspect(AssetInfo asset,
                               org.alfresco.service.namespace.QName aspectName)
True, if asset has given aspect applied


listAssetsWebApp

@NotAuditable
java.util.List listAssetsWebApp(java.lang.String sbStoreId,
                                             java.lang.String webApp,
                                             java.lang.String parentFolderPathRelativeToWebApp,
                                             boolean includeDeleted)
List assets within given sandbox and webApp and path (within webApp), optionally include deleted


listAssets

@NotAuditable
java.util.List listAssets(java.lang.String sbStoreId,
                                       java.lang.String parentFolderPath,
                                       boolean includeDeleted)
List assets within given sandbox and path, optionally include deleted


listAssets

@NotAuditable
java.util.List listAssets(java.lang.String sbStoreId,
                                       int version,
                                       java.lang.String parentFolderPath,
                                       boolean includeDeleted)
List assets within given sandbox version and path, optionally include deleted


deleteAsset

@NotAuditable
void deleteAsset(AssetInfo asset)
Delete asset


renameAsset

@NotAuditable
AssetInfo renameAsset(AssetInfo asset,
                                   java.lang.String newName)
Rename asset


copyAsset

@NotAuditable
AssetInfo copyAsset(AssetInfo asset,
                                 java.lang.String parentFolderPath)
Copy asset(s) within sandbox

Note: folder asset will be recursively copied Note: file asset(s) must have content


moveAsset

@NotAuditable
AssetInfo moveAsset(AssetInfo asset,
                                 java.lang.String parentFolderPath)
Move asset within sandbox


bulkImport

@NotAuditable
void bulkImport(java.lang.String sbStoreId,
                             java.lang.String parentFolderPath,
                             java.io.File zipFile,
                             boolean isHighByteZip)
Bulk import assets into sandbox


getLockOwner

@NotAuditable
java.lang.String getLockOwner(AssetInfo fileAsset)
Runtime check to get lock (and owner) for asset - null if not locked

Returns:
String lock owner (null if path not locked)

hasLockAccess

@NotAuditable
boolean hasLockAccess(AssetInfo fileAsset)
Runtime check to check if the current user can perform (write) operations on the asset when locked

Returns:
boolean true if current user has write access


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