Package org.opencms.gwt
Class CmsVfsService
- java.lang.Object
-
- javax.servlet.GenericServlet
-
- javax.servlet.http.HttpServlet
-
- com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
-
- com.google.gwt.user.server.rpc.RemoteServiceServlet
-
- org.opencms.gwt.CmsGwtService
-
- org.opencms.gwt.CmsVfsService
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.RemoteService
,com.google.gwt.user.server.rpc.SerializationPolicyProvider
,java.io.Serializable
,javax.servlet.Servlet
,javax.servlet.ServletConfig
,I_CmsVfsService
public class CmsVfsService extends CmsGwtService implements I_CmsVfsService
A service class for reading the VFS tree.- Since:
- 8.0.0
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CmsVfsService()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CmsListInfoBean
addLockInfo(CmsObject cms, CmsResource resource, CmsListInfoBean resourceInfo)
Adds the lock state information to the resource info bean.protected static CmsListInfoBean
addPageInfo(CmsObject cms, CmsResource resource, CmsListInfoBean listInfo)
Gets page information of a resource and adds it to the given list info bean.void
createNewExternalLink(java.lang.String title, java.lang.String link, java.lang.String resourceName, java.lang.String parentFolderPath)
Creates a new external link resource.void
createPropertyDefinition(java.lang.String name)
Creates a new property definition.protected CmsBrokenLinkBean
createSitemapBrokenLinkBean(CmsResource resource)
Creates a "broken link" bean based on a resource.void
deleteResource(java.lang.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.static java.lang.String
formatDateTime(CmsObject cms, long date)
Formats a date given the current user's workplace locale.java.util.List<CmsAliasBean>
getAliasesForPage(CmsUUID uuid)
Fetches the aliases for a given page.CmsDeleteResourceBean
getBrokenLinks(java.lang.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.java.util.List<CmsVfsEntryBean>
getChildren(java.lang.String path)
Fetches the list of children of a path.java.lang.String
getDataViewThumbnail(java.lang.String config, java.lang.String id)
Loads a thumbnail for a dataview record.java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>>
getDefaultProperties(java.util.List<CmsUUID> structureIds)
Gets the default property configurations for the given structure ids.java.util.ArrayList<java.lang.String>
getDefinedProperties()
Gets the names of defined properties.java.lang.String
getDetailName(CmsUUID id, java.lang.String localeStr)
Gets the detail name for the given structure id.CmsReplaceInfo
getFileReplaceInfo(CmsUUID structureId)
Returns the file replace info.CmsPreviewInfo
getHistoryPreviewInfo(CmsUUID structureId, java.lang.String locale, CmsHistoryVersion versionBean)
Gets the preview information for a historic version.CmsLockReportInfo
getLockReportInfo(CmsUUID structureId)
Returns the lock report info.static java.lang.String
getNoPreviewReason(CmsObject cms, CmsResource resource)
Returns the no preview reason if there is any.CmsListInfoBean
getPageInfo(java.lang.String vfsPath)
Returns aCmsListInfoBean
for a given resource.static CmsListInfoBean
getPageInfo(CmsObject cms, CmsResource res)
Gets page information of a resource.CmsListInfoBean
getPageInfo(CmsUUID structureId)
Returns aCmsListInfoBean
for a given resource.static CmsListInfoBean
getPageInfoWithLock(CmsObject cms, CmsResource resource)
Returns a bean to display theorg.opencms.gwt.client.ui.CmsListItemWidget
including the lock state.CmsPreviewInfo
getPreviewInfo(java.lang.String sitePath, java.lang.String locale)
Returns the preview info for the given resource.CmsPreviewInfo
getPreviewInfo(CmsUUID structureId, java.lang.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.CmsHistoryResourceCollection
getResourceHistoryInternal(CmsUUID structureId)
Internal version of getResourceHistory.CmsResourceStatusBean
getResourceStatus(CmsUUID structureId, java.lang.String contentLocale, boolean includeTargets, CmsUUID detailContentId, java.util.Map<java.lang.String,java.lang.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.java.util.List<CmsVfsEntryBean>
getRootEntries()
Returns the root entries of the VFS.java.lang.String
getSitePath(CmsUUID structureId)
Returns the site-path for the resource with the given id.CmsUUID
getStructureId(java.lang.String vfsPath)
Gets the structure id for a given site path.CmsListInfoBean
getUploadFolderInfo(java.lang.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.java.util.List<CmsQuickLaunchData>
loadQuickLaunchItems(CmsQuickLaunchParams params)
Loads the items for the quick launch menu.protected CmsVfsEntryBean
makeEntryBean(CmsResource resource, boolean root)
Helper method for creating a VFS entry bean from a resource.protected java.util.List<CmsVfsEntryBean>
makeEntryBeans(java.util.List<CmsResource> resources, boolean root)
Helper method for creating a list of VFS entry beans from a list of the corresponding resources.CmsPrepareEditResponse
prepareEdit(CmsUUID currentPageId, java.lang.String pathWithMacros)
Prepares to edit a file in the XML content editor.static java.lang.String
prepareFileNameForEditor(CmsObject cms, CmsResource res, java.lang.String pathWithMacros)
Processes a file path, which may have macros in it, so it can be opened by the XML content editor.java.lang.String
renameResource(CmsUUID structureId, java.lang.String newName)
Renames a resource.java.lang.String
renameResourceInternal(CmsUUID structureId, java.lang.String newName)
Internal implementation for renaming a resource.void
restoreResource(CmsUUID structureId, int version)
Reverts a resource to a previous historic version.void
saveAliases(CmsUUID structureId, java.util.List<CmsAliasBean> aliasBeans)
Saves aliases for a page.void
saveExternalLink(CmsUUID structureId, java.lang.String title, java.lang.String link, java.lang.String fileName)
Saves the external link.void
saveProperties(CmsPropertyChangeSet changes, boolean updateIndex)
Saves a set of property changes.void
setCms(CmsObject cms)
Sets the current cms context.java.lang.String
substituteLinkForRootPath(java.lang.String currentSiteRoot, java.lang.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.java.util.Map<java.lang.String,java.lang.String>
validateAliases(CmsUUID uuid, java.util.Map<java.lang.String,java.lang.String> aliasPaths)
Validates alias paths for a page.-
Methods inherited from class org.opencms.gwt.CmsGwtService
checkPermissions, clearThreadStorage, doGetSerializationPolicy, doUnexpectedFailure, ensureLock, ensureLock, ensureLock, ensureLock, ensureSession, error, getCmsObject, getPropertiesByName, getRequest, getResponse, isBroadcastCall, log, log, logError, service, setBroadcastPoll, setContext, setRequest, setResponse, tryUnlock
-
Methods inherited from class com.google.gwt.user.server.rpc.RemoteServiceServlet
checkPermutationStrongName, getCodeServerPolicyUrl, getRequestModuleBasePath, getSerializationPolicy, init, loadPolicyFromCodeServer, onAfterResponseSerialized, onBeforeRequestDeserialized, processCall, processCall, processPost, shouldCompressResponse
-
Methods inherited from class com.google.gwt.user.server.rpc.AbstractRemoteServiceServlet
doPost, getPermutationStrongName, getThreadLocalRequest, getThreadLocalResponse, onAfterRequestDeserialized, readContent
-
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doGet, doHead, doOptions, doPut, doTrace, getLastModified, service
-
-
-
-
Constructor Detail
-
CmsVfsService
public CmsVfsService()
-
-
Method Detail
-
addLockInfo
public static CmsListInfoBean addLockInfo(CmsObject cms, CmsResource resource, CmsListInfoBean resourceInfo) throws CmsException
Adds the lock state information to the resource info bean.- Parameters:
cms
- the CMS contextresource
- the resource to get the page info forresourceInfo
- the resource info to add the lock state to- Returns:
- the resource info bean
- Throws:
CmsException
- if something else goes wrong
-
formatDateTime
public static java.lang.String formatDateTime(CmsObject cms, long date)
Formats a date given the current user's workplace locale.- Parameters:
cms
- the current CMS contextdate
- the date to format- Returns:
- the formatted date
-
getNoPreviewReason
public static java.lang.String getNoPreviewReason(CmsObject cms, CmsResource resource)
Returns the no preview reason if there is any.- Parameters:
cms
- the current cms contextresource
- the resource to check- Returns:
- the no preview reason if there is any
-
getPageInfo
public static CmsListInfoBean getPageInfo(CmsObject cms, CmsResource res) throws CmsException
Gets page information of a resource.- Parameters:
cms
- the CMS contextres
- the resource- Returns:
- gets the page information for the given resource
- Throws:
CmsException
- if the resource info can not be read
-
getPageInfoWithLock
public static CmsListInfoBean getPageInfoWithLock(CmsObject cms, CmsResource resource) throws CmsLoaderException, CmsException
Returns a bean to display theorg.opencms.gwt.client.ui.CmsListItemWidget
including the lock state.- Parameters:
cms
- the CMS contextresource
- the resource to get the page info for- Returns:
- a bean to display the
org.opencms.gwt.client.ui.CmsListItemWidget
. - Throws:
CmsLoaderException
- if the resource type could not be foundCmsException
- if something else goes wrong
-
prepareFileNameForEditor
public static java.lang.String prepareFileNameForEditor(CmsObject cms, CmsResource res, java.lang.String pathWithMacros)
Processes a file path, which may have macros in it, so it can be opened by the XML content editor.- Parameters:
cms
- the current CMS contextres
- the resource for which the context menu option has been selectedpathWithMacros
- the file path which may contain macros- Returns:
- the processed file path
-
addPageInfo
protected static CmsListInfoBean addPageInfo(CmsObject cms, CmsResource resource, CmsListInfoBean listInfo) throws CmsException
Gets page information of a resource and adds it to the given list info bean.- Parameters:
cms
- the CMS contextresource
- the resourcelistInfo
- the list info bean to add the information to- Returns:
- the list info bean
- Throws:
CmsException
- if the resource info can not be read
-
createNewExternalLink
public void createNewExternalLink(java.lang.String title, java.lang.String link, java.lang.String resourceName, java.lang.String parentFolderPath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Creates a new external link resource.- Specified by:
createNewExternalLink
in interfaceI_CmsVfsService
- Parameters:
title
- the titlelink
- the linkresourceName
- the name of the link resource to createparentFolderPath
- the parent folder site path- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.createNewExternalLink(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
-
createPropertyDefinition
public void createPropertyDefinition(java.lang.String name) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Creates a new property definition.- Specified by:
createPropertyDefinition
in interfaceI_CmsVfsService
- Parameters:
name
- the name of the property- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.createPropertyDefinition(java.lang.String)
-
deleteResource
public void deleteResource(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Deletes a resource from the VFS.- Specified by:
deleteResource
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to delete- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.deleteResource(org.opencms.util.CmsUUID)
-
deleteResource
public void deleteResource(java.lang.String sitePath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Deletes a resource from the VFS.- Specified by:
deleteResource
in interfaceI_CmsVfsService
- Parameters:
sitePath
- the site path of the resource to delete- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.deleteResource(java.lang.String)
-
forceUnlock
public void forceUnlock(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Forces a resource to be unlocked. In case the given resource is a folder, all sub-resources are also unlocked.- Specified by:
forceUnlock
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to unlock- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.forceUnlock(org.opencms.util.CmsUUID)
-
getAliasesForPage
public java.util.List<CmsAliasBean> getAliasesForPage(CmsUUID uuid) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Fetches the aliases for a given page.- Specified by:
getAliasesForPage
in interfaceI_CmsVfsService
- Parameters:
uuid
- the structure id of the page- Returns:
- the lists of aliases for the page
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getAliasesForPage(org.opencms.util.CmsUUID)
-
getBrokenLinks
public CmsDeleteResourceBean getBrokenLinks(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns a list of potentially broken links, if the given resource was deleted.- Specified by:
getBrokenLinks
in interfaceI_CmsVfsService
- Parameters:
structureId
- the resource structure id- Returns:
- a list of potentially broken links
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getBrokenLinks(org.opencms.util.CmsUUID)
-
getBrokenLinks
public CmsDeleteResourceBean getBrokenLinks(java.lang.String sitePath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns a list of potentially broken links, if the given resource was deleted.- Specified by:
getBrokenLinks
in interfaceI_CmsVfsService
- Parameters:
sitePath
- the resource site-path- Returns:
- a list of potentially broken links
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getBrokenLinks(java.lang.String)
-
getChildren
public java.util.List<CmsVfsEntryBean> getChildren(java.lang.String path) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Fetches the list of children of a path.- Specified by:
getChildren
in interfaceI_CmsVfsService
- 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- See Also:
I_CmsVfsService.getChildren(java.lang.String)
-
getDataViewThumbnail
public java.lang.String getDataViewThumbnail(java.lang.String config, java.lang.String id) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Loads a thumbnail for a dataview record.- Specified by:
getDataViewThumbnail
in interfaceI_CmsVfsService
- Parameters:
config
- the dataview configuration stringid
- the record id- Returns:
- the URL of the thumbnail
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getDataViewThumbnail(java.lang.String, java.lang.String)
-
getDefaultProperties
public java.util.Map<CmsUUID,java.util.Map<java.lang.String,CmsXmlContentProperty>> getDefaultProperties(java.util.List<CmsUUID> structureIds) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the default property configurations for the given structure ids.- Specified by:
getDefaultProperties
in interfaceI_CmsVfsService
- 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- See Also:
I_CmsVfsService.getDefaultProperties(java.util.List)
-
getDefinedProperties
public java.util.ArrayList<java.lang.String> getDefinedProperties() throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the names of defined properties.- Specified by:
getDefinedProperties
in interfaceI_CmsVfsService
- Returns:
- the list of names for all defined properties
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getDefinedProperties()
-
getDetailName
public java.lang.String getDetailName(CmsUUID id, java.lang.String localeStr) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the detail name for the given structure id.- Specified by:
getDetailName
in interfaceI_CmsVfsService
- Parameters:
id
- the structure id of a contentlocaleStr
- the locale to use- Returns:
- the detail name for the structure id
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getDetailName(org.opencms.util.CmsUUID, java.lang.String)
-
getFileReplaceInfo
public CmsReplaceInfo getFileReplaceInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the file replace info.- Specified by:
getFileReplaceInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the file to replace- Returns:
- the file replace info
- Throws:
CmsRpcException
- if the RPC call goes wrong- See Also:
I_CmsVfsService.getFileReplaceInfo(org.opencms.util.CmsUUID)
-
getHistoryPreviewInfo
public CmsPreviewInfo getHistoryPreviewInfo(CmsUUID structureId, java.lang.String locale, CmsHistoryVersion versionBean) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the preview information for a historic version.- Specified by:
getHistoryPreviewInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resourcelocale
- the localeversionBean
- the version number- Returns:
- the preview information for the historic resource version
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getHistoryPreviewInfo(org.opencms.util.CmsUUID, java.lang.String, org.opencms.gwt.shared.CmsHistoryVersion)
-
getLockReportInfo
public CmsLockReportInfo getLockReportInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the lock report info.- Specified by:
getLockReportInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to get the report for- Returns:
- the lock report info
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getLockReportInfo(org.opencms.util.CmsUUID)
-
getPageInfo
public CmsListInfoBean getPageInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns aCmsListInfoBean
for a given resource.- Specified by:
getPageInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id to create theCmsListInfoBean
for- Returns:
- the
CmsListInfoBean
for a given resource - Throws:
CmsRpcException
- if the RPC call goes wrong- See Also:
I_CmsVfsService.getPageInfo(org.opencms.util.CmsUUID)
-
getPageInfo
public CmsListInfoBean getPageInfo(java.lang.String vfsPath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns aCmsListInfoBean
for a given resource.- Specified by:
getPageInfo
in interfaceI_CmsVfsService
- Parameters:
vfsPath
- the vfs path to create theCmsListInfoBean
for- Returns:
- the
CmsListInfoBean
for a given resource - Throws:
CmsRpcException
- if the RPC call goes wrong- See Also:
I_CmsVfsService.getPageInfo(java.lang.String)
-
getPreviewInfo
public CmsPreviewInfo getPreviewInfo(CmsUUID structureId, java.lang.String locale) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the preview info for the given resource.- Specified by:
getPreviewInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the resource structure idlocale
- the requested locale- Returns:
- the preview info
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getPreviewInfo(org.opencms.util.CmsUUID, java.lang.String)
-
getPreviewInfo
public CmsPreviewInfo getPreviewInfo(java.lang.String sitePath, java.lang.String locale) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the preview info for the given resource.- Specified by:
getPreviewInfo
in interfaceI_CmsVfsService
- Parameters:
sitePath
- the resource site pathlocale
- the requested locale- Returns:
- the preview info
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getPreviewInfo(java.lang.String, java.lang.String)
-
getRenameInfo
public CmsRenameInfoBean getRenameInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the information necessary for the rename dialog.- Specified by:
getRenameInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to rename- Returns:
- the information needed for the rename dialog
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getRenameInfo(org.opencms.util.CmsUUID)
-
getResourceHistory
public CmsHistoryResourceCollection getResourceHistory(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the resource history for a given structure id.- Specified by:
getResourceHistory
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of a resource- Returns:
- the history for the given resource
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getResourceHistory(org.opencms.util.CmsUUID)
-
getResourceHistoryInternal
public CmsHistoryResourceCollection getResourceHistoryInternal(CmsUUID structureId) throws CmsException
Internal version of getResourceHistory.- Parameters:
structureId
- the structure id of the resource- Returns:
- the resource history
- Throws:
CmsException
- if something goes wrong
-
getResourceStatus
public CmsResourceStatusBean getResourceStatus(CmsUUID structureId, java.lang.String contentLocale, boolean includeTargets, CmsUUID detailContentId, java.util.Map<java.lang.String,java.lang.String> context) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets a bean containing status information for a given resource.- Specified by:
getResourceStatus
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of a resourcecontentLocale
- the locale for which we want the resource informationincludeTargets
- true if relation targets should also be fetcheddetailContentId
- the structure id of the detail content if presentcontext
- additional context-dependent parameters used for providing additional information- Returns:
- the resource status
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getResourceStatus(org.opencms.util.CmsUUID, java.lang.String, boolean, org.opencms.util.CmsUUID, java.util.Map)
-
getRestoreInfo
public CmsRestoreInfoBean getRestoreInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the information which is necessary for opening the 'Restore' dialog for a resource.- Specified by:
getRestoreInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource- Returns:
- the information for the resource
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getRestoreInfo(org.opencms.util.CmsUUID)
-
getRootEntries
public java.util.List<CmsVfsEntryBean> getRootEntries() throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the root entries of the VFS.- Specified by:
getRootEntries
in interfaceI_CmsVfsService
- Returns:
- a list of root entries
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getRootEntries()
-
getSitePath
public java.lang.String getSitePath(CmsUUID structureId)
Description copied from interface:I_CmsVfsService
Returns the site-path for the resource with the given id.- Specified by:
getSitePath
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id- Returns:
- the site-path or
null
if not available - See Also:
I_CmsVfsService.getSitePath(org.opencms.util.CmsUUID)
-
getStructureId
public CmsUUID getStructureId(java.lang.String vfsPath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the structure id for a given site path.- Specified by:
getStructureId
in interfaceI_CmsVfsService
- Parameters:
vfsPath
- the site path- Returns:
- the structure id
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getStructureId(java.lang.String)
-
getUploadFolderInfo
public CmsListInfoBean getUploadFolderInfo(java.lang.String path) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Gets the resource info to display for an upload folder.- Specified by:
getUploadFolderInfo
in interfaceI_CmsVfsService
- Parameters:
path
- the folder path- Returns:
- the info to display
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.getUploadFolderInfo(java.lang.String)
-
loadLinkInfo
public CmsExternalLinkInfoBean loadLinkInfo(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Loads the external link info.- Specified by:
loadLinkInfo
in interfaceI_CmsVfsService
- Parameters:
structureId
- the external link structure id- Returns:
- the external link info
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.loadLinkInfo(org.opencms.util.CmsUUID)
-
loadPropertyData
public CmsPropertiesBean loadPropertyData(CmsUUID id) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Load the data necessary to edit the properties of a resource.- Specified by:
loadPropertyData
in interfaceI_CmsVfsService
- Parameters:
id
- the structure id of a resource- Returns:
- the property information for that resource
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.loadPropertyData(org.opencms.util.CmsUUID)
-
loadQuickLaunchItems
public java.util.List<CmsQuickLaunchData> loadQuickLaunchItems(CmsQuickLaunchParams params) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Loads the items for the quick launch menu.- Specified by:
loadQuickLaunchItems
in interfaceI_CmsVfsService
- Parameters:
params
- the quick launch parameters- Returns:
- the list of quick launch items
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.loadQuickLaunchItems(org.opencms.gwt.shared.CmsQuickLaunchParams)
-
prepareEdit
public CmsPrepareEditResponse prepareEdit(CmsUUID currentPageId, java.lang.String pathWithMacros) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Prepares to edit a file in the XML content editor.- Specified by:
prepareEdit
in interfaceI_CmsVfsService
- Parameters:
currentPageId
- the current page from which the editor should be openedpathWithMacros
- the file name, which may contain macros- Returns:
- a bean with more information about the file to edit
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.prepareEdit(org.opencms.util.CmsUUID, java.lang.String)
-
renameResource
public java.lang.String renameResource(CmsUUID structureId, java.lang.String newName) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Renames a resource.- Specified by:
renameResource
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to renamenewName
- the new resource name- Returns:
- null or an error message
- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.renameResource(org.opencms.util.CmsUUID, java.lang.String)
-
renameResourceInternal
public java.lang.String renameResourceInternal(CmsUUID structureId, java.lang.String newName) throws CmsException
Internal implementation for renaming a resource.- Parameters:
structureId
- the structure id of the resource to renamenewName
- the new resource name- Returns:
- either null if the rename was successful, or an error message
- Throws:
CmsException
- if something goes wrong
-
restoreResource
public void restoreResource(CmsUUID structureId, int version) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Reverts a resource to a previous historic version.- Specified by:
restoreResource
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to revertversion
- the version to which the resource should be reverted- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.restoreResource(org.opencms.util.CmsUUID, int)
-
saveAliases
public void saveAliases(CmsUUID structureId, java.util.List<CmsAliasBean> aliasBeans) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Saves aliases for a page.- Specified by:
saveAliases
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the pagealiasBeans
- the aliases which should be saved for the page- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.saveAliases(org.opencms.util.CmsUUID, java.util.List)
-
saveExternalLink
public void saveExternalLink(CmsUUID structureId, java.lang.String title, java.lang.String link, java.lang.String fileName) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Saves the external link.- Specified by:
saveExternalLink
in interfaceI_CmsVfsService
- Parameters:
structureId
- the link structure idtitle
- the link titlelink
- the linkfileName
- the file name- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.saveExternalLink(org.opencms.util.CmsUUID, java.lang.String, java.lang.String, java.lang.String)
-
saveProperties
public void saveProperties(CmsPropertyChangeSet changes, boolean updateIndex) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Saves a set of property changes.- Specified by:
saveProperties
in interfaceI_CmsVfsService
- Parameters:
changes
- a set of property changesupdateIndex
- true if the index should be updated after saving the property changes- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.saveProperties(org.opencms.gwt.shared.property.CmsPropertyChangeSet, boolean)
-
setCms
public void setCms(CmsObject cms)
Sets the current cms context.- Overrides:
setCms
in classCmsGwtService
- Parameters:
cms
- the current cms context to set
-
substituteLinkForRootPath
public java.lang.String substituteLinkForRootPath(java.lang.String currentSiteRoot, java.lang.String rootPath) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Returns the absolute link to the given root path.- Specified by:
substituteLinkForRootPath
in interfaceI_CmsVfsService
- Parameters:
currentSiteRoot
- the current siterootPath
- the root path- Returns:
- the absolute link
- Throws:
CmsRpcException
- if something goes wrong processing the request- See Also:
I_CmsVfsService.substituteLinkForRootPath(java.lang.String, java.lang.String)
-
syncDeleteResource
public void syncDeleteResource(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Deletes a resource from the VFS.- Specified by:
syncDeleteResource
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to delete- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.syncDeleteResource(org.opencms.util.CmsUUID)
-
undelete
public void undelete(CmsUUID structureId) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Undeletes a resource.- Specified by:
undelete
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to undelete- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.undelete(org.opencms.util.CmsUUID)
-
undoChanges
public void undoChanges(CmsUUID structureId, boolean undoMove) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Undoes the changes to a given resource, i.e. restores its online content to its offline version.- Specified by:
undoChanges
in interfaceI_CmsVfsService
- Parameters:
structureId
- the structure id of the resource to undoundoMove
- true if move operations should be undone- Throws:
CmsRpcException
- if something goes wrong- See Also:
I_CmsVfsService.undoChanges(org.opencms.util.CmsUUID, boolean)
-
validateAliases
public java.util.Map<java.lang.String,java.lang.String> validateAliases(CmsUUID uuid, java.util.Map<java.lang.String,java.lang.String> aliasPaths) throws CmsRpcException
Description copied from interface:I_CmsVfsService
Validates alias paths for a page.- Specified by:
validateAliases
in interfaceI_CmsVfsService
- Parameters:
uuid
- the structure id of the pagealiasPaths
- 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- See Also:
I_CmsVfsService.validateAliases(org.opencms.util.CmsUUID, java.util.Map)
-
createSitemapBrokenLinkBean
protected CmsBrokenLinkBean createSitemapBrokenLinkBean(CmsResource resource) throws CmsException
Creates a "broken link" bean based on a resource.- Parameters:
resource
- the resource- Returns:
- the "broken link" bean with the data from the resource
- Throws:
CmsException
- if something goes wrong
-
makeEntryBean
protected CmsVfsEntryBean makeEntryBean(CmsResource resource, boolean root) throws CmsException
Helper method for creating a VFS entry bean from a resource.- Parameters:
resource
- the resource whose data should be stored in the beanroot
- true if the resource is a root resource- Returns:
- the data bean representing the resource
- Throws:
CmsException
- if something goes wrong
-
makeEntryBeans
protected java.util.List<CmsVfsEntryBean> makeEntryBeans(java.util.List<CmsResource> resources, boolean root) throws CmsException
Helper method for creating a list of VFS entry beans from a list of the corresponding resources.- Parameters:
resources
- the list of resources which should be converted to entry beansroot
- true if the resources in the list are root resources- Returns:
- the list of VFS entry beans for the resources
- Throws:
CmsException
- if something goes wrong
-
-