Package org.exoplatform.documents.storage.jcr.util

Class JCRDocumentsUtil

java.lang.Object
org.exoplatform.documents.storage.jcr.util.JCRDocumentsUtil
public class JCRDocumentsUtil extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DOCUMENTS_NODE
     
    static final String
    GROUPS_PATH_ALIAS
     
    static final String
    MIX_VERSIONABLE
     
    protected static final Map<org.exoplatform.documents.constant.DocumentSortField,String>
    SORT_FIELDS_ES_CORRESPONDING
     
    protected static final Map<org.exoplatform.documents.constant.DocumentSortField,String>
    SORT_FIELDS_JCR_CORRESPONDING
     
    static final String
    USER_PRIVATE_ROOT_NODE
     
    static final String
    USER_PUBLIC_ROOT_NODE
     
    static final String
    USERS_PATH_ALIAS
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    cleanFiles(File file)
     
    static String
    cleanName(String oldName)
    Clean string.
    static String
    cleanName(String oldName, String nodeType)
     
    static String
    cleanNameWithAccents(String fileName, String nodeType)
     
    static void
    computeDocumentAcl(javax.jcr.Node node, org.exoplatform.documents.model.AbstractNode documentNode, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static long
    computeVersionsSize(javax.jcr.Node node)
     
    static void
    createFile(javax.jcr.Node node, String symlinkPath, String sourcePath, String tempFolderPath, javax.jcr.Node parentNode)
     
    static void
    createTempFilesAndFolders(javax.jcr.Node node, String symlinkPath, String sourcePath, String tempFolderPath, javax.jcr.Node parentNode)
     
    static String
    getFolderLink(javax.jcr.Node node, org.exoplatform.social.core.space.model.Space space)
     
    static javax.jcr.Node
    getGroupNode(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, javax.jcr.Session session, String groupId)
     
    static String
    getGroupsPath(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator)
     
    static javax.jcr.Node
    getIdentityRootNode(org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, String username, org.exoplatform.social.core.identity.model.Identity ownerIdentity, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
     
    static javax.jcr.Node
    getIdentityRootNode(org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.social.core.identity.model.Identity ownerIdentity, javax.jcr.Session session)
     
    static long
    getLastModifiedDate(javax.jcr.Node node)
     
    static String
    getLastModifier(javax.jcr.Node node)
     
    static String
    getLastModifierOrCreator(javax.jcr.Node node)
     
    static String
    getMimeType(javax.jcr.Node node)
     
    static String
    getNewIndexedName(String exoTitle, String newNameSuffix)
     
    static javax.jcr.Node
    getNode(javax.jcr.Session session, org.exoplatform.documents.model.FileNode fileNode, DocumentFileSearchResult fileSearchResult)
     
    static javax.jcr.Node
    getNodeById(javax.jcr.Session session, String nodeId)
     
    static javax.jcr.Node
    getNodeByIdentifier(javax.jcr.Session session, String nodeId)
     
    static javax.jcr.Node
    getNodeByPath(javax.jcr.Session session, String nodePath)
     
    static org.exoplatform.social.core.identity.model.Identity
    getOwnerIdentityFromNodePath(String path, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static String
    getPathWithTitles(javax.jcr.Node node)
     
    static String
    getSortDirection(org.exoplatform.documents.model.DocumentNodeFilter filter)
     
    static String
    getSortField(org.exoplatform.documents.model.DocumentNodeFilter filter, boolean isJcr)
     
    static String
    getTitle(javax.jcr.Node node)
     
    static long
    getUserIdentityId(org.exoplatform.social.core.manager.IdentityManager identityManager, String username)
     
    static org.exoplatform.services.jcr.ext.common.SessionProvider
    getUserSessionProvider(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.security.Identity aclIdentity)
     
    static String
    getUsersPath()
     
    static org.exoplatform.social.core.identity.model.Identity
    groupToIdentity(String groupId)
     
    static boolean
    hasEditPermission(javax.jcr.Session session, javax.jcr.Node node)
     
    static String
    increaseNameIndex(String origin, int count)
     
    static boolean
    isFile(javax.jcr.Node node)
     
    static boolean
    isFolder(javax.jcr.Node node)
     
    static boolean
    isInUserPrivateSpace(javax.jcr.Node node, String username)
    Whether the node sits inside username's own Personal Documents ("Private") space.
    static boolean
    isValidDocumentTitle(String name)
     
    static void
    retrieveFileContentProperties(javax.jcr.Node content, org.exoplatform.documents.model.FileNode fileNode)
     
    static void
    retrieveFileProperties(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Node node, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.documents.model.AbstractNode documentNode, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static void
    retrieveTrashElementProperties(javax.jcr.Node node, org.exoplatform.documents.model.TrashElementNode trashElementNode)
     
    static org.exoplatform.documents.model.DownloadItem
    toDownloadItem(javax.jcr.Node node)
     
    static org.exoplatform.documents.model.FileNode
    toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, org.exoplatform.services.security.Identity aclIdentity, SearchResult searchResult, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static org.exoplatform.documents.model.FileNode
    toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, String sourceID, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static void
    toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, org.exoplatform.documents.model.FileNode fileNode, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static List<org.exoplatform.documents.model.FileNode>
    toFileNodes(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Session session, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles)
     
    static org.exoplatform.documents.model.FileVersion
    toFileVersion(javax.jcr.version.Version version, javax.jcr.Node node, org.exoplatform.social.core.manager.IdentityManager identityManager)
     
    static org.exoplatform.documents.model.FolderNode
    toFolderNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, String sourceID, org.exoplatform.social.core.space.spi.SpaceService spaceService)
     
    static List<org.exoplatform.documents.model.AbstractNode>
    toNodes(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles, org.exoplatform.documents.model.DocumentFolderFilter filter)
    Converts query rows to the folders and files they list, as toNodesInRowOrder(org.exoplatform.social.core.manager.IdentityManager, javax.jcr.Session, javax.jcr.NodeIterator, org.exoplatform.services.security.Identity, org.exoplatform.social.core.space.spi.SpaceService, boolean) does, then sorts them, folders first, by the filter's sort field and direction.
    static List<org.exoplatform.documents.model.AbstractNode>
    toNodesInRowOrder(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles)
    Converts the rows of a folder query to the folders and files they list, in the order the rows come in: a shortcut is converted with its target's kind, and a shortcut whose target is gone or can't be read, a hidden child when hidden children are not listed, and a node neither a folder nor a file are left out.
    static void
    zipFiles(String zipFilePath, String tempFolderPath)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • getGroupNode

      public static javax.jcr.Node getGroupNode(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, javax.jcr.Session session, String groupId) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getGroupsPath

      public static String getGroupsPath(org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator)

    • getUsersPath

      public static String getUsersPath()
      Returns:
      the JCR path holding every user's home node, e.g. /Users.

    • toFileNodes

      public static List<org.exoplatform.documents.model.FileNode> toFileNodes(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Session session, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • toNodes

      public static List<org.exoplatform.documents.model.AbstractNode> toNodes(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles, org.exoplatform.documents.model.DocumentFolderFilter filter)
      Converts query rows to the folders and files they list, as toNodesInRowOrder(org.exoplatform.social.core.manager.IdentityManager, javax.jcr.Session, javax.jcr.NodeIterator, org.exoplatform.services.security.Identity, org.exoplatform.social.core.space.spi.SpaceService, boolean) does, then sorts them, folders first, by the filter's sort field and direction.
      Parameters:
      identityManager - the identity manager
      session - the user's session
      nodeIterator - the rows
      aclIdentity - the user's identity
      spaceService - the space service
      includeHiddenFiles - whether hidden children are listed
      filter - the filter holding the sort field and direction
      Returns:
      the folders and files, sorted

    • toNodesInRowOrder

      public static List<org.exoplatform.documents.model.AbstractNode> toNodesInRowOrder(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, javax.jcr.NodeIterator nodeIterator, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.space.spi.SpaceService spaceService, boolean includeHiddenFiles)
      Converts the rows of a folder query to the folders and files they list, in the order the rows come in: a shortcut is converted with its target's kind, and a shortcut whose target is gone or can't be read, a hidden child when hidden children are not listed, and a node neither a folder nor a file are left out. A listing paged over the rows of a sorted query keeps that query's order, so that a longer read extends a shorter one.
      Parameters:
      identityManager - the identity manager
      session - the user's session
      nodeIterator - the rows
      aclIdentity - the user's identity
      spaceService - the space service
      includeHiddenFiles - whether hidden children are listed
      Returns:
      the folders and files, in the rows' order

    • toFolderNode

      public static org.exoplatform.documents.model.FolderNode toFolderNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, String sourceID, org.exoplatform.social.core.space.spi.SpaceService spaceService)

    • toFileNode

      public static org.exoplatform.documents.model.FileNode toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Session session, org.exoplatform.services.security.Identity aclIdentity, SearchResult searchResult, org.exoplatform.social.core.space.spi.SpaceService spaceService)

    • toFileNode

      public static org.exoplatform.documents.model.FileNode toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, String sourceID, org.exoplatform.social.core.space.spi.SpaceService spaceService)

    • toFileNode

      public static void toFileNode(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.security.Identity aclIdentity, javax.jcr.Node node, org.exoplatform.documents.model.FileNode fileNode, org.exoplatform.social.core.space.spi.SpaceService spaceService)

    • getNode

      public static javax.jcr.Node getNode(javax.jcr.Session session, org.exoplatform.documents.model.FileNode fileNode, DocumentFileSearchResult fileSearchResult) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • retrieveFileProperties

      public static void retrieveFileProperties(org.exoplatform.social.core.manager.IdentityManager identityManager, javax.jcr.Node node, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.documents.model.AbstractNode documentNode, org.exoplatform.social.core.space.spi.SpaceService spaceService) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • retrieveFileContentProperties

      public static void retrieveFileContentProperties(javax.jcr.Node content, org.exoplatform.documents.model.FileNode fileNode) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getLastModifiedDate

      public static long getLastModifiedDate(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getLastModifierOrCreator

      public static String getLastModifierOrCreator(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getLastModifier

      public static String getLastModifier(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • computeVersionsSize

      public static long computeVersionsSize(javax.jcr.Node node)

    • computeDocumentAcl

      public static void computeDocumentAcl(javax.jcr.Node node, org.exoplatform.documents.model.AbstractNode documentNode, org.exoplatform.services.security.Identity aclIdentity, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.space.spi.SpaceService spaceService) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getNodeByIdentifier

      public static javax.jcr.Node getNodeByIdentifier(javax.jcr.Session session, String nodeId)

    • getNodeById

      public static javax.jcr.Node getNodeById(javax.jcr.Session session, String nodeId)

    • getNodeByPath

      public static javax.jcr.Node getNodeByPath(javax.jcr.Session session, String nodePath)

    • isInUserPrivateSpace

      public static boolean isInUserPrivateSpace(javax.jcr.Node node, String username) throws javax.jcr.RepositoryException
      Whether the node sits inside username's own Personal Documents ("Private") space.

      Whoever owns the containing space must always be able to manage what is inside it, even a node whose own explicit ACL does not grant them REMOVE/ SET_PROPERTY — an ACE that never named the space's owner (e.g. a node created there on somebody else's behalf) must not outrank ownership of the space itself.

      Parameters:
      node - the node to check
      username - the user whose private space to check against
      Returns:
      true when the node's path sits under that user's own Private root
      Throws:
      javax.jcr.RepositoryException - if the node's path cannot be read

    • getIdentityRootNode

      public static javax.jcr.Node getIdentityRootNode(org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, String username, org.exoplatform.social.core.identity.model.Identity ownerIdentity, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) throws Exception
      Throws:
      Exception

    • getIdentityRootNode

      public static javax.jcr.Node getIdentityRootNode(org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.social.core.identity.model.Identity ownerIdentity, javax.jcr.Session session) throws Exception
      Throws:
      Exception

    • getSortDirection

      public static String getSortDirection(org.exoplatform.documents.model.DocumentNodeFilter filter)

    • getSortField

      public static String getSortField(org.exoplatform.documents.model.DocumentNodeFilter filter, boolean isJcr)

    • getUserSessionProvider

      public static org.exoplatform.services.jcr.ext.common.SessionProvider getUserSessionProvider(org.exoplatform.services.jcr.RepositoryService repositoryService, org.exoplatform.services.security.Identity aclIdentity)

    • getUserIdentityId

      public static long getUserIdentityId(org.exoplatform.social.core.manager.IdentityManager identityManager, String username)

    • cleanName

      public static String cleanName(String oldName)
      Clean string.
      Parameters:
      oldName - the str
      Returns:
      the string

    • cleanName

      public static String cleanName(String oldName, String nodeType)

    • cleanNameWithAccents

      public static String cleanNameWithAccents(String fileName, String nodeType)

    • isValidDocumentTitle

      public static boolean isValidDocumentTitle(String name)

    • getMimeType

      public static String getMimeType(javax.jcr.Node node)

    • getOwnerIdentityFromNodePath

      public static org.exoplatform.social.core.identity.model.Identity getOwnerIdentityFromNodePath(String path, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.space.spi.SpaceService spaceService)

    • toFileVersion

      public static org.exoplatform.documents.model.FileVersion toFileVersion(javax.jcr.version.Version version, javax.jcr.Node node, org.exoplatform.social.core.manager.IdentityManager identityManager) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • increaseNameIndex

      public static String increaseNameIndex(String origin, int count)

    • getNewIndexedName

      public static String getNewIndexedName(String exoTitle, String newNameSuffix)

    • isFolder

      public static boolean isFolder(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • isFile

      public static boolean isFile(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • hasEditPermission

      public static boolean hasEditPermission(javax.jcr.Session session, javax.jcr.Node node)

    • groupToIdentity

      public static org.exoplatform.social.core.identity.model.Identity groupToIdentity(String groupId)

    • toDownloadItem

      public static org.exoplatform.documents.model.DownloadItem toDownloadItem(javax.jcr.Node node) throws Exception
      Throws:
      Exception

    • createFile

      public static void createFile(javax.jcr.Node node, String symlinkPath, String sourcePath, String tempFolderPath, javax.jcr.Node parentNode) throws javax.jcr.RepositoryException, IOException
      Throws:
      javax.jcr.RepositoryException
      IOException

    • getPathWithTitles

      public static String getPathWithTitles(javax.jcr.Node node)

    • createTempFilesAndFolders

      public static void createTempFilesAndFolders(javax.jcr.Node node, String symlinkPath, String sourcePath, String tempFolderPath, javax.jcr.Node parentNode) throws Exception
      Throws:
      Exception

    • cleanFiles

      public static void cleanFiles(File file)

    • zipFiles

      public static void zipFiles(String zipFilePath, String tempFolderPath) throws Exception
      Throws:
      Exception

    • getFolderLink

      public static String getFolderLink(javax.jcr.Node node, org.exoplatform.social.core.space.model.Space space) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • retrieveTrashElementProperties

      public static void retrieveTrashElementProperties(javax.jcr.Node node, org.exoplatform.documents.model.TrashElementNode trashElementNode) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException

    • getTitle

      public static String getTitle(javax.jcr.Node node) throws javax.jcr.RepositoryException
      Throws:
      javax.jcr.RepositoryException