Package org.opencms.repository

Interface I_CmsRepositorySession

All Known Implementing Classes:
A_CmsRepositorySession, CmsRepositorySession
public interface I_CmsRepositorySession
A repository session which provides basic file and folder operations to the resources in the VFS of OpenCms.

Since:
6.2.4

  • Method Details

    • copy

      void copy(String src, String dest, boolean overwrite, boolean shallow) throws CmsException
      Copies the item found at the source path to the destination path.

      Parameters:
      src - the path of the item which should be copied
      dest - the destination path where to copy to
      overwrite - should any existing item be overwritten
      shallow - if true, when copying a folder, only the folder will be copied and not its contents
      Throws:
      CmsException - if something goes wrong

    • create

      void create(String path) throws CmsException
      Creates a new item at the given path.

      In this case this should be a collection (directory).

      Parameters:
      path - the complete path of the new collection
      Throws:
      CmsException - if something goes wrong

    • delete

      void delete(String path) throws CmsException
      Deletes the item at the given path.

      Parameters:
      path - the complete path of the item to delete
      Throws:
      CmsException - if something goes wrong

    • exists

      boolean exists(String path)
      Returns if an item exists at the given path.

      Parameters:
      path - the complete path of the item to check existance
      Returns:
      true if the item exists otherwise false

    • getItem

      I_CmsRepositoryItem getItem(String path) throws CmsException
      Returns the item found at the given path.

      Parameters:
      path - the complete path of the item to return
      Returns:
      the item found at the path
      Throws:
      CmsException - if something goes wrong

    • getLock

      CmsRepositoryLockInfo getLock(String path)
      Returns the lock for the resource at the given path.

      Parameters:
      path - the complete path where to return the lock for
      Returns:
      the found lock as CmsWebdavLockInfo or null if not found

    • getProperties

      Map<CmsPropertyName,String> getProperties(String path) throws CmsException
      Gets the properties for the given path.
      Parameters:
      path - the path
      Returns:
      the properties for the path
      Throws:
      CmsException - if something goes wrong

    • list

      List<I_CmsRepositoryItem> list(String path) throws CmsException
      Returns a list with all items found directly in the given path.

      Parameters:
      path - the complete path from which to return the items
      Returns:
      a list with I_CmsRepositoryItem found in the path
      Throws:
      CmsException - if something goes wrong

    • lock

      boolean lock(String path, CmsRepositoryLockInfo lock) throws CmsException
      Creates a new lock on the item at the path with the given information in the lock info.

      Parameters:
      path - the complete path of the item
      lock - the information about the lock to create
      Returns:
      if the lock was successfully
      Throws:
      CmsException - if something goes wrong

    • move

      void move(String src, String dest, boolean overwrite) throws CmsException
      Moves an item from a source path to a destination path.

      Parameters:
      src - the complete path to the item which should be copied
      dest - the complete destination path where to copy to
      overwrite - should any existing item should be overwritten
      Throws:
      CmsException - if something goes wrong

    • save

      void save(String path, InputStream inputStream, boolean overwrite) throws CmsException, IOException
      Saves an item at the given path.

      This creates a new single item (file) if it does not exist.

      Parameters:
      path - the complete path of the new item
      inputStream - the content of the item
      overwrite - should an existing item at the path be overwritten
      Throws:
      CmsException - if something goes wrong
      IOException - if a write error occurs

    • unlock

      void unlock(String path)
      Unlocks the item found at the path.

      Parameters:
      path - The complete path of the item to unlock

    • updateProperties

      void updateProperties(String path, Map<CmsPropertyName,String> properties) throws CmsException
      Updates the properties for the given path.
      Parameters:
      path - the path
      properties - the properties
      Throws:
      CmsException - if something goes wrong