AmetysXSLTHelper (Ametys 4.0.x

java.lang.Object
- org.ametys.core.util.AmetysXSLTHelper
- - org.ametys.cms.transformation.xslt.AmetysXSLTHelper
  - - org.ametys.web.transformation.xslt.AmetysXSLTHelper

All Implemented Interfaces:

Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

UserXSLTHelper
```
public class AmetysXSLTHelper
extends AmetysXSLTHelper
```
Helper component to be used from XSL stylesheets.

Field Summary

Fields
Modifier and Type	Field and Description
`private static URIPrefixHandler`	`_prefixHandler`
`private static RenderingContextHandler`	`_renderingContextHandler`
`private static RightManager`	`_rightManager`
`private static ServiceExtensionPoint`	`_serviceEP`
`private static SiteConfigurationExtensionPoint`	`_siteConf`
`private static SiteManager`	`_siteManager`
`private static SourceResolver`	`_sourceResolver`

Fields inherited from class org.ametys.cms.transformation.xslt.AmetysXSLTHelper
_ametysObjectResolver, _context, _cTypeExtensionPoint, _logger, _tagProviderExtPt

Fields inherited from class org.ametys.core.util.AmetysXSLTHelper
_currentUserProvider, _groupManager, _i18nUtils, _userHelper, _userManager, _versionHandler

Constructor Summary

Constructors
Constructor and Description

AmetysXSLTHelper()

Constructors
Constructor and Description
`AmetysXSLTHelper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static String`	`_convertTagName(String name)`
`private static String`	`_getMetadata(CompositeMetadata cm, String metadataName)`
`private static Page`	`_getPage(String id)`
`private static Page`	`_getPage(String sitename, String lang, String path)`
`private static Map<String,MapElement.MapNode>`	`_getParameterValue(String paramName, CompositeMetadata parentMetadata, ServiceParameterOrRepeater paramDef, String defaultValue)`
`private static String`	`_getResourceBase64(FileSource source)` Get the base 64 encoding for the given source
`private static String`	`_getResourceURL(Request request, Site site, String resourcePath)`
`static String`	`absoluteSiteUriPrefix()` Returns the absolute URI prefix corresponding to the current site, depending on the rendering context.
`static String`	`absoluteSiteUriPrefix(String siteName)` Returns the absolute URI prefix corresponding to the given site, depending on the rendering context.
`static String`	`absoluteUriPrefix()` Returns the absolute URI prefix, depending on the rendering context.
`static NodeList`	`accessibleReferencedPages(String contentId)` Returns the id of pages referencing the content and for which the Front-office user can access
`static NodeList`	`breadcrumb()` Computes the breadcrumb of the current page.
`static NodeList`	`findPagesIdsByTag(String tag)` Returns the ids of the pages
`static NodeList`	`findPagesIdsByTag(String sitename, String lang, String tag)` Returns the ids of the pages
`static boolean`	`isCacheable()` Determines if the current zone item or (if there is no current zone item) the current page is cacheable This method is only valid for a page.
`static String`	`lang()` Returns the current sitemap name.
`static String`	`lang(String pageId)` Returns the current sitemap name.
`static boolean`	`pageHasRestrictedAccess(String pageId)` Returns true if the given page has restricted access.
`static boolean`	`pageHasRestrictedAccess(String sitename, String lang, String path)` Returns true if the given page has restricted access.
`static String`	`pageId()` Returns the id of the current page.
`static boolean`	`pageIsVisible(String pageId)` Returns true if the given page is visible into navigation elements
`static boolean`	`pageIsVisible(String sitename, String lang, String path)` Returns true if the given page is visible into navigation elements
`static String`	`pageLongTitle(String pageId)` Get the long title of a page
`static String`	`pageLongTitle(String sitename, String lang, String path)` Get the long title of a page
`static String`	`pageMetadata(String pageId, String metadataName)` Get the meta of a page
`static String`	`pageMetadata(String sitename, String lang, String path, String metadataName)` Get the meta of a page
`static String`	`pagePath()` Returns the path of the current page, relative to the sitemap's root.
`static String`	`pagePath(String pageId)` Returns the path in sitemap of a page
`static String`	`pageSiteName(String pageId)` Get the site name of a page.
`static String`	`pageTitle(String pageId)` Get the title of a page.
`static String`	`pageTitle(String sitename, String lang, String path)` Get the title of a page.
`static String`	`pluginImageBase64(String plugin, String path)` Computes the base 64 representation of the image at the specified path in the given plugin.
`static String`	`pluginResourceURL(String plugin, String path)` Computes the URI for the given resource in the given plugin. If the URI is requested by the front-office, it will be absolutized.
`static NodeList`	`referencedPages(String contentId)` Returns the id of pages referencing the content
`static String`	`renderingContext()` Returns the current `RenderingContext`.
`static Node`	`resourcesById(String collectionId)` Returns a DOM `Element` representing files and folder of the resources explorer, under the `ResourceCollection` corresponding to the given id.
`static Node`	`resourcesByPath(String path)` Returns a DOM `Element` representing files and folder of the resources explorer, under the `ResourceCollection` corresponding to the given path.
`void`	`service(ServiceManager manager)`
`static Node`	`serviceParameter(String parameter)` Returns the value of the given parameter for the current service, or the empty string if the parameter does not exist.
`static Node`	`serviceParameter(String parameter, String defaultValue)` Returns the value of the given parameter for the current service, or the provided default value if the parameter does not exist.
`static Node`	`serviceParameters()` Get the service parameters as a `Node`.
`static String`	`site()` Returns the current site
`static String`	`site(String pageId)` Returns the current site
`static Node`	`sitemap()` Return the current sitemap as a `Node`.
`static Node`	`sitemap(String pageId)` Return the subsitemap of the given page as a `Node`.
`static String`	`siteParameter(String parameter)` Return the value of a site parameter as a String.
`static String`	`siteParameter(String siteName, String parameter)` Return the value of a site parameter as a String.
`static String`	`siteUriPrefix()` Returns the URI prefix corresponding to the current site, depending on the rendering context.
`static String`	`skin()` Returns the current skin name.
`static String`	`skinBoundedImageURL(String path, int maxHeight, int maxWidth)` Computes the URI for the given image with a given heigth and width in the current site's skin. If the URI is requested by the front-office, it will be absolutized.
`static String`	`skinImageBase64(String path)` Computes the base 64 representation of the image at the specified path.
`static String`	`skinImageURL(String path, int height, int width)` Computes the URI for the given image with a given heigth and width in the current site's skin. If the URI is requested by the front-office, it will be absolutized.
`static Node`	`skinResources(String path)` Returns a DOM `Element` representing files and folder of a skin directory.
`static String`	`skinURL(String path)` Computes the URI for the given resource in the current site's skin. If the URI is requested by the front-office, it will be absolutized.
`static String`	`template()` Returns the current template name.
`static String`	`templateURL(String path)` Computes the URI for the given resource in the current template. If the URI is requested by the front-office, it will be absolutized.
`static String`	`uriPrefix()` Returns the current URI prefix, depending on the rendering context.
`static String`	`zone(String defaultValue)` Return the name of the zone beeing handled

Methods inherited from class org.ametys.cms.transformation.xslt.AmetysXSLTHelper
contentAttachments, contentAttachments, contentMetadata, contentMixinTypes, contentTags, contentTypes, contentTypeTags, contextualize, enableLogging, tagDescription, tagLabel, tagParent, tagPath, tagVisibility

Methods inherited from class org.ametys.core.util.AmetysXSLTHelper
absoluteUriPrefix, config, escapeJS, getAbsoluteUriPrefix, getUriPrefix, getWorkspaceName, getWorkspacePrefix, groups, groups, isDeveloperMode, requestParameter, splitText, splitText, translate, translate, uriPrefix, urlEncode, user, versions, workspaceName, workspacePrefix, workspaceTheme, workspaceThemeURL

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

- Field Detail
  - _siteManager
```
private static SiteManager _siteManager
```
  - _renderingContextHandler
```
private static RenderingContextHandler _renderingContextHandler
```
  - _siteConf
```
private static SiteConfigurationExtensionPoint _siteConf
```
  - _rightManager
```
private static RightManager _rightManager
```
  - _prefixHandler
```
private static URIPrefixHandler _prefixHandler
```
  - _sourceResolver
```
private static SourceResolver _sourceResolver
```
  - _serviceEP
```
private static ServiceExtensionPoint _serviceEP
```
- Constructor Detail
  - AmetysXSLTHelper
```
public AmetysXSLTHelper()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class AmetysXSLTHelper
    
    Throws:
    
    ServiceException
  - uriPrefix
```
public static String uriPrefix()
```
    Returns the current URI prefix, depending on the rendering context.
    
    Returns:
    
    the current URI prefix.
  - siteUriPrefix
```
public static String siteUriPrefix()
```
    Returns the URI prefix corresponding to the current site, depending on the rendering context.
    
    Returns:
    
    the URI prefix corresponding to the current site.
  - absoluteUriPrefix
```
public static String absoluteUriPrefix()
```
    Returns the absolute URI prefix, depending on the rendering context.
    
    Returns:
    
    the absolute URI prefix.
  - absoluteSiteUriPrefix
```
public static String absoluteSiteUriPrefix()
```
    Returns the absolute URI prefix corresponding to the current site, depending on the rendering context.
    
    Returns:
    
    the absolute URI prefix corresponding to the current site.
  - absoluteSiteUriPrefix
```
public static String absoluteSiteUriPrefix(String siteName)
```
    Returns the absolute URI prefix corresponding to the given site, depending on the rendering context.
    
    Parameters:
    
    siteName - The site name. Can be null to get the current site.
    
    Returns:
    
    the absolute URI prefix corresponding to the current site.
  - skin
```
public static String skin()
```
    Returns the current skin name.
    
    Returns:
    
    the current skin name.
  - template
```
public static String template()
```
    Returns the current template name.
    
    Returns:
    
    the current template name.
  - lang
```
public static String lang()
```
    Returns the current sitemap name.
    
    Returns:
    
    the current sitemap name.
  - lang
```
public static String lang(String pageId)
```
    Returns the current sitemap name.
    
    Parameters:
    
    pageId - The page identifier to get sitemap on
    
    Returns:
    
    the current sitemap name.
  - skinURL
```
public static String skinURL(String path)
```
    Computes the URI for the given resource in the current site's skin.
    If the URI is requested by the front-office, it will be absolutized.
    
    Parameters:
    
    path - the resource path.
    
    Returns:
    
    the URI for the given resource.
  - skinImageURL
```
public static String skinImageURL(String path,
                                  int height,
                                  int width)
```
    Computes the URI for the given image with a given heigth and width in the current site's skin.
    If the URI is requested by the front-office, it will be absolutized.
    
    Parameters:
    
    path - the resource path
    
    height - the height for the resource to get
    
    width - the width for the resource to get
    
    Returns:
    
    the URI of the given resource
  - skinImageBase64
```
public static String skinImageBase64(String path)
                              throws IOException
```
    Computes the base 64 representation of the image at the specified path.
    
    Parameters:
    
    path - the path of the image
    
    Returns:
    
    the base 64-encoded image
    
    Throws:
    
    IOException - if an error occurs while trying to get the file
  - skinBoundedImageURL
```
public static String skinBoundedImageURL(String path,
                                         int maxHeight,
                                         int maxWidth)
```
    Computes the URI for the given image with a given heigth and width in the current site's skin.
    If the URI is requested by the front-office, it will be absolutized.
    
    Parameters:
    
    path - the resource path
    
    maxHeight - the maximum height for the resource to get
    
    maxWidth - the maximum width for the resource to get
    
    Returns:
    
    the URI of the given resource
  - templateURL
```
public static String templateURL(String path)
```
    Computes the URI for the given resource in the current template.
    If the URI is requested by the front-office, it will be absolutized.
    
    Parameters:
    
    path - the resource path.
    
    Returns:
    
    the URI for the given resource.
  - pluginResourceURL
```
public static String pluginResourceURL(String plugin,
                                       String path)
```
    Computes the URI for the given resource in the given plugin.
    If the URI is requested by the front-office, it will be absolutized.
    
    Parameters:
    
    plugin - the plugin name.
    
    path - the resource path.
    
    Returns:
    
    the URI for the given resource.
  - pluginImageBase64
```
public static String pluginImageBase64(String plugin,
                                       String path)
                                throws MalformedURLException,
                                       IOException
```
    Computes the base 64 representation of the image at the specified path in the given plugin.
    
    Parameters:
    
    plugin - the plugin's name.
    
    path - the resource path.
    
    Returns:
    
    the base 64 encoding for the given resource.
    
    Throws:
    
    IOException - if an error occurs when trying to get the file
    
    MalformedURLException - if the url is invalid
  - _getResourceURL
```
private static String _getResourceURL(Request request,
                                      Site site,
                                      String resourcePath)
```
  - _getResourceBase64
```
private static String _getResourceBase64(FileSource source)
```
    Get the base 64 encoding for the given source
    
    Parameters:
    
    source - the source
    
    Returns:
    
    the base 64 encoding of the source
  - renderingContext
```
public static String renderingContext()
```
    Returns the current RenderingContext.
    
    Returns:
    
    the current RenderingContext.
  - zone
```
public static String zone(String defaultValue)
```
    Return the name of the zone beeing handled
    
    Parameters:
    
    defaultValue - If no page is handled currently, this value is returned (can be null, empty...)
    
    Returns:
    
    the name or the default value (so can be null or empty)
  - siteParameter
```
public static String siteParameter(String parameter)
```
    Return the value of a site parameter as a String.
    
    Parameters:
    
    parameter - the parameter ID.
    
    Returns:
    
    the parameter value as a String.
  - siteParameter
```
public static String siteParameter(String siteName,
                                   String parameter)
```
    Return the value of a site parameter as a String.
    
    Parameters:
    
    siteName - the site name
    
    parameter - the parameter ID.
    
    Returns:
    
    the parameter value as a String.
  - serviceParameters
```
public static Node serviceParameters()
```
    Get the service parameters as a Node.
    
    Returns:
    
    the service parameters as a Node.
  - serviceParameter
```
public static Node serviceParameter(String parameter)
```
    Returns the value of the given parameter for the current service, or the empty string if the parameter does not exist.
    
    Parameters:
    
    parameter - the parameter name.
    
    Returns:
    
    the value of the given parameter for the current service.
  - serviceParameter
```
public static Node serviceParameter(String parameter,
                                    String defaultValue)
```
    Returns the value of the given parameter for the current service, or the provided default value if the parameter does not exist.
    
    Parameters:
    
    parameter - the parameter name or path.
    
    defaultValue - the default value. Note that default value is ignored if the parameter is a composite parameter.
    
    Returns:
    
    the value of the given parameter for the current service.
  - _convertTagName
```
private static String _convertTagName(String name)
```
  - _getParameterValue
```
private static Map<String,MapElement.MapNode> _getParameterValue(String paramName,
                                                                 CompositeMetadata parentMetadata,
                                                                 ServiceParameterOrRepeater paramDef,
                                                                 String defaultValue)
```
  - site
```
public static String site()
```
    Returns the current site
    
    Returns:
    
    the current site
  - site
```
public static String site(String pageId)
```
    Returns the current site
    
    Parameters:
    
    pageId - The identifier ot the page
    
    Returns:
    
    the current site
  - sitemap
```
public static Node sitemap()
```
    Return the current sitemap as a Node.
    
    Returns:
    
    the current sitemap.
  - sitemap
```
public static Node sitemap(String pageId)
```
    Return the subsitemap of the given page as a Node.
    
    Parameters:
    
    pageId - The root page
    
    Returns:
    
    The page as node.
  - breadcrumb
```
public static NodeList breadcrumb()
```
    Computes the breadcrumb of the current page.
    
    Returns:
    
    a NodeList containing all ancestor pages, rooted at the sitemap.
  - resourcesById
```
public static Node resourcesById(String collectionId)
```
    Returns a DOM Element representing files and folder of the resources explorer, under the ResourceCollection corresponding to the given id.
    
    Parameters:
    
    collectionId - the id of the root ResourceCollection.
    
    Returns:
    
    an Element containing files and folders.
  - resourcesByPath
```
public static Node resourcesByPath(String path)
```
    Returns a DOM Element representing files and folder of the resources explorer, under the ResourceCollection corresponding to the given path.
    This path is intended to be relative to the current site's resource explorer.
    
    Parameters:
    
    path - the path of the root ResourceCollection, relative to the current site's resource explorer.
    
    Returns:
    
    an Element containing files and folders or null if the specified resource does not exist.
  - skinResources
```
public static Node skinResources(String path)
                          throws IOException
```
    Returns a DOM Element representing files and folder of a skin directory.
    This path is intended to be relative to the current skin's 'resources' directory.
    
    Parameters:
    
    path - the path of the root ResourceCollection, relative to the current skin's 'resources' directory. Can be a file path to test its existance.
    
    Returns:
    
    an Element containing files and folders. node name is 'collection' or 'resource' with an attribute 'name'. Return null if the path does not exits.
    
    Throws:
    
    IOException - if an error occured while listing files.
  - _getMetadata
```
private static String _getMetadata(CompositeMetadata cm,
                                   String metadataName)
```
  - _getPage
```
private static Page _getPage(String sitename,
                             String lang,
                             String path)
```
  - _getPage
```
private static Page _getPage(String id)
```
  - pageSiteName
```
public static String pageSiteName(String pageId)
```
    Get the site name of a page.
    
    Parameters:
    
    pageId - The page id.
    
    Returns:
    
    The name or empty if the page does not exist.
  - pageTitle
```
public static String pageTitle(String sitename,
                               String lang,
                               String path)
```
    Get the title of a page.
    
    Parameters:
    
    sitename - the site name.
    
    lang - the sitemap name.
    
    path - the page path.
    
    Returns:
    
    The name or empty if the meta or the page does not exist.
  - pageTitle
```
public static String pageTitle(String pageId)
```
    Get the title of a page.
    
    Parameters:
    
    pageId - The page id.
    
    Returns:
    
    The name or empty if the meta or the page does not exist.
  - pageLongTitle
```
public static String pageLongTitle(String sitename,
                                   String lang,
                                   String path)
```
    Get the long title of a page
    
    Parameters:
    
    sitename - the site name
    
    lang - the page's language
    
    path - the page's path
    
    Returns:
    
    The name or empty if the meta or the page does not exist
  - pageLongTitle
```
public static String pageLongTitle(String pageId)
```
    Get the long title of a page
    
    Parameters:
    
    pageId - The page id
    
    Returns:
    
    The name or empty if the meta or the page does not exist
  - pageMetadata
```
public static String pageMetadata(String sitename,
                                  String lang,
                                  String path,
                                  String metadataName)
```
    Get the meta of a page
    
    Parameters:
    
    sitename - the site name
    
    lang - the page's language
    
    path - the page's path
    
    metadataName - The meta name (/ for composite)
    
    Returns:
    
    The name or empty if the meta or the page does not exist
  - pageMetadata
```
public static String pageMetadata(String pageId,
                                  String metadataName)
```
    Get the meta of a page
    
    Parameters:
    
    pageId - The page id
    
    metadataName - The meta name (/ for composite)
    
    Returns:
    
    The name or empty if the meta or the page does not exist
  - pageIsVisible
```
public static boolean pageIsVisible(String pageId)
```
    Returns true if the given page is visible into navigation elements
    
    Parameters:
    
    pageId - the page id.
    
    Returns:
    
    true if the page is visible
  - pageIsVisible
```
public static boolean pageIsVisible(String sitename,
                                    String lang,
                                    String path)
```
    Returns true if the given page is visible into navigation elements
    
    Parameters:
    
    sitename - the site name
    
    lang - the page's language
    
    path - the page's path
    
    Returns:
    
    true if the page is visible
  - pageHasRestrictedAccess
```
public static boolean pageHasRestrictedAccess(String pageId)
```
    Returns true if the given page has restricted access.
    
    Parameters:
    
    pageId - the page id.
    
    Returns:
    
    true if the page exists and has restricted access.
  - pageHasRestrictedAccess
```
public static boolean pageHasRestrictedAccess(String sitename,
                                              String lang,
                                              String path)
```
    Returns true if the given page has restricted access.
    
    Parameters:
    
    sitename - the site name
    
    lang - the page's language
    
    path - the page's path
    
    Returns:
    
    true if the page exists and has restricted access.
  - pagePath
```
public static String pagePath()
```
    Returns the path of the current page, relative to the sitemap's root.
    
    Returns:
    
    the path of the current Page, or empty if there's no current page.
  - pagePath
```
public static String pagePath(String pageId)
```
    Returns the path in sitemap of a page
    
    Parameters:
    
    pageId - The id of page
    
    Returns:
    
    the path of the Page, or empty if not exists
  - pageId
```
public static String pageId()
```
    Returns the id of the current page.
    
    Returns:
    
    the id of the current Page, or empty if there's no current page.
  - isCacheable
```
public static boolean isCacheable()
```
    Determines if the current zone item or (if there is no current zone item) the current page is cacheable This method is only valid for a page.
    
    Returns:
    
    true if the current zone item or page is cacheable.
  - accessibleReferencedPages
```
public static NodeList accessibleReferencedPages(String contentId)
```
    Returns the id of pages referencing the content and for which the Front-office user can access
    
    Parameters:
    
    contentId - The content's id
    
    Returns:
    
    The pages' id
  - referencedPages
```
public static NodeList referencedPages(String contentId)
```
    Returns the id of pages referencing the content
    
    Parameters:
    
    contentId - The content's id
    
    Returns:
    
    The pages' id
  - findPagesIdsByTag
```
public static NodeList findPagesIdsByTag(String sitename,
                                         String lang,
                                         String tag)
```
    Returns the ids of the pages
    
    Parameters:
    
    sitename - The site id
    
    lang - The language code
    
    tag - The tag id
    
    Returns:
    
    Array of pages ids
  - findPagesIdsByTag
```
public static NodeList findPagesIdsByTag(String tag)
```
    Returns the ids of the pages
    
    Parameters:
    
    tag - The tag id
    
    Returns:
    
    Array of pages ids

Class AmetysXSLTHelper

Field Summary

Fields inherited from class org.ametys.cms.transformation.xslt.AmetysXSLTHelper

Fields inherited from class org.ametys.core.util.AmetysXSLTHelper

Constructor Summary

Method Summary

Methods inherited from class org.ametys.cms.transformation.xslt.AmetysXSLTHelper

Methods inherited from class org.ametys.core.util.AmetysXSLTHelper

Methods inherited from class java.lang.Object

Field Detail

_siteManager

_renderingContextHandler

_siteConf

_rightManager

_prefixHandler

_sourceResolver

_serviceEP

Constructor Detail

AmetysXSLTHelper

Method Detail

service

uriPrefix

siteUriPrefix

absoluteUriPrefix

absoluteSiteUriPrefix

absoluteSiteUriPrefix

skin

template

lang

lang

skinURL

skinImageURL

skinImageBase64

skinBoundedImageURL

templateURL

pluginResourceURL

pluginImageBase64

_getResourceURL

_getResourceBase64

renderingContext

zone

siteParameter

siteParameter

serviceParameters

serviceParameter

serviceParameter

_convertTagName

_getParameterValue

site

site

sitemap

sitemap

breadcrumb

resourcesById

resourcesByPath

skinResources

_getMetadata

_getPage

_getPage

pageSiteName

pageTitle

pageTitle

pageLongTitle

pageLongTitle

pageMetadata

pageMetadata

pageIsVisible

pageIsVisible

pageHasRestrictedAccess

pageHasRestrictedAccess

pagePath

pagePath

pageId

isCacheable

accessibleReferencedPages

referencedPages

findPagesIdsByTag

findPagesIdsByTag