Package org.ametys.plugins.workspaces.project

Class WorkspacesSiteParameterUriResolver

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.transformation.AbstractURIResolver

org.ametys.plugins.workspaces.project.WorkspacesSiteParameterUriResolver

All Implemented Interfaces:

URIResolver, LogEnabled, Serviceable

public class WorkspacesSiteParameterUriResolver
extends AbstractURIResolver
implements Serviceable

URIResolver for typ "workspaces-site-parameter"

Constructor Summary

Constructors

Constructor	Description
WorkspacesSiteParameterUriResolver()

Method Summary

Modifier and Type	Method	Description
protected String	_resolve(String uri, String uriArgument, boolean download, boolean absolute, boolean internal)	Resolves a link URI for rendering. The output must be a properly encoded path, relative to the webapp context, accessible from a browser.
ConsistencyChecker.CHECK	checkLink(String uri, boolean shortTest)	Tests if the URI is not broken.
protected String	createURL(boolean absolute, boolean internal, boolean download, String filename, String parameter, Site site, String uriArgument)	Create the url
I18nizableText	getLabel(String uri)	Get an URI label.
String	getMimeType(String uri)	Get the mime type for the targeted URI.
protected String	getPath(String filename, String parameter, Site site, String uriArgument)	Compute the path for the url
String	getType()	Returns the type of links handled by this URIResolver.
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.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.cms.transformation.AbstractURIResolver

resolve, resolveBoundedImage, resolveBoundedImageAsBase64, resolveCroppedImage, resolveCroppedImageAsBase64, resolveImage, resolveImageAsBase64

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorkspacesSiteParameterUriResolver

public WorkspacesSiteParameterUriResolver()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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.

_resolve

protected String _resolve(String uri,
 String uriArgument,
 boolean download,
 boolean absolute,
 boolean internal)

Description copied from class: AbstractURIResolver

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

Specified by:

_resolve in class AbstractURIResolver

Parameters:

uri - the link URI.

uriArgument - the argument to append to the 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 image.

createURL

protected String createURL(boolean absolute,
 boolean internal,
 boolean download,
 String filename,
 String parameter,
 Site site,
 String uriArgument)

Create the url

Parameters:

absolute - for an absolute url

internal - for an internal url

download - for a download url

filename - The filename

parameter - The site parameter name

site - The site

uriArgument - The extra arguments

Returns:

The url

getPath

protected String getPath(String filename,
 String parameter,
 Site site,
 String uriArgument)

Compute the path for the url

Parameters:

filename - The filename

parameter - The site parameter name

site - The site

uriArgument - The extra arguments

Returns:

The path

resolveImageAsBase64

protected String resolveImageAsBase64(String uri,
 int height,
 int width,
 int maxHeight,
 int maxWidth,
 int cropHeight,
 int cropWidth)

Description copied from class: AbstractURIResolver

Get an image's bytes encoded as base64, optionally resized.

Specified by:

resolveImageAsBase64 in class AbstractURIResolver

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.

getMimeType

public String getMimeType(String uri)

Description copied from interface: URIResolver

Get the mime type for the targeted URI.

Specified by:

getMimeType in interface URIResolver

Parameters:

uri - the link URI.

Returns:

the mime type, can be empty or null.

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

getLabel

public I18nizableText getLabel(String uri)

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.