org.nuxeo.ecm.platform.rendition.url

Class RenditionBasedCodec

java.lang.Object

org.nuxeo.ecm.platform.url.service.AbstractDocumentViewCodec

org.nuxeo.ecm.platform.rendition.url.RenditionBasedCodec

All Implemented Interfaces:

DocumentViewCodec

Direct Known Subclasses:

DocumentRenditionCodec, TemplateRenderCodec

public class RenditionBasedCodec
extends AbstractDocumentViewCodec

Base class for Rendition url codec.

This class is shared with Template rendering system.

Codec handling a document repository, id, view and additional request parameters. View is used to represent the Rendition name.

This codec supports both path abd id based urls.

Since:

5.6

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_URL_PATTERN
protected static org.apache.commons.logging.Log	log
static String	PATH_URL_PATTERN
static String	RENDITION_PARAM_NAME
static String	RENDITION_VIEW_ID
static int	URL_MAX_LENGTH

Fields inherited from class org.nuxeo.ecm.platform.url.service.AbstractDocumentViewCodec

prefix

Constructor Summary

Constructors

Constructor and Description
RenditionBasedCodec()

Method Summary

Modifier and Type	Method and Description
DocumentView	getDocumentViewFromUrl(String url) Extracts the document view from given url.
static String	getRenditionUrl(DocumentModel doc, String renditionName)
String	getUrlFromDocumentView(DocumentView docView) Builds an url from the given document view.
protected String	getUrlFromDocumentViewWithId(DocumentView docView)

Methods inherited from class org.nuxeo.ecm.platform.url.service.AbstractDocumentViewCodec

getPrefix, handleDocumentView, handleUrl, setPrefix

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

URL_MAX_LENGTH

public static final int URL_MAX_LENGTH

See Also:

Constant Field Values

RENDITION_PARAM_NAME

public static final String RENDITION_PARAM_NAME

Since:

6.0

See Also:

Constant Field Values

RENDITION_VIEW_ID

public static final String RENDITION_VIEW_ID

Since:

6.0

See Also:

Constant Field Values

PATH_URL_PATTERN

public static final String PATH_URL_PATTERN

See Also:

Constant Field Values

ID_URL_PATTERN

public static final String ID_URL_PATTERN

See Also:

Constant Field Values

Constructor Detail

RenditionBasedCodec

public RenditionBasedCodec()

Method Detail

getRenditionUrl

public static String getRenditionUrl(DocumentModel doc,
                                     String renditionName)

getDocumentViewFromUrl

public DocumentView getDocumentViewFromUrl(String url)

Description copied from interface: DocumentViewCodec

Extracts the document view from given url.

The url is partial: it does not hold the context path information (server:port/nuxeo).

Parameters:

url - the partial url to redirect to.

Returns:

a document view instance.

getUrlFromDocumentViewWithId

protected String getUrlFromDocumentViewWithId(DocumentView docView)

getUrlFromDocumentView

public String getUrlFromDocumentView(DocumentView docView)

Description copied from interface: DocumentViewCodec

Builds an url from the given document view.

The url should be partial: it should not hold the context path information (server:port/nuxeo).

Returns: