org.nuxeo.ecm.platform.picture

Class ImagingComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.picture.ImagingComponent

All Implemented Interfaces:

ImagingService, Adaptable, Component, Extensible, TimestampedService

public class ImagingComponent
extends DefaultComponent
implements ImagingService

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURATION_PARAMETERS_EP
protected Map<String,String>	configurationParameters
static String	PICTURE_CONVERSIONS_EP
protected PictureConversionRegistry	pictureConversionRegistry
protected PictureMigrationHandler	pictureMigrationHandler

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

lastModified

Constructor Summary

Constructors

Constructor and Description
ImagingComponent()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
protected Blob	callPictureConversionChain(DocumentModel doc, Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo, Point size, String conversionFormat)
protected boolean	canApplyPictureConversion(PictureConversion pictureConversion, DocumentModel doc)
protected PictureView	computeOriginalJpegView(Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo) Deprecated. since 7.1
protected PictureView	computeOriginalView(Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo) Deprecated. since 7.1
protected PictureView	computeView(Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo, boolean convert)
protected PictureView	computeView(DocumentModel doc, Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo)
protected PictureView	computeView(DocumentModel doc, Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo, boolean convert)
protected String	computeViewFilename(String filename, String format) Deprecated. since 7.1. We now use the original Blob base name + the computed Blob filename extension.
PictureView	computeViewFor(Blob blob, PictureConversion pictureConversion, boolean convert) Computes a PictureView for the given blob and pictureConversion.
PictureView	computeViewFor(Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo, boolean convert) Computes a PictureView for the given blob and pictureConversion.
List<PictureView>	computeViewsFor(Blob blob, List<PictureConversion> pictureConversions, boolean convert) Computes a List of PictureViews for the given blob and pictureConversions.
List<PictureView>	computeViewsFor(Blob blob, List<PictureConversion> pictureConversions, ImageInfo imageInfo, boolean convert) Computes a List of PictureViews for the given blob and pictureConversions.
List<PictureView>	computeViewsFor(DocumentModel doc, Blob blob, ImageInfo imageInfo, boolean convert) Compute all the registered PictureConversion For each picture template the ImagingService.computeViewFor(Blob, PictureConversion, ImageInfo, boolean) method is call
List<List<PictureView>>	computeViewsFor(List<Blob> blobs, List<PictureConversion> pictureConversions, boolean convert) Computes a List of all PictureViews for each Blob of blobs.
List<List<PictureView>>	computeViewsFor(List<Blob> blobs, List<PictureConversion> pictureConversions, ImageInfo imageInfo, boolean convert) Computes a List of all PictureViews for each Blob of blobs.
protected PictureView	computeViewWithoutConversion(Blob blob, PictureConversion pictureConversion, ImageInfo imageInfo)
Blob	convertToPDF(Blob blob) Converts an image to PDF.
protected ActionContext	createActionContext(DocumentModel doc)
Blob	crop(Blob blob, int x, int y, int width, int height) Crops an image.
void	deactivate(ComponentContext context) Deactivates the component.
String	getConfigurationValue(String configurationName) Returns the value a configuration which name is received as parameter.
String	getConfigurationValue(String configurationName, String defaultValue) Returns the value a configuration which name is received as parameter.
ImageInfo	getImageInfo(Blob blob) Retrieves the ImageInfo of the Blob that is received as parameter.
Map<String,Object>	getImageMetadata(Blob blob) Retrieves metadata from an image contained in a Blob.
String	getImageMimeType(Blob blob) Returns the mime-type for the given Blob
String	getImageMimeType(File file) Returns the mime-type for the given file.
PictureConversion	getPictureConversion(String id) Returns a PictureConversion given its id.
List<PictureConversion>	getPictureConversions() Returns the registered picture conversions.
protected static Point	getSize(Point current, int max)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
Blob	resize(Blob blob, String finalFormat, int width, int height, int depth) Resizes image.
Blob	rotate(Blob blob, int angle) Rotates an image.
void	setConfigurationValue(String configurationName, String configurationValue) Sets the value of a configuration which could be used by the ImagingService.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected Blob	wrapBlob(Blob blob)

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

getAdapter, getLastModified, registerExtension, setLastModified, setModifiedNow, start, stop, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

CONFIGURATION_PARAMETERS_EP

public static final String CONFIGURATION_PARAMETERS_EP

See Also:

Constant Field Values

PICTURE_CONVERSIONS_EP

public static final String PICTURE_CONVERSIONS_EP

See Also:

Constant Field Values

configurationParameters

protected Map<String,String> configurationParameters

pictureConversionRegistry

protected PictureConversionRegistry pictureConversionRegistry

pictureMigrationHandler

protected final PictureMigrationHandler pictureMigrationHandler

Constructor Detail

ImagingComponent

public ImagingComponent()

Method Detail

getPictureConversions

public List<PictureConversion> getPictureConversions()

Description copied from interface: ImagingService

Returns the registered picture conversions.

Specified by:

getPictureConversions in interface ImagingService

getPictureConversion

public PictureConversion getPictureConversion(String id)

Description copied from interface: ImagingService

Returns a PictureConversion given its id.

Specified by:

getPictureConversion in interface ImagingService

crop

public Blob crop(Blob blob,
                 int x,
                 int y,
                 int width,
                 int height)

Description copied from interface: ImagingService

Crops an image.

Specified by:

crop in interface ImagingService

resize

public Blob resize(Blob blob,
                   String finalFormat,
                   int width,
                   int height,
                   int depth)

Description copied from interface: ImagingService

Resizes image.

Specified by:

resize in interface ImagingService

rotate

public Blob rotate(Blob blob,
                   int angle)

Description copied from interface: ImagingService

Rotates an image.

Specified by:

rotate in interface ImagingService

Parameters:

blob - a Blob containing the image

angle - the angle of the rotation

Returns:

a Blob holding the rotated image

convertToPDF

public Blob convertToPDF(Blob blob)

Description copied from interface: ImagingService

Converts an image to PDF.

Specified by:

convertToPDF in interface ImagingService

Parameters:

blob - a Blob containing the image

Returns:

a Blob holding the resulting PDF

getImageMetadata

public Map<String,Object> getImageMetadata(Blob blob)

Description copied from interface: ImagingService

Retrieves metadata from an image contained in a Blob.

Specified by:

getImageMetadata in interface ImagingService

Returns:

the image metadata as a map String -> Object

getImageMimeType

public String getImageMimeType(File file)

Description copied from interface: ImagingService

Returns the mime-type for the given file.

Specified by:

getImageMimeType in interface ImagingService

getImageMimeType

public String getImageMimeType(Blob blob)

Description copied from interface: ImagingService

Returns the mime-type for the given Blob

Specified by:

getImageMimeType in interface ImagingService

getImageInfo

public ImageInfo getImageInfo(Blob blob)

Description copied from interface: ImagingService

Retrieves the ImageInfo of the Blob that is received as parameter.

The information provided by the ImageInfo, like width, height or format, is obtained using ImageMagick (see http://www.imagemagick.org/script/index.php for more details on ImageMagick).

Specified by:

getImageInfo in interface ImagingService

Parameters:

blob - the blob of a picture

Returns:

the ImageInfo of a blob

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

getConfigurationValue

public String getConfigurationValue(String configurationName)

Description copied from interface: ImagingService

Returns the value a configuration which name is received as parameter.

Specified by:

getConfigurationValue in interface ImagingService

Parameters:

configurationName - the name of the configuration

Returns:

the value of the configuration, which can be null in case no configuration with the specified name was registered

getConfigurationValue

public String getConfigurationValue(String configurationName,
                                    String defaultValue)

Description copied from interface: ImagingService

Returns the value a configuration which name is received as parameter. In case no configuration with the specified name was registered, the received defaultValue parameter will be returned.

Specified by:

getConfigurationValue in interface ImagingService

Parameters:

configurationName - the name of the configuration

defaultValue - the value of the configuration

setConfigurationValue

public void setConfigurationValue(String configurationName,
                                  String configurationValue)

Description copied from interface: ImagingService

Sets the value of a configuration which could be used by the ImagingService.

Specified by:

setConfigurationValue in interface ImagingService

Parameters:

configurationName - the name of the configuration

configurationValue - the value of the configuration

computeViewFor

public PictureView computeViewFor(Blob blob,
                                  PictureConversion pictureConversion,
                                  boolean convert)
                           throws IOException

Description copied from interface: ImagingService

Computes a PictureView for the given blob and pictureConversion.

Specified by:

computeViewFor in interface ImagingService

convert - true if the blob is converted to fit the pictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Returns:

the computed picture view

Throws:

IOException

computeViewFor

public PictureView computeViewFor(Blob blob,
                                  PictureConversion pictureConversion,
                                  ImageInfo imageInfo,
                                  boolean convert)
                           throws IOException

Description copied from interface: ImagingService

Computes a PictureView for the given blob and pictureConversion.

Specified by:

computeViewFor in interface ImagingService

imageInfo - the ImageInfo to use when computing the view

convert - true if the blob is converted to fit the pictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Returns:

the computed picture view

Throws:

IOException

computeViewsFor

public List<PictureView> computeViewsFor(Blob blob,
                                         List<PictureConversion> pictureConversions,
                                         boolean convert)
                                  throws IOException

Description copied from interface: ImagingService

Computes a List of PictureViews for the given blob and pictureConversions.

Specified by:

computeViewsFor in interface ImagingService

convert - true if the blob is converted to fit each PictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Returns:

the computed picture views as a List of PictureViews

Throws:

IOException

computeViewsFor

public List<PictureView> computeViewsFor(Blob blob,
                                         List<PictureConversion> pictureConversions,
                                         ImageInfo imageInfo,
                                         boolean convert)
                                  throws IOException

Description copied from interface: ImagingService

Computes a List of PictureViews for the given blob and pictureConversions.

Specified by:

computeViewsFor in interface ImagingService

imageInfo - the ImageInfo to use when computing the view

convert - true if the blob is converted to fit each PictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Returns:

the computed picture views as a List of PictureViews

Throws:

IOException

computeView

protected PictureView computeView(Blob blob,
                                  PictureConversion pictureConversion,
                                  ImageInfo imageInfo,
                                  boolean convert)
                           throws IOException

Throws:

IOException

computeView

protected PictureView computeView(DocumentModel doc,
                                  Blob blob,
                                  PictureConversion pictureConversion,
                                  ImageInfo imageInfo,
                                  boolean convert)
                           throws IOException

Throws:

IOException

computeOriginalView

@Deprecated
protected PictureView computeOriginalView(Blob blob,
                                                      PictureConversion pictureConversion,
                                                      ImageInfo imageInfo)
                                               throws IOException

Deprecated. since 7.1

Use computeView(org.nuxeo.ecm.core.api.DocumentModel, Blob, org.nuxeo.ecm.platform.picture.api.PictureConversion, ImageInfo) by passing the Original picture template.

Throws:

IOException

wrapBlob

protected Blob wrapBlob(Blob blob)

computeOriginalJpegView

@Deprecated
protected PictureView computeOriginalJpegView(Blob blob,
                                                          PictureConversion pictureConversion,
                                                          ImageInfo imageInfo)
                                                   throws IOException

Deprecated. since 7.1

Use computeView(org.nuxeo.ecm.core.api.DocumentModel, Blob, org.nuxeo.ecm.platform.picture.api.PictureConversion, ImageInfo) by passing the OriginalJpeg picture template.

Throws:

IOException

computeViewFilename

@Deprecated
protected String computeViewFilename(String filename,
                                                 String format)

Deprecated. since 7.1. We now use the original Blob base name + the computed Blob filename extension.

computeView

protected PictureView computeView(DocumentModel doc,
                                  Blob blob,
                                  PictureConversion pictureConversion,
                                  ImageInfo imageInfo)

callPictureConversionChain

protected Blob callPictureConversionChain(DocumentModel doc,
                                          Blob blob,
                                          PictureConversion pictureConversion,
                                          ImageInfo imageInfo,
                                          Point size,
                                          String conversionFormat)

computeViewsFor

public List<PictureView> computeViewsFor(DocumentModel doc,
                                         Blob blob,
                                         ImageInfo imageInfo,
                                         boolean convert)
                                  throws IOException

Description copied from interface: ImagingService

Compute all the registered PictureConversion For each picture template the ImagingService.computeViewFor(Blob, PictureConversion, ImageInfo, boolean) method is call

Specified by:

computeViewsFor in interface ImagingService

Throws:

IOException

canApplyPictureConversion

protected boolean canApplyPictureConversion(PictureConversion pictureConversion,
                                            DocumentModel doc)

createActionContext

protected ActionContext createActionContext(DocumentModel doc)

computeViewWithoutConversion

protected PictureView computeViewWithoutConversion(Blob blob,
                                                   PictureConversion pictureConversion,
                                                   ImageInfo imageInfo)

getSize

protected static Point getSize(Point current,
                               int max)

computeViewsFor

public List<List<PictureView>> computeViewsFor(List<Blob> blobs,
                                               List<PictureConversion> pictureConversions,
                                               boolean convert)
                                        throws IOException

Description copied from interface: ImagingService

Computes a List of all PictureViews for each Blob of blobs.

Specified by:

computeViewsFor in interface ImagingService

convert - true if the blob is converted to fit each PictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Throws:

IOException

computeViewsFor

public List<List<PictureView>> computeViewsFor(List<Blob> blobs,
                                               List<PictureConversion> pictureConversions,
                                               ImageInfo imageInfo,
                                               boolean convert)
                                        throws IOException

Description copied from interface: ImagingService

Computes a List of all PictureViews for each Blob of blobs.

Specified by:

computeViewsFor in interface ImagingService

imageInfo - the ImageInfo to use when computing the view

convert - true if the blob is converted to fit each PictureConversion, false if the blob is put as it in the PictureView (without any conversion)

Throws:

IOException

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