Package org.ametys.plugins.bpm
Class BPMUriResolver
java.lang.Object
org.apache.avalon.framework.logger.AbstractLogEnabled
org.ametys.plugins.bpm.BPMUriResolver
- All Implemented Interfaces:
URIResolver
,PluginAware
,Contextualizable
,LogEnabled
,Serviceable
public class BPMUriResolver
extends AbstractLogEnabled
implements URIResolver, Serviceable, PluginAware, Contextualizable
Uri Resolver for the BPM plugin
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionTests if the URI is not broken.void
contextualize
(Context context) Get an URI label.getType()
Returns the type of links handled by thisURIResolver
.Resolves a link URI for rendering purposes.
The output must be a properly encoded path, relative to the webapp context, accessible from a browser.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.resolveBoundedImageAsBase64
(String uri, int maxHeight, int maxWidth) Resolve an image and return it as a base64-encoded 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.resolveCroppedImageAsBase64
(String uri, int cropHeight, int cropWidth) Resolve an image and return it as a base64-encoded 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.resolveImageAsBase64
(String uri, int height, int width) Resolve an image and return it as a base64-encoded string.void
service
(ServiceManager manager) void
setPluginInfo
(String pluginName, String featureName, String id) Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
-
Constructor Details
-
BPMUriResolver
public BPMUriResolver()
-
-
Method Details
-
setPluginInfo
Description copied from interface:PluginAware
Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.- Specified by:
setPluginInfo
in interfacePluginAware
- Parameters:
pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)id
- Unique identifier of this component
-
contextualize
- Specified by:
contextualize
in interfaceContextualizable
- Throws:
ContextException
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
getType
Description copied from interface:URIResolver
Returns the type of links handled by thisURIResolver
.- Specified by:
getType
in interfaceURIResolver
- Returns:
- the type of links handled by this
URIResolver
.
-
resolve
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 interfaceURIResolver
- Parameters:
uri
- the link URI.download
- true if the pointed resource is to be downloaded.absolute
- true if the url must be absoluteinternal
- 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 interfaceURIResolver
- Parameters:
uri
- the link URI.height
- the height of the image.width
- the width of the imagedownload
- true if the pointed resource is to be downloaded.absolute
- true if the url must be absoluteinternal
- true to get an internal URI.- Returns:
- the path to the image.
-
resolveImageAsBase64
Description copied from interface:URIResolver
Resolve an image and return it as a base64-encoded string.- Specified by:
resolveImageAsBase64
in interfaceURIResolver
- 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 interfaceURIResolver
- Parameters:
uri
- the link URI.maxHeight
- the max heightmaxWidth
- the max widthdownload
- true if the pointed resource is to be downloaded.absolute
- true if the url must be absoluteinternal
- true to get an internal URI.- Returns:
- the path to the image.
-
resolveBoundedImageAsBase64
Description copied from interface:URIResolver
Resolve an image and return it as a base64-encoded string.- Specified by:
resolveBoundedImageAsBase64
in interfaceURIResolver
- Parameters:
uri
- the link URI.maxHeight
- the max heightmaxWidth
- the max width- Returns:
- a base64-encoded string representing 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 interfaceURIResolver
- Parameters:
uri
- the link URI.cropHeight
- the crop heightcropWidth
- the crop widthdownload
- true if the pointed resource is to be downloaded.absolute
- true if the url must be absoluteinternal
- true to get an internal URI.- Returns:
- the path to the image.
-
resolveCroppedImageAsBase64
Description copied from interface:URIResolver
Resolve an image and return it as a base64-encoded string.- Specified by:
resolveCroppedImageAsBase64
in interfaceURIResolver
- Parameters:
uri
- the link URI.cropHeight
- the crop heightcropWidth
- the crop width- Returns:
- a base64-encoded string representing the image.
-
checkLink
Description copied from interface:URIResolver
Tests if the URI is not broken.- Specified by:
checkLink
in interfaceURIResolver
- Parameters:
uri
- The uri to testshortTest
- 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
Description copied from interface:URIResolver
Get an URI label.- Specified by:
getLabel
in interfaceURIResolver
- Parameters:
uri
- the uri which label to get.- Returns:
- the label.
-