org.ametys.cms.transformation

Interface URIResolver

All Known Implementing Classes:

Attachment2FlipbookUriResolver, AttachmentURIResolver, AttachmentURIResolver, BPMUriResolver, ContentURIResolver, LinkMetadataURIResolver, LocalURIResolver, LocalURIResolver, Metadata2FlipbookUriResolver, MetadataURIResolver, MetadataURIResolver, OdfURIResolver, OdfURIResolver, PageAttachmentURIResolver, PageURIResolver, PostUriResolver, ProjectResourceURIResolver, RemoteURIResolver, RemoteURIResolver, Resource2FlipbookUriResolver, ResourceURIResolver, ResourceURIResolver, SiteMetadataUriResolver, WebdavProjectResourceURIResolver

public interface URIResolver

Resolver for link uris put by the inline editor in rich text fields.

Method Summary

Modifier and Type	Method and Description
ConsistencyChecker.CHECK	checkLink(String uri, boolean shortTest) Tests if the URI is not broken.
I18nizableText	getLabel(String uri) Get an URI label.
String	getType() Returns the type of links handled by this URIResolver.
String	resolve(String uri, boolean download, boolean absolute, boolean internal) Resolves a link URI for rendering purposes. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveBoundedImage(String uri, int maxHeight, int maxWidth, boolean download, boolean absolute, boolean internal) Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveBoundedImageAsBase64(String uri, int maxHeight, int maxWidth) Resolve an image and return it as a base64-encoded string.
String	resolveCroppedImage(String uri, int cropHeight, int cropWidth, boolean download, boolean absolute, boolean internal) Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveCroppedImageAsBase64(String uri, int cropHeight, int cropWidth) Resolve an image and return it as a base64-encoded string.
String	resolveImage(String uri, int height, int width, boolean download, boolean absolute, boolean internal) Resolves a link URI for rendering image. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
String	resolveImageAsBase64(String uri, int height, int width) Resolve an image and return it as a base64-encoded string.

Method Detail

getType

String getType()

Returns the type of links handled by this URIResolver.

Returns:

the type of links handled by this URIResolver.

resolve

String resolve(String uri,
               boolean download,
               boolean absolute,
               boolean internal)

Resolves a link URI for rendering purposes.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

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

String resolveImage(String uri,
                    int height,
                    int width,
                    boolean download,
                    boolean absolute,
                    boolean internal)

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

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

String resolveImageAsBase64(String uri,
                            int height,
                            int width)

Resolve an image and return it as a base64-encoded string.

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

String resolveBoundedImage(String uri,
                           int maxHeight,
                           int maxWidth,
                           boolean download,
                           boolean absolute,
                           boolean internal)

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

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

String resolveBoundedImageAsBase64(String uri,
                                   int maxHeight,
                                   int maxWidth)

Resolve an image and return it as a base64-encoded string.

Parameters:

uri - the link URI.

maxHeight - the max height

maxWidth - the max width

Returns:

a base64-encoded string representing the image.

resolveCroppedImage

String resolveCroppedImage(String uri,
                           int cropHeight,
                           int cropWidth,
                           boolean download,
                           boolean absolute,
                           boolean internal)

Resolves a link URI for rendering image.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.

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

String resolveCroppedImageAsBase64(String uri,
                                   int cropHeight,
                                   int cropWidth)

Resolve an image and return it as a base64-encoded string.

Parameters:

uri - the link URI.

cropHeight - the crop height

cropWidth - the crop width

Returns:

a base64-encoded string representing the image.

checkLink

ConsistencyChecker.CHECK checkLink(String uri,
                                   boolean shortTest)

Tests if the URI is not broken.

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

getLabel

I18nizableText getLabel(String uri)

Get an URI label.

Parameters:

uri - the uri which label to get.

Returns:

the label.