Class ContentURIResolver

java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.ametys.cms.transformation.ContentURIResolver
All Implemented Interfaces:
URIResolver, LogEnabled, Serviceable

URIResolver for a Content.
  • Field Details

  • Constructor Details

  • Method Details

    • service

      public void service(ServiceManager manager) throws ServiceException
      Specified by:
      service in interface Serviceable
      Throws:
      ServiceException
    • resolve

      public String resolve(String uri, boolean download, boolean absolute, boolean internal)
      Description copied from interface: URIResolver
      Resolves a link URI for rendering purposes.
      The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
      Specified by:
      resolve in interface URIResolver
      Parameters:
      uri - the link URI.
      download - true if the pointed resource is to be downloaded.
      absolute - true if the url must be absolute
      internal - true to get an internal URI.
      Returns:
      the path to the resource.
    • resolveImage

      public String resolveImage(String uri, int height, int width, boolean download, boolean absolute, boolean internal)
      Description copied from interface: URIResolver
      Resolves a link URI for rendering image.
      The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
      Specified by:
      resolveImage in interface URIResolver
      Parameters:
      uri - the link URI.
      height - the height of the image.
      width - the width of the image
      download - true if the pointed resource is to be downloaded.
      absolute - true if the url must be absolute
      internal - true to get an internal URI.
      Returns:
      the path to the image.
    • resolveImageAsBase64

      public String resolveImageAsBase64(String uri, int height, int width)
      Description copied from interface: URIResolver
      Resolve an image and return it as a base64-encoded string.
      Specified by:
      resolveImageAsBase64 in interface URIResolver
      Parameters:
      uri - the link URI.
      height - the height of the image.
      width - the width of the image
      Returns:
      a base64-encoded string representing the image.
    • resolveBoundedImage

      public String resolveBoundedImage(String uri, int maxHeight, int maxWidth, boolean download, boolean absolute, boolean internal)
      Description copied from interface: URIResolver
      Resolves a link URI for rendering image.
      The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
      Specified by:
      resolveBoundedImage in interface URIResolver
      Parameters:
      uri - the link URI.
      maxHeight - the max height
      maxWidth - the max width
      download - true if the pointed resource is to be downloaded.
      absolute - true if the url must be absolute
      internal - true to get an internal URI.
      Returns:
      the path to the image.
    • resolveBoundedImageAsBase64

      public String resolveBoundedImageAsBase64(String uri, int maxHeight, int maxWidth)
      Description copied from interface: URIResolver
      Resolve an image and return it as a base64-encoded string.
      Specified by:
      resolveBoundedImageAsBase64 in interface URIResolver
      Parameters:
      uri - the link URI.
      maxHeight - the max height
      maxWidth - the max width
      Returns:
      a base64-encoded string representing the image.
    • resolveCroppedImage

      public String resolveCroppedImage(String uri, int maxHeight, int maxWidth, boolean download, boolean absolute, boolean internal)
      Description copied from interface: URIResolver
      Resolves a link URI for rendering image.
      The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
      Specified by:
      resolveCroppedImage in interface URIResolver
      Parameters:
      uri - the link URI.
      maxHeight - the crop height
      maxWidth - the crop width
      download - true if the pointed resource is to be downloaded.
      absolute - true if the url must be absolute
      internal - true to get an internal URI.
      Returns:
      the path to the image.
    • resolveCroppedImageAsBase64

      public String resolveCroppedImageAsBase64(String uri, int maxHeight, int maxWidth)
      Description copied from interface: URIResolver
      Resolve an image and return it as a base64-encoded string.
      Specified by:
      resolveCroppedImageAsBase64 in interface URIResolver
      Parameters:
      uri - the link URI.
      maxHeight - the crop height
      maxWidth - the crop width
      Returns:
      a base64-encoded string representing the image.
    • checkLink

      public ConsistencyChecker.CHECK checkLink(String uri, boolean shortTest)
      Description copied from interface: URIResolver
      Tests if the URI is not broken.
      Specified by:
      checkLink in interface URIResolver
      Parameters:
      uri - The uri to test
      shortTest - If shortTest is to true, only fast check should be done. If false, complete test (even if long) should be done.
      Returns:
      SUCCESS if the test was done and ok, FAILURE if the test was done and ko, UNKNOWN if the test was not done (because too long). UNKNOWN can not be returned when shortTest is set to false
    • getType

      public String getType()
      Description copied from interface: URIResolver
      Returns the type of links handled by this URIResolver.
      Specified by:
      getType in interface URIResolver
      Returns:
      the type of links handled by this URIResolver.
    • getLabel

      Description copied from interface: URIResolver
      Get an URI label.
      Specified by:
      getLabel in interface URIResolver
      Parameters:
      uri - the uri which label to get.
      Returns:
      the label.