|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
@NotAuditable void createFolderWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPathRelativeToWebApp, java.lang.String name)
@NotAuditable void createFolder(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.lang.String name, java.util.Map properties)
@NotAuditable org.alfresco.service.cmr.repository.ContentWriter createFileWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPath, java.lang.String name)
@NotAuditable org.alfresco.service.cmr.repository.ContentWriter createFile(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.lang.String name, java.util.Map properties)
@NotAuditable AssetInfo getAssetWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String pathRelativeToWebApp)
Returns null if the asset can not be found
@NotAuditable AssetInfo getAssetWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String pathRelativeToWebApp, boolean includeDeleted)
Returns null if the asset can not be found
@NotAuditable AssetInfo getAsset(java.lang.String sbStoreId, java.lang.String path)
Returns null if the asset can not be found
sbStoreId
- sandbox store idpath
- asset path (eg. /www/avm_webapps/ROOT/myFile)
@NotAuditable AssetInfo getAsset(java.lang.String sbStoreId, int version, java.lang.String path, boolean includeDeleted)
Returns null if the asset can not be found
@NotAuditable org.alfresco.service.cmr.repository.ContentWriter getContentWriter(AssetInfo fileAsset)
@NotAuditable org.alfresco.service.cmr.repository.ContentReader getContentReader(AssetInfo fileAsset)
@NotAuditable java.util.Map getAssetProperties(AssetInfo asset)
@NotAuditable void setAssetProperties(AssetInfo asset, java.util.Map properties)
@NotAuditable void updateAssetProperties(AssetInfo asset, java.util.Map properties)
@NotAuditable void addAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName, java.util.Map properties)
@NotAuditable void removeAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName)
@NotAuditable java.util.Set getAspects(AssetInfo asset)
@NotAuditable boolean hasAspect(AssetInfo asset, org.alfresco.service.namespace.QName aspectName)
@NotAuditable java.util.List listAssetsWebApp(java.lang.String sbStoreId, java.lang.String webApp, java.lang.String parentFolderPathRelativeToWebApp, boolean includeDeleted)
@NotAuditable java.util.List listAssets(java.lang.String sbStoreId, java.lang.String parentFolderPath, boolean includeDeleted)
@NotAuditable java.util.List listAssets(java.lang.String sbStoreId, int version, java.lang.String parentFolderPath, boolean includeDeleted)
@NotAuditable void deleteAsset(AssetInfo asset)
@NotAuditable AssetInfo renameAsset(AssetInfo asset, java.lang.String newName)
@NotAuditable AssetInfo copyAsset(AssetInfo asset, java.lang.String parentFolderPath)
Note: folder asset will be recursively copied Note: file asset(s) must have content
@NotAuditable AssetInfo moveAsset(AssetInfo asset, java.lang.String parentFolderPath)
@NotAuditable void bulkImport(java.lang.String sbStoreId, java.lang.String parentFolderPath, java.io.File zipFile, boolean isHighByteZip)
@NotAuditable java.lang.String getLockOwner(AssetInfo fileAsset)
@NotAuditable boolean hasLockAccess(AssetInfo fileAsset)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |