JCRContentUtils (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.content.JCRContentUtils

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware
```
public final class JCRContentUtils
extends Object
implements org.springframework.web.context.ServletContextAware
```
Utility class for accessing and manipulation JCR properties.

Author:

Sergiy Shyrkov

Field Summary

Fields
Modifier and Type Field and Description

static Pattern COLON_PATTERN

static Comparator<javax.jcr.nodetype.NodeType> NODE_TYPE_NAME_COMPARATOR

Fields
Modifier and Type	Field and Description
`static Pattern`	`COLON_PATTERN`
`static Comparator<javax.jcr.nodetype.NodeType>`	`NODE_TYPE_NAME_COMPARATOR`

Constructor Summary

Constructors
Constructor and Description
`JCRContentUtils(Map<String,List<String>> mimeTypes, Map<String,String> fileExtensionIcons, Map<String,String> defaultUserFolderTypes)` Initializes an instance of this class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static int`	`callDataStoreGarbageCollector()` Calls the datastore garbage collector and returns the number of data entries deleted.
`static boolean`	`check(String icon)`
`static void`	`clearAllLocks(String path, boolean processChildNodes, String workspace)` Removes all locks on the current node and optionally on its children.
`static javax.jcr.Value`	`createValue(Object objectValue, javax.jcr.ValueFactory factory)` Creates the JCR property value, depending on the type of the corresponding value.
`static javax.jcr.Value[]`	`createValues(Collection<?> objectValues, javax.jcr.ValueFactory factory)` Creates the JCR property values, depending on the type of the corresponding value.
`static String`	`decodeJCRNamePrefix(String encodedPrefix)` Reverse operation of encodeJCRNamePrefix.
`static void`	`deleteJackrabbitIndexes(File repositoryHome)` Can be used to delete the Jackrabbit indexes folders for version and workspaces to force re-indexing on the next repository startup.
`static File`	`downloadFileContent(JCRNodeWrapper node)` Downloads the JCR content to a temporary file.
`static File`	`downloadFileContent(JCRNodeWrapper node, File targetFile)` Downloads the JCR content to a specified file.
`static String`	`encodeJCRNamePrefix(String originalPrefix)` Encode a JCR qualified form name prefix, according to the grammar defined in section 3.2.5.2 of the JCR 2.0 specification http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#Names Note : this is not yet complete as it depends on the restrictions imposed on XML namespaces as defined here http://www.w3.org/TR/REC-xml-names/
`static String`	`escapeLocalNodeName(String name)`
`static String`	`escapeNodePath(String path)`
`static String`	`findAvailableNodeName(javax.jcr.Node dest, String name)` Returns the next available name for a node, appending if needed numbers.
`static String`	`findAvailableNodeName(javax.jcr.Node dest, String name, boolean hasExtension)` Returns the next available name for a node, appending if needed numbers.
`static JCRNodeWrapper`	`findDisplayableNode(JCRNodeWrapper node, RenderContext context)`
`static JCRNodeWrapper`	`findDisplayableNode(JCRNodeWrapper node, RenderContext context, JCRSiteNode contextSite)`
`String`	`generateNodeName(JCRNodeWrapper parent, String nodeType)` Generates the node name by using a configurable NameGenerationHelper implementation.
`String`	`generateNodeName(JCRNodeWrapper parent, String defaultLanguage, ExtendedNodeType nodeType, String targetName)` Generates the node name by using a configurable NameGenerationHelper implementation.
`static String`	`generateNodeName(String text)`
`static String`	`generateNodeName(String text, int maxLength)` Generates the JCR node name from the provided text by normalizing it, converting to lower case, replacing spaces with dashes and truncating to $`maxLength` characters.
`static Set<String>`	`getAssignableMixins(JCRNodeWrapper node)` Returns a set of all mixin types, which can be added to the provided node.
`static List<JCRNodeWrapper>`	`getChildrenOfType(JCRNodeWrapper node, String type)` Returns a list of child nodes of the provided node, matching the specified node type (multiple node types can be specified, separated by a comma).
`static List<JCRNodeWrapper>`	`getChildrenOfType(JCRNodeWrapper node, String type, int limit)`
`static String`	`getContentNodeName(javax.jcr.Node node)` Returns a content object key for a node if available.
`static String`	`getContentObjectPath(javax.jcr.Node node)` Returns a node path, composed using only content object keys, i.e.
`JCRNodeWrapper`	`getDefaultUserFolder(JCRSessionWrapper session, String path)`
`JCRNodeWrapper`	`getDefaultUserFolder(JCRSessionWrapper session, String path, boolean saveIfCreate)` Retrieves the default user folder found at the specified path, creating it (and all intermediate folders) if needed, saving the session if requested.
`static javax.jcr.NodeIterator`	`getDescendantNodes(JCRNodeWrapper node, String type)`
`static String`	`getDisplayLabel(Object item, Locale locale, ExtendedNodeType nodeTypeForSearchingLabel)` Get the node or property display name depending on the locale
`static String`	`getExpandedName(String name, javax.jcr.NamespaceRegistry namespaceRegistry)`
`Map<String,String>`	`getFileExtensionIcons()` Returns a mapping between file extensions and corresponding icons.
`Pattern`	`getHandleFallbackLocaleForPathPattern()`
`static String`	`getIcon(ExtendedNodeType type)` Returns the icon path for the specified type
`static String`	`getIcon(JCRNodeWrapper f)`
`static String`	`getIconsFolder(ExtendedNodeType primaryNodeType)` For a nodetype gets the folder that contains its icon for system and module default nodetypes, icons asset folder is returned
`static String`	`getIconWithContext(ExtendedNodeType type)`
`static String`	`getIconWithContext(JCRNodeWrapper f, boolean useContext)`
`static JCRContentUtils`	`getInstance()`
`static String`	`getJCRName(String qualifiedName, javax.jcr.NamespaceRegistry namespaceRegistry)`
`static JCRNodeLockType`	`getLockType(String lockTypeToken)` Returns the parsed lock type from the provided token.
`static Set<JCRNodeLockType>`	`getLockTypes(Map<String,List<String>> lockInfos)` Returns a set of lock types for the current node.
`static String`	`getMimeType(String fileName)` Detects the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor).
`static String`	`getMimeType(String fileName, String fallbackMimeType)` Detects the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor).
`Map<String,List<String>>`	`getMimeTypes()` Return a map of mime types (file formats) to be available in the advanced search form.
`static String`	`getNameFromPath(String path)` Returns the last part of a path, so the last name.
`NameGenerationHelper`	`getNameGenerationHelper()`
`static List<JCRNodeWrapper>`	`getNodes(JCRNodeWrapper node, String type)`
`static List<JCRNodeWrapper>`	`getNodes(JCRNodeWrapper node, String type, int limit)`
`static JCRNodeWrapper`	`getOrAddPath(JCRSessionWrapper session, JCRNodeWrapper parentNode, String path, String pathNodeType)` Little utility method to retrieve or create a path, building it if necessary.
`static String`	`getParentJCRPath(String path)` A small utility method to retrieve the parent path of a path that contains expanded form names.
`static JCRNodeWrapper`	`getParentOfType(JCRNodeWrapper node, String type)`
`static JCRNodeWrapper`	`getParentWithAclInheritanceBroken(JCRNodeWrapper node)` Returns the first parent of the specified node, which has the ACL inheritance broken.
`static JCRNodeWrapper`	`getPathFolder(JCRNodeWrapper root, String name, String options, String nodeType)`
`static javax.jcr.nodetype.PropertyDefinition`	`getPropertyDefinition(javax.jcr.nodetype.NodeType type, String property)`
`static javax.jcr.nodetype.PropertyDefinition`	`getPropertyDefinition(String nodeType, String property)`
`static int`	`getPropertyDefSelector(javax.jcr.nodetype.ItemDefinition itemDef)`
`static List<Map<String,Object>>`	`getRolesForNode(JCRNodeWrapper node, boolean includeInherited, boolean expandGroups, String roles, int limit, boolean latestFirst)`
`static String`	`getSiteKey(String jcrNodePath)` If the node path contains site information (i.e.
`static String`	`getSystemSitePath()`
`Set<String>`	`getUnsupportedMarkForDeletionNodeTypes()`
`JCRNodeWrapper`	`getUserPrivateFilesFolder(JCRSessionWrapper session)` Returns the /files/private folder for the current session user, creating it if it does not exist yet.
`static Object`	`getValue(javax.jcr.Value propertyValue)` Returns an object value that corresponds to the provided JCR property value depending on its type.
`static boolean`	`hasPermission(String workspaceName, String permissionName, String nodeUUID)` Used by portlet backends to determine if a user is part of a specific permissionName on a node specified by it's UUID
`static void`	`importSkeletons(String skeletonLocations, String targetPath, JCRSessionWrapper session)` Performs import of JCR data using provided skeleton locations.
`static void`	`importSkeletons(String skeletonLocations, String targetPath, JCRSessionWrapper session, int importUUIDBehavior, Map<String,String> replacements)` Performs import of JCR data using provided skeleton locations.
`static void`	`importSkeletons(String skeletonLocations, String targetPath, JCRSessionWrapper session, Map<String,String> replacements)` Performs import of JCR data using provided skeleton locations.
`static boolean`	`isADisplayableNode(JCRNodeWrapper node, RenderContext context)`
`static boolean`	`isLanguageInvalid(javax.jcr.Node node, String languageCode)` Checks if the specified language is marked as invalid for displaying.
`static boolean`	`isLockedAndCannotBeEdited(JCRNodeWrapper node)` Returns `true` if the node is locked and cannot be edited by current user.
`static boolean`	`isMimeTypeGroup(String mimeType, String... mimeTypeGroups)` Checks if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.).
`static boolean`	`isMimeTypeGroup(String mimeType, String mimeTypeGroup)` Checks if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.).
`static boolean`	`isNodeType(JCRNodeWrapper node, Iterable<String> types)` Returns `true` if the provided node matches one of the specified node types.
`static boolean`	`isNodeType(JCRNodeWrapper node, String... types)` Returns `true` if the provided node matches one of the specified node types.
`static boolean`	`isNodeType(JCRNodeWrapper node, String type)` Returns `true` if the provided node matches the specified node type (multiple node types can be specified, separated by a comma).
`static boolean`	`isNotJcrUuid(String uuid)` Deprecated. without any replacement
`static boolean`	`isUserMemberOfGroup(String siteKey, String groupName, String userName, String userRealm, boolean isRoot)` Check if user is member of the given group
`static boolean`	`isValidFilename(String name)`
`static boolean`	`isValidWorkspace(String workspace)` Validates if the specified name is a valid JCR workspace (either `default` or `live`).
`static boolean`	`isValidWorkspace(String workspace, boolean allowBlank)` Validates if the specified name is a valid JCR workspace (either `default` or `live`).
`static boolean`	`needVersion(JCRNodeWrapper node, Set<String> versionedTypes)` this method checks if the node type is versionable from a jahia property
`static void`	`registerNamespace(javax.jcr.Session session, String prefix, String uri)` Small utility method to help with proper namespace registration in all JCR providers.
`static String`	`replaceColon(String name)`
`static <T> Map<String,T>`	`reverse(Map<String,T> orderedMap)`
`void`	`setHandleFallbackLocaleForPath(String handleFallbackLocaleForPath)`
`void`	`setNameGenerationHelper(NameGenerationHelper nameGenerationHelper)`
`void`	`setServletContext(javax.servlet.ServletContext servletContext)`
`void`	`setUnsupportedMarkForDeletionNodeTypes(Set<String> unsupportedMarkForDeletionNodeTypes)`
`static long`	`size(javax.jcr.RangeIterator iterator)` Returns the number of elements in the provided iterator.
`static Set<String>`	`splitAndUnify(String input, String separator)` this method splits a String with a separator and put all its elements in a Set
`static String[]`	`splitJCRPath(String path)` Utility method to split a JCR path into names.
`static String`	`sqlEncode(String s)` Encode a string to be used in a JCR SQL2 query by "escaping" the single quotes.
`static String`	`stringToJCRPathExp(String str)` Convert a path string to encoded path Strings in XPATH queries
`static String`	`stringToJCRSearchExp(String str)` Convert a string to a JCR search expression literal, suitable for use in jcr:contains() (inside XPath) or contains (SQL2).
`static String`	`stringToQueryLiteral(String str)` Convert a string to a literal, suitable for inclusion in a query.
`static String`	`unescapeLocalNodeName(String encodedLocalName)` Decode an encoded JCR local name encoded with the `escapeLocalNodeName(String)` method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COLON_PATTERN
```
public static final Pattern COLON_PATTERN
```
  - NODE_TYPE_NAME_COMPARATOR
```
public static final Comparator<javax.jcr.nodetype.NodeType> NODE_TYPE_NAME_COMPARATOR
```
- Constructor Detail
  - JCRContentUtils
```
public JCRContentUtils(Map<String,List<String>> mimeTypes,
                       Map<String,String> fileExtensionIcons,
                       Map<String,String> defaultUserFolderTypes)
```
    Initializes an instance of this class.
    
    Parameters:
    
    mimeTypes - a map with mime type mappings
    
    fileExtensionIcons - mapping between file extensions and corresponding icons
- Method Detail
  - getInstance
```
public static JCRContentUtils getInstance()
```
  - callDataStoreGarbageCollector
```
public static int callDataStoreGarbageCollector()
                                         throws javax.jcr.RepositoryException
```
    Calls the datastore garbage collector and returns the number of data entries deleted.
    
    Returns:
    
    the number of data entries deleted
    
    Throws:
    
    javax.jcr.RepositoryException - in case of an error
  - check
```
public static boolean check(String icon)
```
  - clearAllLocks
```
public static void clearAllLocks(String path,
                                 boolean processChildNodes,
                                 String workspace)
                          throws javax.jcr.RepositoryException
```
    Removes all locks on the current node and optionally on its children.
    
    Parameters:
    
    path - the path of the node remove locks from
    
    processChildNodes - do we need to also remove locks in children?
    
    workspace - workspace
    
    Throws:
    
    javax.jcr.RepositoryException - in case of an error
  - createValue
```
public static javax.jcr.Value createValue(Object objectValue,
                                          javax.jcr.ValueFactory factory)
```
    Creates the JCR property value, depending on the type of the corresponding value.
    
    Parameters:
    
    objectValue - the object value to be converted
    
    factory - the ValueFactory instance
    
    Returns:
    
    the JCR property value
  - createValues
```
public static javax.jcr.Value[] createValues(Collection<?> objectValues,
                                             javax.jcr.ValueFactory factory)
```
    Creates the JCR property values, depending on the type of the corresponding value.
    
    Parameters:
    
    objectValues - the object values to be converted
    
    factory - the ValueFactory instance
    
    Returns:
    
    the JCR property value
  - decodeJCRNamePrefix
```
public static String decodeJCRNamePrefix(String encodedPrefix)
```
    Reverse operation of encodeJCRNamePrefix. Note : this is not yet complete as it depends on the restrictions imposed on XML namespaces as defined here http://www.w3.org/TR/REC-xml-names/
    
    Parameters:
    
    encodedPrefix -
    
    Returns:
  - deleteJackrabbitIndexes
```
public static void deleteJackrabbitIndexes(File repositoryHome)
```
    Can be used to delete the Jackrabbit indexes folders for version and workspaces to force re-indexing on the next repository startup. Note please that this method can only be invoked when the repository is not started (offline).
    
    Parameters:
    
    repositoryHome - the repository home folder
  - downloadFileContent
```
public static File downloadFileContent(JCRNodeWrapper node)
                                throws IOException
```
    Downloads the JCR content to a temporary file.
    
    Parameters:
    
    node - the JCR node with the file content
    
    Returns:
    
    the target file descriptor
    
    Throws:
    
    IOException - in case of an error
  - downloadFileContent
```
public static File downloadFileContent(JCRNodeWrapper node,
                                       File targetFile)
                                throws IOException
```
    Downloads the JCR content to a specified file.
    
    Parameters:
    
    node - the JCR node with the file content
    
    targetFile - target file to write data into
    
    Returns:
    
    the target file descriptor
    
    Throws:
    
    IOException - in case of an error
  - encodeJCRNamePrefix
```
public static String encodeJCRNamePrefix(String originalPrefix)
```
    Encode a JCR qualified form name prefix, according to the grammar defined in section 3.2.5.2 of the JCR 2.0 specification http://www.day.com/specs/jcr/2.0/3_Repository_Model.html#Names Note : this is not yet complete as it depends on the restrictions imposed on XML namespaces as defined here http://www.w3.org/TR/REC-xml-names/
    
    Parameters:
    
    originalPrefix -
    
    Returns:
  - escapeLocalNodeName
```
public static String escapeLocalNodeName(String name)
```
  - escapeNodePath
```
public static String escapeNodePath(String path)
```
  - findAvailableNodeName
```
public static String findAvailableNodeName(javax.jcr.Node dest,
                                           String name)
```
    Returns the next available name for a node, appending if needed numbers.
    
    Parameters:
    
    dest - the destination node, where the new one will be created
    
    name - the name of the new node
    
    Returns:
    
    the next available name for a node, appending if needed numbers
  - findAvailableNodeName
```
public static String findAvailableNodeName(javax.jcr.Node dest,
                                           String name,
                                           boolean hasExtension)
```
    Returns the next available name for a node, appending if needed numbers.
    
    Parameters:
    
    dest - the destination node, where the new one will be created
    
    name - the name of the new node
    
    hasExtension - true if the name has an extension (e.g. in case of file names)
    
    Returns:
    
    the next available name for a node, appending if needed numbers
  - findDisplayableNode
```
public static JCRNodeWrapper findDisplayableNode(JCRNodeWrapper node,
                                                 RenderContext context)
```
  - findDisplayableNode
```
public static JCRNodeWrapper findDisplayableNode(JCRNodeWrapper node,
                                                 RenderContext context,
                                                 JCRSiteNode contextSite)
```
  - generateNodeName
```
public static String generateNodeName(String text)
```
  - generateNodeName
```
public static String generateNodeName(String text,
                                      int maxLength)
```
    Generates the JCR node name from the provided text by normalizing it, converting to lower case, replacing spaces with dashes and truncating to $maxLength characters.
    
    Parameters:
    
    text - the original text to be used as a source
    
    maxLength - the maximum length of the resulting name (it will be truncated if needed)
    
    Returns:
    
    the JCR node name from the provided text by normalizing it, converting to lower case, replacing spaces with dashes and truncating to $maxLength characters
  - getAssignableMixins
```
public static Set<String> getAssignableMixins(JCRNodeWrapper node)
                                       throws javax.jcr.RepositoryException
```
    Returns a set of all mixin types, which can be added to the provided node.
    
    Parameters:
    
    node - the node to add mixin types to
    
    Returns:
    
    a set of all mixin types, which can be added to the provided node
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a repository access error
  - getChildrenOfType
```
public static List<JCRNodeWrapper> getChildrenOfType(JCRNodeWrapper node,
                                                     String type)
```
    Returns a list of child nodes of the provided node, matching the specified node type (multiple node types can be specified, separated by a comma).
    
    Parameters:
    
    node - the parent node to retrieve children from
    
    type - the node type to be matched by a retrieved child. Multiple node types can be specified, separated by a comma.
    
    Returns:
    
    a list of child nodes of the provided node, matching the specified node type (multiple node types can be specified, separated by a comma).
  - getChildrenOfType
```
public static List<JCRNodeWrapper> getChildrenOfType(JCRNodeWrapper node,
                                                     String type,
                                                     int limit)
```
  - getContentNodeName
```
public static String getContentNodeName(javax.jcr.Node node)
                                 throws javax.jcr.RepositoryException
```
    Returns a content object key for a node if available. Otherwise returns node name.
    
    Parameters:
    
    node - the node to get name
    
    Returns:
    
    a content object key for a node if available. Otherwise returns node name
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - getContentObjectPath
```
public static String getContentObjectPath(javax.jcr.Node node)
                                   throws javax.jcr.RepositoryException
```
    Returns a node path, composed using only content object keys, i.e.
    /mySite/ContentPage_1/ContentPage_19/ContentContainerList_21/ContentContainer_13
    
    Parameters:
    
    node - the content node to compute path for
    
    Returns:
    
    a node path, composed using only content object keys
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - getDescendantNodes
```
public static javax.jcr.NodeIterator getDescendantNodes(JCRNodeWrapper node,
                                                        String type)
```
  - getDisplayLabel
```
public static String getDisplayLabel(Object item,
                                     Locale locale,
                                     ExtendedNodeType nodeTypeForSearchingLabel)
```
    Get the node or property display name depending on the locale
    
    Parameters:
    
    item - the item to get the label for
    
    locale - current locale
    
    nodeTypeForSearchingLabel -
    
    Returns:
    
    the node or property display name depending on the locale
  - getExpandedName
```
public static String getExpandedName(String name,
                                     javax.jcr.NamespaceRegistry namespaceRegistry)
                              throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getJCRName
```
public static String getJCRName(String qualifiedName,
                                javax.jcr.NamespaceRegistry namespaceRegistry)
                         throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getIconWithContext
```
public static String getIconWithContext(ExtendedNodeType type)
                                 throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getIcon
```
public static String getIcon(ExtendedNodeType type)
                      throws javax.jcr.RepositoryException
```
    Returns the icon path for the specified type
    
    Parameters:
    
    type - wanted type
    
    Returns:
    
    Path of the icon
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - getIcon
```
public static String getIcon(JCRNodeWrapper f)
                      throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getIconWithContext
```
public static String getIconWithContext(JCRNodeWrapper f,
                                        boolean useContext)
                                 throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getIconsFolder
```
public static String getIconsFolder(ExtendedNodeType primaryNodeType)
                             throws javax.jcr.RepositoryException
```
    For a nodetype gets the folder that contains its icon for system and module default nodetypes, icons asset folder is returned
    
    Parameters:
    
    primaryNodeType -
    
    Returns:
    
    folder
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - getLockType
```
public static JCRNodeLockType getLockType(String lockTypeToken)
```
    Returns the parsed lock type from the provided token.
    
    Parameters:
    
    lockTypeToken - the token to detect lock type from
    
    Returns:
    
    the parsed lock type from the provided token
  - getLockTypes
```
public static Set<JCRNodeLockType> getLockTypes(Map<String,List<String>> lockInfos)
```
    Returns a set of lock types for the current node. If there are no locks found in the lock infos, returns an empty set.
    
    Parameters:
    
    lockInfos - the lock information of a node
    
    Returns:
    
    a set of lock types for the current node. If there are no locks found in the lock infos, returns an empty set.
  - getNameFromPath
```
public static String getNameFromPath(String path)
```
    Returns the last part of a path, so the last name. This method supports expanded form names in the path, so the last slash detection will be properly handled.
    
    Parameters:
    
    path - the path to get the name from
    
    Returns:
    
    the name of the leaf in the path.
  - getNodes
```
public static List<JCRNodeWrapper> getNodes(JCRNodeWrapper node,
                                            String type)
```
  - getNodes
```
public static List<JCRNodeWrapper> getNodes(JCRNodeWrapper node,
                                            String type,
                                            int limit)
```
  - getOrAddPath
```
public static JCRNodeWrapper getOrAddPath(JCRSessionWrapper session,
                                          JCRNodeWrapper parentNode,
                                          String path,
                                          String pathNodeType)
                                   throws javax.jcr.RepositoryException
```
    Little utility method to retrieve or create a path, building it if necessary. For example let's say that we want to get or create the path from a parentNode : messages/inbox . We can simply pass the parent node, the session and the path to check, and it will either retrieve it if it exists, or create it if it doesn't.
    Please note that this method also checks out the parent nodes.
    
    Parameters:
    
    session -
    
    parentNode - the parent node in from which we want to retrieve the relative path.
    
    path - the path to retrieve or create. Note that this path MUST be relative
    
    pathNodeType - the type to use for the intermediary nodes (and the last path too !) if they need to be created. Usually you'll want to use Constants.JAHIANT_CONTENTLIST here.
    
    Returns:
    
    the leaf that is equivalent to the lowest path value.
    
    Throws:
    
    javax.jcr.RepositoryException - occurs if there is any problem accessing content or creating the nodes.
  - getParentJCRPath
```
public static String getParentJCRPath(String path)
```
    A small utility method to retrieve the parent path of a path that contains expanded form names.
    
    Parameters:
    
    path - the path for which we want to retrieve the parent path.
    
    Returns:
    
    the parent path including all names in expanded or qualified form.
  - getParentOfType
```
public static JCRNodeWrapper getParentOfType(JCRNodeWrapper node,
                                             String type)
```
  - getPathFolder
```
public static JCRNodeWrapper getPathFolder(JCRNodeWrapper root,
                                           String name,
                                           String options,
                                           String nodeType)
                                    throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getPropertyDefinition
```
public static javax.jcr.nodetype.PropertyDefinition getPropertyDefinition(javax.jcr.nodetype.NodeType type,
                                                                          String property)
                                                                   throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getPropertyDefinition
```
public static javax.jcr.nodetype.PropertyDefinition getPropertyDefinition(String nodeType,
                                                                          String property)
                                                                   throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getPropertyDefSelector
```
public static int getPropertyDefSelector(javax.jcr.nodetype.ItemDefinition itemDef)
```
  - getSiteKey
```
public static String getSiteKey(String jcrNodePath)
```
    If the node path contains site information (i.e. /sites/<siteKey>/...) this method returns the site key part; otherwise null is returned.
    
    Parameters:
    
    jcrNodePath - the JCR node path
    
    Returns:
    
    if the node path contains site information (i.e. /sites/<siteKey>/...) this method returns the site key part; otherwise null is returned
  - getSystemSitePath
```
public static String getSystemSitePath()
```
  - getValue
```
public static Object getValue(javax.jcr.Value propertyValue)
                       throws javax.jcr.ValueFormatException,
                              javax.jcr.RepositoryException
```
    Returns an object value that corresponds to the provided JCR property value depending on its type.
    
    Parameters:
    
    propertyValue - the JCR property value to be converted
    
    Returns:
    
    the object value
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a conversion error
    
    javax.jcr.ValueFormatException - in case of a conversion error
  - hasPermission
```
public static boolean hasPermission(String workspaceName,
                                    String permissionName,
                                    String nodeUUID)
```
    Used by portlet backends to determine if a user is part of a specific permissionName on a node specified by it's UUID
    
    Parameters:
    
    workspaceName - the name of the workspace in which we load the node from.
    
    permissionName -
    
    nodeUUID -
    
    Returns:
  - importSkeletons
```
public static void importSkeletons(String skeletonLocations,
                                   String targetPath,
                                   JCRSessionWrapper session)
                            throws IOException,
                                   javax.jcr.InvalidSerializedDataException,
                                   javax.jcr.RepositoryException
```
    Performs import of JCR data using provided skeleton locations. This method is used when a new virtual site or a new user is created.
    
    Parameters:
    
    skeletonLocations - the (pattern-based) location to search for resources. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS )
    
    targetPath - target JCR path to perform import into
    
    session - the current JCR session
    
    Throws:
    
    IOException - in case of skeleton lookup error
    
    javax.jcr.InvalidSerializedDataException - import related exception
    
    javax.jcr.RepositoryException - general JCR exception
  - importSkeletons
```
public static void importSkeletons(String skeletonLocations,
                                   String targetPath,
                                   JCRSessionWrapper session,
                                   int importUUIDBehavior,
                                   Map<String,String> replacements)
                            throws IOException,
                                   javax.jcr.InvalidSerializedDataException,
                                   javax.jcr.RepositoryException
```
    Performs import of JCR data using provided skeleton locations. This method is used when a new virtual site or a new user is created.
    
    Parameters:
    
    skeletonLocations - the (pattern-based) location to search for resources. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS )
    
    targetPath - target JCR path to perform import into
    
    session - the current JCR session
    
    importUUIDBehavior - the ImportUUIDBehavior to use during import
    
    replacements -
    
    Throws:
    
    IOException - in case of skeleton lookup error
    
    javax.jcr.InvalidSerializedDataException - import related exception
    
    javax.jcr.RepositoryException - general JCR exception
  - importSkeletons
```
public static void importSkeletons(String skeletonLocations,
                                   String targetPath,
                                   JCRSessionWrapper session,
                                   Map<String,String> replacements)
                            throws IOException,
                                   javax.jcr.InvalidSerializedDataException,
                                   javax.jcr.RepositoryException
```
    Performs import of JCR data using provided skeleton locations. This method is used when a new virtual site or a new user is created.
    
    Parameters:
    
    skeletonLocations - the (pattern-based) location to search for resources. Multiple locations can be provided separated by comma (or any delimiter, defined in ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS )
    
    targetPath - target JCR path to perform import into
    
    session - the current JCR session
    
    replacements -
    
    Throws:
    
    IOException - in case of skeleton lookup error
    
    javax.jcr.InvalidSerializedDataException - import related exception
    
    javax.jcr.RepositoryException - general JCR exception
  - isADisplayableNode
```
public static boolean isADisplayableNode(JCRNodeWrapper node,
                                         RenderContext context)
```
  - isMimeTypeGroup
```
public static boolean isMimeTypeGroup(String mimeType,
                                      String mimeTypeGroup)
```
    Checks if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.).
    
    Parameters:
    
    mimeType - the mime type to be checked
    
    mimeTypeGroup - the group (or multiple groups, separated by comma) the specified mime type should belong to
    
    Returns:
    
    if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.)
  - isMimeTypeGroup
```
public static boolean isMimeTypeGroup(String mimeType,
                                      String... mimeTypeGroups)
```
    Checks if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.).
    
    Parameters:
    
    mimeType - the mime type to be checked
    
    mimeTypeGroups - the groups the specified mime type should belong to
    
    Returns:
    
    if the specified mime type belongs to one of the specified groups (like pdf,word,openoffice, etc.)
  - isLanguageInvalid
```
public static boolean isLanguageInvalid(javax.jcr.Node node,
                                        String languageCode)
                                 throws javax.jcr.RepositoryException
```
    Checks if the specified language is marked as invalid for displaying.
    
    Parameters:
    
    node - the node to be checked
    
    languageCode - language code to be tested
    
    Returns:
    
    true if the specified language is in the list of languages marked as invalid for displaying; false otherwise.
    
    Throws:
    
    javax.jcr.RepositoryException - in case of an exception
  - isLockedAndCannotBeEdited
```
public static boolean isLockedAndCannotBeEdited(JCRNodeWrapper node)
                                         throws javax.jcr.RepositoryException
```
    Returns true if the node is locked and cannot be edited by current user.
    
    Parameters:
    
    node - the node to be tested
    
    Returns:
    
    true if the node is locked and cannot be edited by current user
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a JCR error
  - isNodeType
```
public static boolean isNodeType(JCRNodeWrapper node,
                                 Iterable<String> types)
                          throws javax.jcr.RepositoryException
```
    Returns true if the provided node matches one of the specified node types.
    
    Parameters:
    
    node - the node to be tested
    
    types - an array of node types to be matched.
    
    Returns:
    
    true if the provided node matches one of the specified node types
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a JCR error
  - isNodeType
```
public static boolean isNodeType(JCRNodeWrapper node,
                                 String... types)
                          throws javax.jcr.RepositoryException
```
    Returns true if the provided node matches one of the specified node types.
    
    Parameters:
    
    node - the node to be tested
    
    types - an array of node types to be matched.
    
    Returns:
    
    true if the provided node matches one of the specified node types
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a JCR error
  - isNodeType
```
public static boolean isNodeType(JCRNodeWrapper node,
                                 String type)
                          throws javax.jcr.RepositoryException
```
    Returns true if the provided node matches the specified node type (multiple node types can be specified, separated by a comma).
    
    Parameters:
    
    node - the node to be tested
    
    type - the node type to be matched. Multiple node types can be specified, separated by a comma.
    
    Returns:
    
    true if the provided node matches the specified node type (multiple node types can be specified, separated by a comma).
    
    Throws:
    
    javax.jcr.RepositoryException - in case of a JCR error
  - isNotJcrUuid
```
@Deprecated
public static boolean isNotJcrUuid(String uuid)
```
    Deprecated. without any replacement
    
    Returns true if the provided UUID string does not seem like a valid Jackrabbit node UUID. In such a case it comes from a different provide, like VFS.
    
    Parameters:
    
    uuid - the UUID string to check
    
    Returns:
    
    code>true if the provided UUID string does not seem like a valid Jackrabbit node UUID. In such a case it comes from a different provide, like VFS
  - isValidFilename
```
public static boolean isValidFilename(String name)
```
  - isValidWorkspace
```
public static final boolean isValidWorkspace(String workspace)
```
    Validates if the specified name is a valid JCR workspace (either default or live).
    
    Parameters:
    
    workspace - the workspace name to check
    
    Returns:
    
    true if the specified name is a valid JCR workspace (either default or live); otherwise returns false
  - isValidWorkspace
```
public static final boolean isValidWorkspace(String workspace,
                                             boolean allowBlank)
```
    Validates if the specified name is a valid JCR workspace (either default or live).
    
    Parameters:
    
    workspace - the workspace name to check
    
    allowBlank - set to true if the workspace name is allowed to be null or empty
    
    Returns:
    
    true if the specified name is a valid JCR workspace (either default or live); otherwise returns false
  - registerNamespace
```
public static void registerNamespace(javax.jcr.Session session,
                                     String prefix,
                                     String uri)
                              throws javax.jcr.RepositoryException
```
    Small utility method to help with proper namespace registration in all JCR providers.
    
    Parameters:
    
    session -
    
    prefix -
    
    uri -
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - replaceColon
```
public static String replaceColon(String name)
```
  - size
```
public static long size(javax.jcr.RangeIterator iterator)
```
    Returns the number of elements in the provided iterator.
    
    Parameters:
    
    iterator - the item iterator to check the size
    
    Returns:
    
    the number of elements in the provided iterator
  - splitJCRPath
```
public static String[] splitJCRPath(String path)
```
    Utility method to split a JCR path into names. Note that this method supports expanded name notation (using URIs), such as {http://www.jcp.org/jcr/1.0}read, as it is tricky to split simply using the "/" character when URIs are present.
    
    Parameters:
    
    path - a relative or absolute path, with node names in qualified or expanded form
    
    Returns:
    
    an array of String instances that contain the node names in order of the path.
  - stringToJCRPathExp
```
public static String stringToJCRPathExp(String str)
```
    Convert a path string to encoded path Strings in XPATH queries
    
    Parameters:
    
    str - Any string.
    
    Returns:
    
    A valid string path suitable for use in XPATH queries
  - stringToJCRSearchExp
```
public static String stringToJCRSearchExp(String str)
```
    Convert a string to a JCR search expression literal, suitable for use in jcr:contains() (inside XPath) or contains (SQL2). The characters - and " have special meaning, and may be escaped with a backslash to obtain their literal value. See JSR-283 spec v2.0, Sec. 6.7.19.
    
    Parameters:
    
    str - Any string.
    
    Returns:
    
    A valid string literal suitable for use in JCR contains clauses, including enclosing quotes.
  - stringToQueryLiteral
```
public static String stringToQueryLiteral(String str)
```
    Convert a string to a literal, suitable for inclusion in a query. See JSR-283 spec v2.0, Sec. 4.6.6.19.
    
    Parameters:
    
    str - Any string.
    
    Returns:
    
    A valid JCR query string literal, including enclosing quotes.
  - unescapeLocalNodeName
```
public static String unescapeLocalNodeName(String encodedLocalName)
```
    Decode an encoded JCR local name encoded with the escapeLocalNodeName(String) method
    
    Parameters:
    
    encodedLocalName - the node name to unescape
    
    Returns:
    
    the unescaped name
  - generateNodeName
```
public String generateNodeName(JCRNodeWrapper parent,
                               String nodeType)
```
    Generates the node name by using a configurable NameGenerationHelper implementation.
    
    Returns:
    
    a node name generated by configurable helper service
  - generateNodeName
```
public String generateNodeName(JCRNodeWrapper parent,
                               String defaultLanguage,
                               ExtendedNodeType nodeType,
                               String targetName)
```
    Generates the node name by using a configurable NameGenerationHelper implementation.
    
    Returns:
    
    a node name generated by configurable helper service
  - getFileExtensionIcons
```
public Map<String,String> getFileExtensionIcons()
```
    Returns a mapping between file extensions and corresponding icons.
    
    Returns:
    
    a mapping between file extensions and corresponding icons
  - getMimeTypes
```
public Map<String,List<String>> getMimeTypes()
```
    Return a map of mime types (file formats) to be available in the advanced search form.
    
    Returns:
    
    a map of mime types (file formats) to be available in the advanced search form
  - getNameGenerationHelper
```
public NameGenerationHelper getNameGenerationHelper()
```
  - getUnsupportedMarkForDeletionNodeTypes
```
public Set<String> getUnsupportedMarkForDeletionNodeTypes()
```
  - setNameGenerationHelper
```
public void setNameGenerationHelper(NameGenerationHelper nameGenerationHelper)
```
  - setUnsupportedMarkForDeletionNodeTypes
```
public void setUnsupportedMarkForDeletionNodeTypes(Set<String> unsupportedMarkForDeletionNodeTypes)
```
  - getHandleFallbackLocaleForPathPattern
```
public Pattern getHandleFallbackLocaleForPathPattern()
```
  - setHandleFallbackLocaleForPath
```
public void setHandleFallbackLocaleForPath(String handleFallbackLocaleForPath)
```
  - getRolesForNode
```
public static List<Map<String,Object>> getRolesForNode(JCRNodeWrapper node,
                                                       boolean includeInherited,
                                                       boolean expandGroups,
                                                       String roles,
                                                       int limit,
                                                       boolean latestFirst)
```
  - reverse
```
public static <T> Map<String,T> reverse(Map<String,T> orderedMap)
```
  - sqlEncode
```
public static String sqlEncode(String s)
```
    Encode a string to be used in a JCR SQL2 query by "escaping" the single quotes.
    
    Parameters:
    
    s - the string to be encoded
    
    Returns:
    
    encoded string to be used in a JCR SQL2 query
  - getParentWithAclInheritanceBroken
```
public static JCRNodeWrapper getParentWithAclInheritanceBroken(JCRNodeWrapper node)
                                                        throws javax.jcr.RepositoryException
```
    Returns the first parent of the specified node, which has the ACL inheritance broken. If not found, nullnull is returned.
    
    Parameters:
    
    node - the node to search parent for
    
    Returns:
    
    the first parent of the specified node, which has the ACL inheritance broken. If not found, nullnull is returned
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR errors
  - getMimeType
```
public static String getMimeType(String fileName)
```
    Detects the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor).
    
    Parameters:
    
    fileName - the name of the file to detect mime type for
    
    Returns:
    
    the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor)
  - getMimeType
```
public static String getMimeType(String fileName,
                                 String fallbackMimeType)
```
    Detects the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor). If the type cannot be detected, the provided fallback mime type is returned.
    
    Parameters:
    
    fileName - the name of the file to detect mime type for
    
    fallbackMimeType - the fallback mime-type to use if the type cannot be detected
    
    Returns:
    
    the mime-type for the specified file name, based on its extension (uses mime types, configured in the web.xml deployment descriptor). If the type cannot be detected, the provided fallback mime type is returned.
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    setServletContext in interface org.springframework.web.context.ServletContextAware
  - getUserPrivateFilesFolder
```
public JCRNodeWrapper getUserPrivateFilesFolder(JCRSessionWrapper session)
                                         throws javax.jcr.RepositoryException
```
    Returns the /files/private folder for the current session user, creating it if it does not exist yet.
    
    Parameters:
    
    session - current JCR session
    
    Returns:
    
    the JCR node, which corresponds to the /files/private folder for the current user
    
    Throws:
    
    javax.jcr.RepositoryException - in case of an error
  - getDefaultUserFolder
```
public JCRNodeWrapper getDefaultUserFolder(JCRSessionWrapper session,
                                           String path)
                                    throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - getDefaultUserFolder
```
public JCRNodeWrapper getDefaultUserFolder(JCRSessionWrapper session,
                                           String path,
                                           boolean saveIfCreate)
                                    throws javax.jcr.RepositoryException
```
    Retrieves the default user folder found at the specified path, creating it (and all intermediate folders) if needed, saving the session if requested.
    
    Parameters:
    
    session - the session with which to access the JCR data
    
    path - the path of the default user folder to retrieve, if path is empty or null the user's node is returned
    
    saveIfCreate - true if we want the session to be immediately saved, false if the client code will save the session to commit the changes
    
    Returns:
    
    the JCR node associated with the requested default user folder
    
    Throws:
    
    javax.jcr.RepositoryException - in case of JCR-related errors
  - isUserMemberOfGroup
```
public static boolean isUserMemberOfGroup(String siteKey,
                                          String groupName,
                                          String userName,
                                          String userRealm,
                                          boolean isRoot)
```
    Check if user is member of the given group
    
    Parameters:
    
    siteKey - the site key
    
    groupName - the group name
    
    userName - the user name
    
    userRealm - hte user realm
    
    isRoot - is the user root ?
    
    Returns:
    
    true in case the user is member of the group
  - needVersion
```
public static boolean needVersion(JCRNodeWrapper node,
                                  Set<String> versionedTypes)
                           throws javax.jcr.RepositoryException
```
    this method checks if the node type is versionable from a jahia property
    
    Parameters:
    
    node - the node we want to version
    
    versionedTypes - the jahia property with types to version
    
    Returns:
    
    true if the node can be versioned, false if it can't
    
    Throws:
    
    javax.jcr.RepositoryException
  - splitAndUnify
```
public static Set<String> splitAndUnify(String input,
                                        String separator)
```
    this method splits a String with a separator and put all its elements in a Set
    
    Parameters:
    
    input - String containing different inputs with a separator
    
    separator - string specifying the separator to split with
    
    Returns:
    
    a Set with the inputs

Class JCRContentUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLON_PATTERN

NODE_TYPE_NAME_COMPARATOR

Constructor Detail

JCRContentUtils

Method Detail

getInstance

callDataStoreGarbageCollector

check

clearAllLocks

createValue

createValues

decodeJCRNamePrefix

deleteJackrabbitIndexes

downloadFileContent

downloadFileContent

encodeJCRNamePrefix

escapeLocalNodeName

escapeNodePath

findAvailableNodeName

findAvailableNodeName

findDisplayableNode

findDisplayableNode

generateNodeName

generateNodeName

getAssignableMixins

getChildrenOfType

getChildrenOfType

getContentNodeName

getContentObjectPath

getDescendantNodes

getDisplayLabel

getExpandedName

getJCRName

getIconWithContext

getIcon

getIcon

getIconWithContext

getIconsFolder

getLockType

getLockTypes

getNameFromPath

getNodes

getNodes

getOrAddPath

getParentJCRPath

getParentOfType

getPathFolder

getPropertyDefinition

getPropertyDefinition

getPropertyDefSelector

getSiteKey

getSystemSitePath

getValue

hasPermission

importSkeletons

importSkeletons

importSkeletons

isADisplayableNode

isMimeTypeGroup

isMimeTypeGroup

isLanguageInvalid

isLockedAndCannotBeEdited

isNodeType

isNodeType

isNodeType

isNotJcrUuid

isValidFilename

isValidWorkspace

isValidWorkspace

registerNamespace

replaceColon

size

splitJCRPath

stringToJCRPathExp