org.nuxeo.ecm.platform.rendition.service

Class RenditionServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.rendition.service.RenditionServiceImpl

All Implemented Interfaces:

RenditionService, Adaptable, Component, Extensible, TimestampedService

public class RenditionServiceImpl
extends DefaultComponent
implements RenditionService

Default implementation of RenditionService.

Since:

5.4.1

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static String	RENDITION_DEFINITIONS_EP
static String	RENDITON_DEFINION_PROVIDERS_EP

Constructor Summary

Constructors

Constructor and Description
RenditionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
List<RenditionDefinition>	getAvailableRenditionDefinitions(DocumentModel doc) Returns a List of RenditionDefinition available on the given Document.
List<Rendition>	getAvailableRenditions(DocumentModel doc) Returns a List of Rendition available on the given Document.
List<Rendition>	getAvailableRenditions(DocumentModel doc, boolean onlyVisible) Returns a List of Rendition available on the given Document.
List<RenditionDefinition>	getDeclaredRenditionDefinitions() Deprecated.
List<RenditionDefinition>	getDeclaredRenditionDefinitionsForProviderType(String providerType) Deprecated.
Rendition	getRendition(DocumentModel doc, String renditionName) Return the Rendition object for the given DocumentModel and a rendition definition name.
Rendition	getRendition(DocumentModel doc, String renditionName, boolean store) Return the Rendition object for the given DocumentModel and a rendition definition name.
RenditionDefinition	getRenditionDefinition(String name)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
DocumentRef	storeRendition(DocumentModel source, String renditionDefinitionName) Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

RENDITION_DEFINITIONS_EP

public static final String RENDITION_DEFINITIONS_EP

See Also:

Constant Field Values

RENDITON_DEFINION_PROVIDERS_EP

public static final String RENDITON_DEFINION_PROVIDERS_EP

See Also:

Constant Field Values

Constructor Detail

RenditionServiceImpl

public RenditionServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

deactivate

public void deactivate(ComponentContext context)

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

getRenditionDefinition

public RenditionDefinition getRenditionDefinition(String name)

getDeclaredRenditionDefinitions

@Deprecated
public List<RenditionDefinition> getDeclaredRenditionDefinitions()

Deprecated.

Description copied from interface: RenditionService

Returns a List of registered RenditionDefinition. The order of the List does not depend on the registering order.

Specified by:

getDeclaredRenditionDefinitions in interface RenditionService

getDeclaredRenditionDefinitionsForProviderType

@Deprecated
public List<RenditionDefinition> getDeclaredRenditionDefinitionsForProviderType(String providerType)

Deprecated.

Description copied from interface: RenditionService

Returns a List of registered RenditionDefinition matching a given provider type

Specified by:

getDeclaredRenditionDefinitionsForProviderType in interface RenditionService

getAvailableRenditionDefinitions

public List<RenditionDefinition> getAvailableRenditionDefinitions(DocumentModel doc)

Description copied from interface: RenditionService

Returns a List of RenditionDefinition available on the given Document. The order of the List does not depend on the registering order.

Specified by:

getAvailableRenditionDefinitions in interface RenditionService

storeRendition

public DocumentRef storeRendition(DocumentModel source,
                         String renditionDefinitionName)
                           throws RenditionException

Description copied from interface: RenditionService

Render a document based on the given rendition definition name and returns the stored Rendition DocumentRef.

Only the user launching the render operation has the Read right on the returned document.

Specified by:

storeRendition in interface RenditionService

Parameters:

source - the document to render

renditionDefinitionName - the rendition definition to use

Returns:

the DocumentRef of the newly created Rendition document.

Throws:

RenditionException

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getRendition

public Rendition getRendition(DocumentModel doc,
                     String renditionName)
                       throws RenditionException

Description copied from interface: RenditionService

Return the Rendition object for the given DocumentModel and a rendition definition name.

A stored rendition is returned if found and up to date, a new Rendition is created otherwise.

Specified by:

getRendition in interface RenditionService

Parameters:

doc - the document to render

renditionName - the name of the rendition definition

Returns:

the Rendition object

Throws:

RenditionException

getRendition

public Rendition getRendition(DocumentModel doc,
                     String renditionName,
                     boolean store)
                       throws RenditionException

Description copied from interface: RenditionService

Return the Rendition object for the given DocumentModel and a rendition definition name.

A stored rendition is returned if found and up to date, a new (live) Rendition is created otherwise.

If store parameter is true, the new created rendition is stored too and returned

Specified by:

getRendition in interface RenditionService

Parameters:

doc - the document to render

renditionName - the name of the rendition definition

store - indicates if the rendition must be stored

Returns:

the Rendition object

Throws:

RenditionException

getAvailableRenditions

public List<Rendition> getAvailableRenditions(DocumentModel doc)
                                       throws RenditionException

Description copied from interface: RenditionService

Returns a List of Rendition available on the given Document.

The order of the List does not depend on the registering order.

The returned rendition may be live or stored

Specified by:

getAvailableRenditions in interface RenditionService

Throws:

RenditionException

getAvailableRenditions

public List<Rendition> getAvailableRenditions(DocumentModel doc,
                                     boolean onlyVisible)
                                       throws RenditionException

Description copied from interface: RenditionService

Returns a List of Rendition available on the given Document.

If onlyVisible is true, returns only the rendition marked as visible.

The order of the List does not depend on the registering order.

The returned rendition may be live or stored

Specified by:

getAvailableRenditions in interface RenditionService

Throws:

RenditionException