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 Detail

      • createNewExternalLink

        void createNewExternalLink​(java.lang.String title,
                           java.lang.String link,
                           java.lang.String resourceName,
                           java.lang.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

      • deleteResource

        void deleteResource​(java.lang.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

      • getBrokenLinks

        CmsDeleteResourceBean getBrokenLinks​(java.lang.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

        java.util.List<CmsVfsEntryBean> getChildren​(java.lang.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

        java.lang.String getDataViewThumbnail​(java.lang.String config,
                                      java.lang.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

        java.util.Map<CmsUUID,​java.util.Map<java.lang.String,​CmsXmlContentProperty>> getDefaultProperties​(java.util.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

      • getDetailName

        java.lang.String getDetailName​(CmsUUID id,
                               java.lang.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

      • getPreviewInfo

        CmsPreviewInfo getPreviewInfo​(CmsUUID structureId,
                              java.lang.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​(java.lang.String sitePath,
                              java.lang.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

      • getResourceStatus

        CmsResourceStatusBean getResourceStatus​(CmsUUID structureId,
                                        java.lang.String locale,
                                        boolean includeTargets,
                                        CmsUUID detailContentId,
                                        java.util.Map<java.lang.String,​java.lang.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

      • getSitePath

        java.lang.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

      • prepareEdit

        CmsPrepareEditResponse prepareEdit​(CmsUUID currentPage,
                                   java.lang.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

        java.lang.String renameResource​(CmsUUID structureId,
                                java.lang.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,
                 java.util.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,
                      java.lang.String title,
                      java.lang.String link,
                      java.lang.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

        java.lang.String substituteLinkForRootPath​(java.lang.String currentSiteRoot,
                                           java.lang.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

      • 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

        java.util.Map<java.lang.String,​java.lang.String> validateAliases​(CmsUUID uuid,
                                                                       java.util.Map<java.lang.String,​java.lang.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