ResourceLocatorUtil (Sitevision API)

```
@Requireable(value="ResourceLocatorUtil")
public interface ResourceLocatorUtil
```
Utility interface for locating resources.
An instance of the Sitevision class implementing this interface can be obtained via Utils.getResourceLocatorUtil(). See Utils for how to obtain an instance of the Utils interface.

Author:

Magnus Lövgren

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Node`	`getAddonRepository()` Gets the addon repository for the site of current node.
`Node`	`getAliasRepository()` Gets the alias repository (sv:aliasRepository) for the site of current node.
`Node`	`getColorRepository()` Gets the color repository for the site of current node.
`Node`	`getCssRuleRepository()` Gets the css rule repository (sv:cssRuleRepository) for the site of current node.
`Node`	`getDecorationRepository()` Gets the decoration repository for the site of current node.
`Node`	`getDefaultImageRepository()` Gets the default image repository for the site of current node.
`Node`	`getDirectoryRepository()` Gets the LDAP directories repository for the site of current node
`Node`	`getExternalTopicIntegrationRepository()` Gets the external topic integration repository (sv:externalTopicIntegrationRepository) for the site of current node.
`Node`	`getFileRepository()` Gets the file repository for the site of current node.
`Node`	`getFontRepository()` Gets the font repository for the site of current node.
`Node`	`getIconRepository()` Gets the icon repository for the site of current node.
`Node`	`getImageFilterRepository()` Gets the image filter repository (sv:imageFilterRepository) for the site of current node.
`Node`	`getImageRepository()` Gets the image repository for the site of current node.
`Node`	`getIndexRepository()` Gets the index repository for the site of current node.
`Node`	`getListStyleRepository()` Gets the list style repository for the site of current node.
`Node`	`getLlmConfigurationRepository()` Gets the LLM configuration repository (sv:llmConfigurationRepository) for the site of current node.
`Node`	`getLocalFileRepository()` Gets the local file repository for current page node.
`Node`	`getLocalFileRepository(Node aNode)` Gets the local file repository for a specified page node.
`Node`	`getLocalImageRepository()` Gets the local image repository for current page node.
`Node`	`getLocalImageRepository(Node aNode)` Gets the local image repository for a specified page node.
`Node`	`getMetadataDefinitionTemplateRepository()` Gets the metadata definition template repository (sv:metadataDefinitionTemplateRepository) for the site of current node.
`Node`	`getModuleElementDraftRepository()` Gets the module element draft repository for the site of current node.
`Node`	`getModuleElementFileRepository()` Gets the module element file repository for current module element node.
`Node`	`getModuleElementFileRepository(Node aNode)` Gets the module element file repository for a specified module element node.
`Node`	`getModuleElementImageRepository()` Gets the module element image repository for current module element node.
`Node`	`getModuleElementImageRepository(Node aNode)` Gets the module element image repository for a specified module element node.
`Node`	`getModuleElementRepository()` Gets the module element repository for the site of current node.
`Node`	`getNamedReferenceRepository()` Gets the named reference repository for the site of current node.
`Node`	`getNodeByIdentifier(String anIdentifier)` Gets a `Node` given its identifier.
`Node`	`getNodeByPath(String anAbsolutePath)` Gets a `Node` given its absolute path.
`Node`	`getNodeByUrl(String anUrl)` Gets a `Node` given its URL
`String`	`getNodeId(Object aInternalObject)` Deprecated. This is a legacy method for really old Velocity templates that uses internal Sitevision objects.
`Node`	`getOAuth2ConfigurationRepository()` Gets the OAuth2 configuration repository (sv:oAuth2ConfigurationRepository) for the site of current node.
`Node`	`getPageCommentRepository()` Gets the page comment repository for current page node.
`Node`	`getPageCommentRepository(Node aNode)` Gets the page comment repository for a specified page node.
`Node`	`getPersonalFileRepository(Node aNode)` Gets the personal file repository for a specified node.
`Node`	`getPersonalImageRepository(Node aNode)` Gets the personal image repository for a specified node.
`Node`	`getPrincipalRepository()` Gets the principal repository (sv:principalRepository) for the site of current node.
`Node`	`getResponsiveBreakpointRepository()` Gets the responsive breakpoint repository (sv:responsiveBreakpointRepository) for the site of current node.
`Node`	`getRoleRepository()` Gets the role repository (sv:roleRepository) for the site of current node.
`Node`	`getRootNode()` Gets the JCR Root Node for current Site.
`Node`	`getRssFeedRepository()` Gets the RSS feed repository for the site of current node.
`Node`	`getSite()` Gets current site (i.e. the site node of the page for the currently executing portlet).
`Node`	`getSiteCookieRepository()` Gets the site cookie repository (sv:siteCookieRepository) for the site of current node.
`Node`	`getSitePage()` Gets current site page (i.e. the site's start page node of the page for the currently executing portlet).
`Node`	`getTagGroupRepository()` Gets the tag group repository (sv:tagGroupRepository) for the site of current node.
`Node`	`getTemplateRepository()` Gets the template repository for the site of current node.
`Node`	`getTopicRepository()` Gets the topic repository (sv:topicRepository) for the site of current node.
`Node`	`getTrashcan()` Gets the trashcan (sv:trashcan) for the site of current node.
`Node`	`getVirtualGroupRepository()` Gets the virtual group repository (sv:virtualGroupRepository) for the site of current node.
`Node`	`getWorkStatusTemplateRepository()` Gets the work status template repository (sv:workStatusTemplateRepository) for the site of current node.

- Method Detail
  - getRootNode
```
Node getRootNode()
```
    Gets the JCR Root Node for current Site.
    This is a non-throwing convenience for the Session.getRootNode() method.
    
    Returns:
    
    the JCR Root Node, or null if indeterminable
    
    Since:
    
    Sitevision 2023.11.1
  - getSite
```
Node getSite()
```
    Gets current site (i.e. the site node of the page for the currently executing portlet).
    Note! If you are interested in the actual start page, you should use the getSitePage() method.
    
    Returns:
    
    current site Node, or null if indeterminable (e.g. current portlet and/or current page is not bound to any site)
    
    See Also:
    
    getSitePage()
  - getSitePage
```
Node getSitePage()
```
    Gets current site page (i.e. the site's start page node of the page for the currently executing portlet).
    Note! If you are interested in the actual site, you should use the getSite() method.
    
    Returns:
    
    current site page Node, or null if indeterminable (e.g. current portlet and/or current page is not bound to any site)
    
    See Also:
    
    getSite()
  - getColorRepository
```
Node getColorRepository()
```
    Gets the color repository for the site of current node.
    
    Returns:
    
    the color repository for the site of current node, or null if indeterminable
  - getFontRepository
```
Node getFontRepository()
```
    Gets the font repository for the site of current node.
    
    Returns:
    
    the font repository for the site of current node, or null if indeterminable
  - getDecorationRepository
```
Node getDecorationRepository()
```
    Gets the decoration repository for the site of current node.
    
    Returns:
    
    the decoration repository for the site of current node, or null if indeterminable
  - getFileRepository
```
Node getFileRepository()
```
    Gets the file repository for the site of current node.
    
    Returns:
    
    the global file repository for the site of current node, or null if indeterminable
  - getLocalFileRepository
```
Node getLocalFileRepository()
```
    Gets the local file repository for current page node.
    This is a convenience for getLocalFileRepository(Node) that uses PortletContextUtil.getCurrentPage() to get current page node.
    
    Returns:
    
    the local file repository for current node, or null if indeterminable
  - getLocalFileRepository
```
Node getLocalFileRepository(Node aNode)
```
    Gets the local file repository for a specified page node.
    
    Parameters:
    
    aNode - a node that has a local file repository (typically a sv:page or sv:article)
    
    Returns:
    
    the local file repository for aNode, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.4
  - getImageRepository
```
Node getImageRepository()
```
    Gets the image repository for the site of current node.
    
    Returns:
    
    the global image repository for the site of current node, or null if indeterminable
  - getLocalImageRepository
```
Node getLocalImageRepository()
```
    Gets the local image repository for current page node.
    This is a convenience for getLocalImageRepository(Node) that uses PortletContextUtil.getCurrentPage() to get current page node.
    
    Returns:
    
    the local image repository for current node, or null if indeterminable
  - getLocalImageRepository
```
Node getLocalImageRepository(Node aNode)
```
    Gets the local image repository for a specified page node.
    
    Parameters:
    
    aNode - a node that has a local image repository (typically a sv:page or sv:article)
    
    Returns:
    
    the local image repository for aNode, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.4
  - getPageCommentRepository
```
Node getPageCommentRepository()
```
    Gets the page comment repository for current page node.
    This is a convenience for getPageCommentRepository(Node) that uses PortletContextUtil.getCurrentPage() to get current page node.
    
    Returns:
    
    the page comment repository for current page node, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.4
  - getPageCommentRepository
```
Node getPageCommentRepository(Node aNode)
```
    Gets the page comment repository for a specified page node.
    
    Parameters:
    
    aNode - a node that has a page comment repository (typically a sv:page or sv:article)
    
    Returns:
    
    the page comment repository for aNode, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.4
  - getPersonalFileRepository
```
Node getPersonalFileRepository(Node aNode)
```
    Gets the personal file repository for a specified node.
    A personal file repository contains files that belongs to a sv:collaborationGroup (i.e. "group files") or a sv:userIdentity (e.g. files attached when posting timeline entries).
    
    Convenience note! This method will extract and use the corresponding sv:collaborationGroup if the aNode argument is a sv:collaborationGroupPage. It will also try to extract and use the corresponding sv:userIdentity if the aNode argument is a sv:user.
    
    Parameters:
    
    aNode - a node that has a personal file repository (typically a sv:collaborationGroup or sv:userIdentity)
    
    Returns:
    
    the personal file repository for aNode, or null if indeterminable.
    
    Since:
    
    Sitevision 3.6.4
  - getPersonalImageRepository
```
Node getPersonalImageRepository(Node aNode)
```
    Gets the personal image repository for a specified node.
    A personal image repository contains images that belongs to a sv:collaborationGroup or a sv:userIdentity (e.g. profile image).
    
    Convenience note! This method will extract and use the corresponding sv:collaborationGroup if the aNode argument is a sv:collaborationGroupPage. It will also try to extract and use the corresponding sv:userIdentity if the aNode argument is a sv:user.
    
    Parameters:
    
    aNode - a node that has a personal image repository (typically a sv:collaborationGroup or sv:userIdentity)
    
    Returns:
    
    the personal image repository for aNode, or null if indeterminable.
    
    Since:
    
    Sitevision 3.6.4
  - getIconRepository
```
Node getIconRepository()
```
    Gets the icon repository for the site of current node.
    The icon repository contains all site-specific file icon nodes.
    
    Returns:
    
    the icon repository for the site of current node, or null if indeterminable
  - getIndexRepository
```
Node getIndexRepository()
```
    Gets the index repository for the site of current node.
    Tip! The IndexUtil utility can be used for easy index lookup.
    
    Returns:
    
    the index repository for the site of current node, or null if indeterminable
    
    Since:
    
    Sitevision 3.6
  - getDefaultImageRepository
```
Node getDefaultImageRepository()
```
    Gets the default image repository for the site of current node.
    The default image repository contains system/server-specific images/icons.
    
    Returns:
    
    the default image repository for the site of current node, or null if indeterminable
  - getDirectoryRepository
```
Node getDirectoryRepository()
```
    Gets the LDAP directories repository for the site of current node
    
    Returns:
    
    the LDAP directories repository, or null if indeterminable
  - getNodeByIdentifier
```
Node getNodeByIdentifier(String anIdentifier)
```
    Gets a Node given its identifier.
    Note! This is mere a convenience alias for Session.getNodeByIdentifier(String) but unlike the original, this method returns null instead of throwing an exception if given identifier can't be matched to an existing node.
    
    Parameters:
    
    anIdentifier - a Node identifier
    
    Returns:
    
    the corresponding Node or null
    
    Since:
    
    Sitevision 3.6.5
  - getNodeByPath
```
Node getNodeByPath(String anAbsolutePath)
```
    Gets a Node given its absolute path.
    Note! This is mere a convenience alias for Session.getNode(String) but unlike the original, this method returns null instead of throwing an exception if given absolute path can't be matched to an existing node.
    
    Parameters:
    
    anAbsolutePath - an absolute path
    
    Returns:
    
    the corresponding Node or null
    
    Since:
    
    Sitevision 3.6.5
  - getNodeByUrl
```
Node getNodeByUrl(String anUrl)
```
    Gets a Node given its URL
    
    Parameters:
    
    anUrl - an url pointing to the resource (e.g. page, portlet, file, image)
    
    Returns:
    
    the corresponding Node or null
    
    Since:
    
    Sitevision 2.6.1
  - getNodeId
```
@Deprecated
String getNodeId(Object aInternalObject)
```
    Deprecated. This is a legacy method for really old Velocity templates that uses internal Sitevision objects.
    
    Resolves a potential JCR Node identifier for an internal Sitevision object.
    
    This is a deprecated legacy method for conversions between internal Sitevision objects and API objects (javax.jcr.Node). This behaviour is typically only applicable in really old Velocity templates that was released prior to the API (i.e. templates released before 2008). This method is not intended for javax.jcr.Node objects! To get the "id" of a javax.jcr.Node - use the Node.getIdentifier() method.
    
    Parameters:
    
    aInternalObject - a internal Sitevision object
    
    Returns:
    
    a potential JCR Node identifier, or null if aInternalObject is null. The identifier for the sv:sitePage Node is returned if aInternalObject corresponds to the "site". Note that there are no guarantee that returned value actually is a valid JCR Node identifier
    
    Since:
    
    Sitevision 2.6.1_01
  - getTemplateRepository
```
Node getTemplateRepository()
```
    Gets the template repository for the site of current node.
    
    Returns:
    
    the template repository for the site of current node, or null if indeterminable
    
    Since:
    
    Sitevision 2.6.2
  - getRssFeedRepository
```
Node getRssFeedRepository()
```
    Gets the RSS feed repository for the site of current node.
    
    Returns:
    
    the RSS feed repository for the site of current node, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.2
  - getListStyleRepository
```
Node getListStyleRepository()
```
    Gets the list style repository for the site of current node.
    
    Returns:
    
    the list style repository for the site of current node, or null if indeterminable
    
    Since:
    
    Sitevision 3.6.4
  - getModuleElementDraftRepository
```
Node getModuleElementDraftRepository()
```
    Gets the module element draft repository for the site of current node.
    
    Returns:
    
    the module element draft repository, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getModuleElementRepository
```
Node getModuleElementRepository()
```
    Gets the module element repository for the site of current node.
    
    Returns:
    
    the module element repository, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getModuleElementFileRepository
```
Node getModuleElementFileRepository()
```
    Gets the module element file repository for current module element node.
    This is a convenience for getModuleElementFileRepository(Node) that uses PortletContextUtil.getCurrentModuleElement() to get current module element node.
    
    Returns:
    
    the module element file repository for current module element, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getModuleElementFileRepository
```
Node getModuleElementFileRepository(Node aNode)
```
    Gets the module element file repository for a specified module element node.
    
    Parameters:
    
    aNode - a node that has a module element file repository (typically a sv:moduleElementDraft or sv:moduleElement)
    
    Returns:
    
    the module element file repository for aNode, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getModuleElementImageRepository
```
Node getModuleElementImageRepository()
```
    Gets the module element image repository for current module element node.
    This is a convenience for getModuleElementImageRepository(Node) that uses PortletContextUtil.getCurrentModuleElement() to get current module element node.
    
    Returns:
    
    the module element image repository for current module element, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getModuleElementImageRepository
```
Node getModuleElementImageRepository(Node aNode)
```
    Gets the module element image repository for a specified module element node.
    
    Parameters:
    
    aNode - a node that has a module element image repository (typically a sv:moduleElementDraft or sv:moduleElement)
    
    Returns:
    
    the module element image repository for aNode, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getAddonRepository
```
Node getAddonRepository()
```
    Gets the addon repository for the site of current node.
    
    Returns:
    
    the addon repository, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2
  - getNamedReferenceRepository
```
Node getNamedReferenceRepository()
```
    Gets the named reference repository for the site of current node.
    
    Returns:
    
    the named reference repository, or null if indeterminable.
    
    Since:
    
    Sitevision 4.2.2
  - getRoleRepository
```
Node getRoleRepository()
```
    Gets the role repository (sv:roleRepository) for the site of current node.
    
    Returns:
    
    the role repository, or null if indeterminable.
    
    Since:
    
    Sitevision 5
    
    See Also:
    
    RoleUtil
  - getVirtualGroupRepository
```
Node getVirtualGroupRepository()
```
    Gets the virtual group repository (sv:virtualGroupRepository) for the site of current node.
    
    Returns:
    
    the virtual group repository, or null if indeterminable.
    
    Since:
    
    Sitevision 5
  - getTagGroupRepository
```
Node getTagGroupRepository()
```
    Gets the tag group repository (sv:tagGroupRepository) for the site of current node.
    
    Returns:
    
    the tag group repository, or null if indeterminable.
    
    Since:
    
    Sitevision 5
  - getResponsiveBreakpointRepository
```
Node getResponsiveBreakpointRepository()
```
    Gets the responsive breakpoint repository (sv:responsiveBreakpointRepository) for the site of current node.
    
    Returns:
    
    the responsive breakpoint repository, or null if indeterminable.
    
    Since:
    
    Sitevision 6.2
  - getTopicRepository
```
Node getTopicRepository()
```
    Gets the topic repository (sv:topicRepository) for the site of current node.
    
    Returns:
    
    the topic repository, or null if indeterminable.
    
    Since:
    
    Sitevision 7
  - getExternalTopicIntegrationRepository
```
Node getExternalTopicIntegrationRepository()
```
    Gets the external topic integration repository (sv:externalTopicIntegrationRepository) for the site of current node.
    
    Returns:
    
    the external topic integration repository, or null if indeterminable.
    
    Since:
    
    Sitevision 7
  - getOAuth2ConfigurationRepository
```
Node getOAuth2ConfigurationRepository()
```
    Gets the OAuth2 configuration repository (sv:oAuth2ConfigurationRepository) for the site of current node.
    
    Returns:
    
    the OAuth2 configuration repository, or null if indeterminable.
    
    Since:
    
    Sitevision 7
  - getMetadataDefinitionTemplateRepository
```
Node getMetadataDefinitionTemplateRepository()
```
    Gets the metadata definition template repository (sv:metadataDefinitionTemplateRepository) for the site of current node.
    
    Returns:
    
    the metadata definition template repository, or null if indeterminable.
    
    Since:
    
    Sitevision 8.1
  - getTrashcan
```
Node getTrashcan()
```
    Gets the trashcan (sv:trashcan) for the site of current node.
    
    Returns:
    
    the trashcan, or null if indeterminable.
    
    Since:
    
    Sitevision 8.1
    
    See Also:
    
    TrashcanUtil
  - getPrincipalRepository
```
Node getPrincipalRepository()
```
    Gets the principal repository (sv:principalRepository) for the site of current node.
    
    Returns:
    
    the principal repository, or null if indeterminable.
    
    Since:
    
    Sitevision 8.2
  - getAliasRepository
```
Node getAliasRepository()
```
    Gets the alias repository (sv:aliasRepository) for the site of current node.
    
    Returns:
    
    the alias repository, or null if indeterminable.
    
    Since:
    
    Sitevision 8.2
  - getSiteCookieRepository
```
Node getSiteCookieRepository()
```
    Gets the site cookie repository (sv:siteCookieRepository) for the site of current node.
    
    Returns:
    
    the site cookie repository, or null if indeterminable.
    
    Since:
    
    Sitevision 9.1
    
    See Also:
    
    SiteCookieUtil
  - getImageFilterRepository
```
Node getImageFilterRepository()
```
    Gets the image filter repository (sv:imageFilterRepository) for the site of current node.
    
    Returns:
    
    the image filter repository, or null if indeterminable.
    
    Since:
    
    Sitevision 2023.09.1
  - getWorkStatusTemplateRepository
```
Node getWorkStatusTemplateRepository()
```
    Gets the work status template repository (sv:workStatusTemplateRepository) for the site of current node.
    
    Returns:
    
    the work status template repository, or null if indeterminable.
    
    Since:
    
    Sitevision 2023.09.2
  - getCssRuleRepository
```
Node getCssRuleRepository()
```
    Gets the css rule repository (sv:cssRuleRepository) for the site of current node.
    
    Returns:
    
    the css rule repository, or null if indeterminable.
    
    Since:
    
    Sitevision 2024.04.2
  - getLlmConfigurationRepository
```
Node getLlmConfigurationRepository()
```
    Gets the LLM configuration repository (sv:llmConfigurationRepository) for the site of current node.
    
    Returns:
    
    the LLM configuration repository, or null if indeterminable.
    
    Since:
    
    Sitevision 2024.08.1

Sitevision - Portal and Content Management Made Easy
Sitevision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).

Interface ResourceLocatorUtil

Method Summary

Method Detail

getRootNode

getSite

getSitePage

getColorRepository

getFontRepository

getDecorationRepository

getFileRepository

getLocalFileRepository

getLocalFileRepository

getImageRepository

getLocalImageRepository

getLocalImageRepository

getPageCommentRepository

getPageCommentRepository

getPersonalFileRepository

getPersonalImageRepository

getIconRepository

getIndexRepository

getDefaultImageRepository

getDirectoryRepository

getNodeByIdentifier

getNodeByPath

getNodeByUrl

getNodeId

getTemplateRepository

getRssFeedRepository

getListStyleRepository

getModuleElementDraftRepository

getModuleElementRepository

getModuleElementFileRepository

getModuleElementFileRepository

getModuleElementImageRepository

getModuleElementImageRepository

getAddonRepository

getNamedReferenceRepository

getRoleRepository

getVirtualGroupRepository

getTagGroupRepository

getResponsiveBreakpointRepository

getTopicRepository

getExternalTopicIntegrationRepository

getOAuth2ConfigurationRepository

getMetadataDefinitionTemplateRepository

getTrashcan

getPrincipalRepository

getAliasRepository

getSiteCookieRepository

getImageFilterRepository

getWorkStatusTemplateRepository

getCssRuleRepository

getLlmConfigurationRepository