Package org.opencms.gwt.shared.rpc

Interface I_CmsVfsService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

CmsVfsService

public interface I_CmsVfsService
extends com.google.gwt.user.client.rpc.RemoteService

A service interface for retrieving information about the VFS tree.

Since:

8.0.0

Method Summary

Modifier and Type	Method	Description
void	createNewExternalLink(String title, String link, String resourceName, String parentFolderPath)	Creates a new external link resource.
void	createPropertyDefinition(String propDef)	Creates a new property definition.
void	deleteResource(String sitePath)	Deletes a resource from the VFS.
void	deleteResource(CmsUUID structureId)	Deletes a resource from the VFS.
void	forceUnlock(CmsUUID structureId)	Forces a resource to be unlocked.
List<CmsAliasBean>	getAliasesForPage(CmsUUID uuid)	Fetches the aliases for a given page.
CmsDeleteResourceBean	getBrokenLinks(String sitePath)	Returns a list of potentially broken links, if the given resource was deleted.
CmsDeleteResourceBean	getBrokenLinks(CmsUUID structureId)	Returns a list of potentially broken links, if the given resource was deleted.
List<CmsVfsEntryBean>	getChildren(String path)	Fetches the list of children of a path.
String	getDataViewThumbnail(String config, String id)	Loads a thumbnail for a dataview record.
Map<CmsUUID,Map<String,CmsXmlContentProperty>>	getDefaultProperties(List<CmsUUID> structureIds)	Gets the default property configurations for the given structure ids.
ArrayList<String>	getDefinedProperties()	Gets the names of defined properties.
String	getDetailName(CmsUUID id, String locale)	Gets the detail name for the given structure id.
CmsReplaceInfo	getFileReplaceInfo(CmsUUID structureId)	Returns the file replace info.
CmsPreviewInfo	getHistoryPreviewInfo(CmsUUID structureId, String locale, CmsHistoryVersion version)	Gets the preview information for a historic version.
CmsLockReportInfo	getLockReportInfo(CmsUUID structureId)	Returns the lock report info.
CmsListInfoBean	getPageInfo(String vfsPath)	Returns a CmsListInfoBean for a given resource.
CmsListInfoBean	getPageInfo(CmsUUID structureId)	Returns a CmsListInfoBean for a given resource.
CmsPreviewInfo	getPreviewInfo(String sitePath, String locale)	Returns the preview info for the given resource.
CmsPreviewInfo	getPreviewInfo(CmsUUID structureId, String locale)	Returns the preview info for the given resource.
CmsRenameInfoBean	getRenameInfo(CmsUUID structureId)	Gets the information necessary for the rename dialog.
CmsHistoryResourceCollection	getResourceHistory(CmsUUID structureId)	Gets the resource history for a given structure id.
CmsResourceStatusBean	getResourceStatus(CmsUUID structureId, String locale, boolean includeTargets, CmsUUID detailContentId, Map<String,String> context)	Gets a bean containing status information for a given resource.
CmsRestoreInfoBean	getRestoreInfo(CmsUUID structureId)	Gets the information which is necessary for opening the 'Restore' dialog for a resource.
List<CmsVfsEntryBean>	getRootEntries()	Returns the root entries of the VFS.
String	getSitePath(CmsUUID structureId)	Returns the site-path for the resource with the given id.
List<String>	getSitePaths(List<CmsUUID> ids)	Gets the site paths corresponding to a list of structure ids.
CmsUUID	getStructureId(String vfsPath)	Gets the structure id for a given site path.
CmsListInfoBean	getUploadFolderInfo(String path)	Gets the resource info to display for an upload folder.
CmsExternalLinkInfoBean	loadLinkInfo(CmsUUID structureId)	Loads the external link info.
CmsPropertiesBean	loadPropertyData(CmsUUID id)	Load the data necessary to edit the properties of a resource.
List<CmsQuickLaunchData>	loadQuickLaunchItems(CmsQuickLaunchParams params)	Loads the items for the quick launch menu.
CmsPrepareEditResponse	prepareEdit(CmsUUID currentPage, String fileNameWithMacros)	Prepares to edit a file in the XML content editor.
String	renameResource(CmsUUID structureId, String newName)	Renames a resource.
void	restoreResource(CmsUUID structureId, int version)	Reverts a resource to a previous historic version.
void	saveAliases(CmsUUID structureId, List<CmsAliasBean> aliases)	Saves aliases for a page.
void	saveExternalLink(CmsUUID structureId, String title, String link, String fileName)	Saves the external link.
void	saveProperties(CmsPropertyChangeSet changes, boolean updateIndex)	Saves a set of property changes.
String	substituteLinkForRootPath(String currentSiteRoot, String rootPath)	Returns the absolute link to the given root path.
void	syncDeleteResource(CmsUUID structureId)	Deletes a resource from the VFS.
void	undelete(CmsUUID structureId)	Undeletes a resource.
void	undoChanges(CmsUUID structureId, boolean undoMove)	Undoes the changes to a given resource, i.e.
Map<String,String>	validateAliases(CmsUUID uuid, Map<String,String> aliasPaths)	Validates alias paths for a page.

Method Details

createNewExternalLink

void createNewExternalLink(String title,
 String link,
 String resourceName,
 String parentFolderPath)
                    throws CmsRpcException

Creates a new external link resource.

Parameters:

title - the title

link - the link

resourceName - the name of the link resource to create

parentFolderPath - the parent folder site path

Throws:

CmsRpcException - if something goes wrong

createPropertyDefinition

void createPropertyDefinition(String propDef)
                       throws CmsRpcException

Creates a new property definition.

Parameters:

propDef - the name of the property

Throws:

CmsRpcException - if something goes wrong

deleteResource

void deleteResource(CmsUUID structureId)
             throws CmsRpcException

Deletes a resource from the VFS.

Parameters:

structureId - the structure id of the resource to delete

Throws:

CmsRpcException - if something goes wrong

deleteResource

void deleteResource(String sitePath)
             throws CmsRpcException

Deletes a resource from the VFS.

Parameters:

sitePath - the site path of the resource to delete

Throws:

CmsRpcException - if something goes wrong

forceUnlock

void forceUnlock(CmsUUID structureId)
          throws CmsRpcException

Forces a resource to be unlocked. In case the given resource is a folder, all sub-resources are also unlocked.

Parameters:

structureId - the structure id of the resource to unlock

Throws:

CmsRpcException - if something goes wrong

getAliasesForPage

List<CmsAliasBean> getAliasesForPage(CmsUUID uuid)
                              throws CmsRpcException

Fetches the aliases for a given page.

Parameters:

uuid - the structure id of the page

Returns:

the lists of aliases for the page

Throws:

CmsRpcException - if something goes wrong

getBrokenLinks

CmsDeleteResourceBean getBrokenLinks(CmsUUID structureId)
                              throws CmsRpcException

Returns a list of potentially broken links, if the given resource was deleted.

Parameters:

structureId - the resource structure id

Returns:

a list of potentially broken links

Throws:

CmsRpcException - if something goes wrong

getBrokenLinks

CmsDeleteResourceBean getBrokenLinks(String sitePath)
                              throws CmsRpcException

Returns a list of potentially broken links, if the given resource was deleted.

Parameters:

sitePath - the resource site-path

Returns:

a list of potentially broken links

Throws:

CmsRpcException - if something goes wrong

getChildren

List<CmsVfsEntryBean> getChildren(String path)
                           throws CmsRpcException

Fetches the list of children of a path.

Parameters:

path - the path for which the list of children should be retrieved

Returns:

the children of the path

Throws:

CmsRpcException - if something goes wrong

getDataViewThumbnail

String getDataViewThumbnail(String config,
 String id)
                     throws CmsRpcException

Loads a thumbnail for a dataview record.

Parameters:

config - the dataview configuration string

id - the record id

Returns:

the URL of the thumbnail

Throws:

CmsRpcException - if something goes wrong

getDefaultProperties

Map<CmsUUID,Map<String,CmsXmlContentProperty>> getDefaultProperties(List<CmsUUID> structureIds)
                                                             throws CmsRpcException

Gets the default property configurations for the given structure ids.

Parameters:

structureIds - the structure ids for which the property configurations should be fetched

Returns:

a map from the given structure ids to their default property configurations

Throws:

CmsRpcException - if something goes wrong

getDefinedProperties

ArrayList<String> getDefinedProperties()
                                throws CmsRpcException

Gets the names of defined properties.

Returns:

the list of names for all defined properties

Throws:

CmsRpcException - if something goes wrong

getDetailName

String getDetailName(CmsUUID id,
 String locale)
              throws CmsRpcException

Gets the detail name for the given structure id.

Parameters:

id - the structure id of a content

locale - the locale to use

Returns:

the detail name for the structure id

Throws:

CmsRpcException - if something goes wrong

getFileReplaceInfo

CmsReplaceInfo getFileReplaceInfo(CmsUUID structureId)
                           throws CmsRpcException

Returns the file replace info.

Parameters:

structureId - the structure id of the file to replace

Returns:

the file replace info

Throws:

CmsRpcException - if the RPC call goes wrong

getHistoryPreviewInfo

CmsPreviewInfo getHistoryPreviewInfo(CmsUUID structureId,
 String locale,
 CmsHistoryVersion version)
                              throws CmsRpcException

Gets the preview information for a historic version.

Parameters:

structureId - the structure id of the resource

locale - the locale

version - the version number

Returns:

the preview information for the historic resource version

Throws:

CmsRpcException - if something goes wrong

getLockReportInfo

CmsLockReportInfo getLockReportInfo(CmsUUID structureId)
                             throws CmsRpcException

Returns the lock report info.

Parameters:

structureId - the structure id of the resource to get the report for

Returns:

the lock report info

Throws:

CmsRpcException - if something goes wrong

getPageInfo

CmsListInfoBean getPageInfo(CmsUUID structureId)
                     throws CmsRpcException

Returns a CmsListInfoBean for a given resource.

Parameters:

structureId - the structure id to create the CmsListInfoBean for

Returns:

the CmsListInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getPageInfo

CmsListInfoBean getPageInfo(String vfsPath)
                     throws CmsRpcException

Returns a CmsListInfoBean for a given resource.

Parameters:

vfsPath - the vfs path to create the CmsListInfoBean for

Returns:

the CmsListInfoBean for a given resource

Throws:

CmsRpcException - if the RPC call goes wrong

getPreviewInfo

CmsPreviewInfo getPreviewInfo(CmsUUID structureId,
 String locale)
                       throws CmsRpcException

Returns the preview info for the given resource.

Parameters:

structureId - the resource structure id

locale - the requested locale

Returns:

the preview info

Throws:

CmsRpcException - if something goes wrong

getPreviewInfo

CmsPreviewInfo getPreviewInfo(String sitePath,
 String locale)
                       throws CmsRpcException

Returns the preview info for the given resource.

Parameters:

sitePath - the resource site path

locale - the requested locale

Returns:

the preview info

Throws:

CmsRpcException - if something goes wrong

getRenameInfo

CmsRenameInfoBean getRenameInfo(CmsUUID structureId)
                         throws CmsRpcException

Gets the information necessary for the rename dialog.

Parameters:

structureId - the structure id of the resource to rename

Returns:

the information needed for the rename dialog

Throws:

CmsRpcException - if something goes wrong

getResourceHistory

CmsHistoryResourceCollection getResourceHistory(CmsUUID structureId)
                                         throws CmsRpcException

Gets the resource history for a given structure id.

Parameters:

structureId - the structure id of a resource

Returns:

the history for the given resource

Throws:

CmsRpcException - if something goes wrong

getResourceStatus

CmsResourceStatusBean getResourceStatus(CmsUUID structureId,
 String locale,
 boolean includeTargets,
 CmsUUID detailContentId,
 Map<String,String> context)
                                 throws CmsRpcException

Gets a bean containing status information for a given resource.

Parameters:

structureId - the structure id of a resource

locale - the locale for which we want the resource information

includeTargets - true if relation targets should also be fetched

detailContentId - the structure id of the detail content if present

context - additional context-dependent parameters used for providing additional information

Returns:

the resource status

Throws:

CmsRpcException - if something goes wrong

getRestoreInfo

CmsRestoreInfoBean getRestoreInfo(CmsUUID structureId)
                           throws CmsRpcException

Gets the information which is necessary for opening the 'Restore' dialog for a resource.

Parameters:

structureId - the structure id of the resource

Returns:

the information for the resource

Throws:

CmsRpcException - if something goes wrong

getRootEntries

List<CmsVfsEntryBean> getRootEntries()
                              throws CmsRpcException

Returns the root entries of the VFS.

Returns:

a list of root entries

Throws:

CmsRpcException - if something goes wrong

getSitePath

String getSitePath(CmsUUID structureId)
            throws CmsRpcException

Returns the site-path for the resource with the given id.

Parameters:

structureId - the structure id

Returns:

the site-path or null if not available

Throws:

CmsRpcException - if something goes wrong

getSitePaths

List<String> getSitePaths(List<CmsUUID> ids)
                   throws CmsRpcException

Gets the site paths corresponding to a list of structure ids.

If for any of the structure ids in the input list the corresponding resource can not be read, it will be skipped.

Parameters:

ids - a list of structure ids

Returns:

the list of paths corresponding to the structure ids

Throws:

CmsRpcException

getStructureId

CmsUUID getStructureId(String vfsPath)
                throws CmsRpcException

Gets the structure id for a given site path.

Parameters:

vfsPath - the site path

Returns:

the structure id

Throws:

CmsRpcException - if something goes wrong

getUploadFolderInfo

CmsListInfoBean getUploadFolderInfo(String path)
                             throws CmsRpcException

Gets the resource info to display for an upload folder.

Parameters:

path - the folder path

Returns:

the info to display

Throws:

CmsRpcException - if something goes wrong

loadLinkInfo

CmsExternalLinkInfoBean loadLinkInfo(CmsUUID structureId)
                              throws CmsRpcException

Loads the external link info.

Parameters:

structureId - the external link structure id

Returns:

the external link info

Throws:

CmsRpcException - if something goes wrong

loadPropertyData

CmsPropertiesBean loadPropertyData(CmsUUID id)
                            throws CmsRpcException

Load the data necessary to edit the properties of a resource.

Parameters:

id - the structure id of a resource

Returns:

the property information for that resource

Throws:

CmsRpcException - if something goes wrong

loadQuickLaunchItems

List<CmsQuickLaunchData> loadQuickLaunchItems(CmsQuickLaunchParams params)
                                       throws CmsRpcException

Loads the items for the quick launch menu.

Parameters:

params - the quick launch parameters

Returns:

the list of quick launch items

Throws:

CmsRpcException - if something goes wrong

prepareEdit

CmsPrepareEditResponse prepareEdit(CmsUUID currentPage,
 String fileNameWithMacros)
                            throws CmsRpcException

Prepares to edit a file in the XML content editor.

Parameters:

currentPage - the current page from which the editor should be opened

fileNameWithMacros - the file name, which may contain macros

Returns:

a bean with more information about the file to edit

Throws:

CmsRpcException - if something goes wrong

renameResource

String renameResource(CmsUUID structureId,
 String newName)
               throws CmsRpcException

Renames a resource.

Parameters:

structureId - the structure id of the resource to rename

newName - the new resource name

Returns:

null or an error message

Throws:

CmsRpcException - if something goes wrong

restoreResource

void restoreResource(CmsUUID structureId,
 int version)
              throws CmsRpcException

Reverts a resource to a previous historic version.

Parameters:

structureId - the structure id of the resource to revert

version - the version to which the resource should be reverted

Throws:

CmsRpcException - if something goes wrong

saveAliases

void saveAliases(CmsUUID structureId,
 List<CmsAliasBean> aliases)
          throws CmsRpcException

Saves aliases for a page.

Parameters:

structureId - the structure id of the page

aliases - the aliases which should be saved for the page

Throws:

CmsRpcException - if something goes wrong

saveExternalLink

void saveExternalLink(CmsUUID structureId,
 String title,
 String link,
 String fileName)
               throws CmsRpcException

Saves the external link.

Parameters:

structureId - the link structure id

title - the link title

link - the link

fileName - the file name

Throws:

CmsRpcException - if something goes wrong

saveProperties

void saveProperties(CmsPropertyChangeSet changes,
 boolean updateIndex)
             throws CmsRpcException

Saves a set of property changes.

Parameters:

changes - a set of property changes

updateIndex - true if the index should be updated after saving the property changes

Throws:

CmsRpcException - if something goes wrong

substituteLinkForRootPath

String substituteLinkForRootPath(String currentSiteRoot,
 String rootPath)
                          throws CmsRpcException

Returns the absolute link to the given root path.

Parameters:

currentSiteRoot - the current site

rootPath - the root path

Returns:

the absolute link

Throws:

CmsRpcException - if something goes wrong processing the request

syncDeleteResource

void syncDeleteResource(CmsUUID structureId)
                 throws CmsRpcException

Deletes a resource from the VFS.

Parameters:

structureId - the structure id of the resource to delete

Throws:

CmsRpcException - if something goes wrong

undelete

void undelete(CmsUUID structureId)
       throws CmsRpcException

Undeletes a resource.

Parameters:

structureId - the structure id of the resource to undelete

Throws:

CmsRpcException - if something goes wrong

undoChanges

void undoChanges(CmsUUID structureId,
 boolean undoMove)
          throws CmsRpcException

Undoes the changes to a given resource, i.e. restores its online content to its offline version.

Parameters:

structureId - the structure id of the resource to undo

undoMove - true if move operations should be undone

Throws:

CmsRpcException - if something goes wrong

validateAliases

Map<String,String> validateAliases(CmsUUID uuid,
 Map<String,String> aliasPaths)
                            throws CmsRpcException

Validates alias paths for a page.

Parameters:

uuid - the structure id of the page

aliasPaths - a map from (arbitrary) id strings to alias paths

Returns:

a map which maps the same id strings to validation results

Throws:

CmsRpcException - if something goes wrong