Class SiteMetadataUriResolver

    • Method Detail

      • 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.
      • resolveImageAsBase64

        protected String resolveImageAsBase64​(String uri,
                                              int height,
                                              int width,
                                              int maxHeight,
                                              int maxWidth,
                                              int cropHeight,
                                              int cropWidth)
        Get an image's bytes encoded as base64, optionally resized.
        Parameters:
        uri - the image URI.
        height - the specified height. Ignored if negative.
        width - the specified width. Ignored if negative.
        maxHeight - the maximum image height. Ignored if height or width is specified.
        maxWidth - the maximum image width. Ignored if height or width is specified.
        cropHeight - The cropping height. Ignored if negative.
        cropWidth - The cropping width. Ignored if negative.
        Returns:
        the image bytes encoded as base64.
      • 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.
      • resolveCroppedImage

        public String resolveCroppedImage​(String uri,
                                          int cropHeight,
                                          int cropWidth,
                                          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.
        cropHeight - the crop height
        cropWidth - 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 cropHeight,
                                                  int cropWidth)
        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.
        cropHeight - the crop height
        cropWidth - 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
      • _resolveImage

        protected String _resolveImage​(String uri,
                                       String sizeArguments,
                                       boolean download,
                                       boolean absolute)
        Resolves the URI for project's illustration.
        Parameters:
        uri - the uri
        sizeArguments - The size arguments
        download - true if the pointed resource is to be downloaded.
        absolute - true if the url must be absolute
        Returns:
        the path to the image.
      • getUriPrefix

        protected String getUriPrefix​(String siteName,
                                      boolean download,
                                      boolean absolute,
                                      boolean internal)
        Get the URI prefix
        Parameters:
        siteName - The site name
        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 URI prefix