org.nuxeo.ecm.platform.mimetype.service

Class MimetypeRegistryService

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService

All Implemented Interfaces:

MimetypeRegistry, Adaptable, Component, Extensible, TimestampedService

public class MimetypeRegistryService
extends DefaultComponent
implements MimetypeRegistry

MimetypeEntry registry service.

Singleton holding a registry of mimetype entries and exposes an API to grab information related to these mimetypes. As well, this is possible to ask for a mimetype magic detection from a stream or file using the API.

Author:

Julien Anguenot

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ExtensionDescriptor>	extensionRegistry
static long	MAX_SIZE_FOR_SCAN
protected Map<String,MimetypeEntry>	mimetypeByExtensionRegistry
protected Map<String,MimetypeEntry>	mimetypeByNormalisedRegistry
static ComponentName	NAME

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

lastModified

Fields inherited from interface org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry

DEFAULT_MIMETYPE, PDF_EXTENSION, PDF_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
MimetypeRegistryService()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
RuntimeContext	getContext()
List<String>	getExtensionsFromMimetypeName(String mimetypeName) Returns the extension for given mimetype.
MimetypeEntry	getMimetypeEntryByMimeType(String mimetype) Gets a mimetype entry given the normalized mimetype.
MimetypeEntry	getMimetypeEntryByName(String name) Gets a mimetype entry by name.
String	getMimetypeFromBlob(Blob blob) Returns the mime type from a given stream.
String	getMimetypeFromBlobWithDefault(Blob blob, String defaultMimetype) Finds the mimetype of a Blob content and returns provided default if not possible.
String	getMimetypeFromExtension(String extension) Returns the mime type from a given extension.
String	getMimetypeFromFile(File file) Returns the mime type given a file.
String	getMimetypeFromFilename(String filename) Returns the mime type from a given filename.
String	getMimetypeFromFilenameAndBlobWithDefault(String filename, Blob blob, String defaultMimetype) Finds the mimetype of some content according to its filename and / or binary content.
String	getMimetypeFromFilenameWithBlobMimetypeFallback(String filename, Blob blob, String defaultMimetype) Finds the mimetype of some content according to its filename or binary mime type or binary content.
protected void	initializeRegistries()
protected boolean	isMimetypeEntry(String mimetypeName)
void	registerExtension(Extension extension) Registers the given extension.
void	registerFileExtension(ExtensionDescriptor extensionDescriptor)
void	registerMimetype(MimetypeEntry mimetype)
void	unregisterExtension(Extension extension) Unregisters the given extension.
void	unregisterFileExtension(ExtensionDescriptor extensionDescriptor)
void	unregisterMimetype(String mimetypeName)
Blob	updateMimetype(Blob blob) Update the mimetype field of a Blob based on the embedded filename with fallback to binary sniffing.
Blob	updateMimetype(Blob blob, String filename) Update the mimetype field of a Blob based on the provided filename with fallback to binary sniffing.
Blob	updateMimetype(Blob blob, String filename, Boolean withBlobMimetypeFallback) Update the mimetype field of a Blob based on the provided filename with fallback to binary.

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

getAdapter, getLastModified, registerContribution, setLastModified, setModifiedNow, start, stop, unregisterContribution

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

NAME

public static final ComponentName NAME

MAX_SIZE_FOR_SCAN

public static final long MAX_SIZE_FOR_SCAN

See Also:

Constant Field Values

mimetypeByNormalisedRegistry

protected Map<String,MimetypeEntry> mimetypeByNormalisedRegistry

mimetypeByExtensionRegistry

protected Map<String,MimetypeEntry> mimetypeByExtensionRegistry

extensionRegistry

protected Map<String,ExtensionDescriptor> extensionRegistry

Constructor Detail

MimetypeRegistryService

public MimetypeRegistryService()

Method Detail

initializeRegistries

protected void initializeRegistries()

isMimetypeEntry

protected boolean isMimetypeEntry(String mimetypeName)

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

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

registerMimetype

public void registerMimetype(MimetypeEntry mimetype)

registerFileExtension

public void registerFileExtension(ExtensionDescriptor extensionDescriptor)

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

unregisterMimetype

public void unregisterMimetype(String mimetypeName)

unregisterFileExtension

public void unregisterFileExtension(ExtensionDescriptor extensionDescriptor)

getContext

public RuntimeContext getContext()

getExtensionsFromMimetypeName

public List<String> getExtensionsFromMimetypeName(String mimetypeName)

Description copied from interface: MimetypeRegistry

Returns the extension for given mimetype.

Specified by:

getExtensionsFromMimetypeName in interface MimetypeRegistry

Parameters:

mimetypeName - the mimetype name.

Returns:

a list of strings containing the possible extensions.

getMimetypeEntryByName

public MimetypeEntry getMimetypeEntryByName(String name)

Description copied from interface: MimetypeRegistry

Gets a mimetype entry by name.

Specified by:

getMimetypeEntryByName in interface MimetypeRegistry

Parameters:

name - the mimetype name.

Returns:

mimetype instance

getMimetypeFromFile

public String getMimetypeFromFile(File file)
                           throws MimetypeNotFoundException,
                                  MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Returns the mime type given a file.

Specified by:

getMimetypeFromFile in interface MimetypeRegistry

Returns:

string containing the mime type

Throws:

MimetypeNotFoundException - if mimetype sniffing failed

MimetypeDetectionException - if unexpected problem prevent the detection to work as expected

getMimetypeFromExtension

public String getMimetypeFromExtension(String extension)
                                throws MimetypeNotFoundException

Description copied from interface: MimetypeRegistry

Returns the mime type from a given extension.

Specified by:

getMimetypeFromExtension in interface MimetypeRegistry

Throws:

MimetypeNotFoundException

getMimetypeFromFilename

public String getMimetypeFromFilename(String filename)
                               throws MimetypeNotFoundException

Description copied from interface: MimetypeRegistry

Returns the mime type from a given filename.

Specified by:

getMimetypeFromFilename in interface MimetypeRegistry

Throws:

MimetypeNotFoundException

getMimetypeFromBlob

public String getMimetypeFromBlob(Blob blob)
                           throws MimetypeNotFoundException,
                                  MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Returns the mime type from a given stream.

Specified by:

getMimetypeFromBlob in interface MimetypeRegistry

Returns:

String mimetype name.

Throws:

MimetypeNotFoundException - if mimetype sniffing failed to identify a registered mime type

MimetypeDetectionException - if unexpected problem prevent the detection to work as expected

getMimetypeEntryByMimeType

public MimetypeEntry getMimetypeEntryByMimeType(String mimetype)

Description copied from interface: MimetypeRegistry

Gets a mimetype entry given the normalized mimetype.

Specified by:

getMimetypeEntryByMimeType in interface MimetypeRegistry

Parameters:

mimetype - the normalized mimetype

Returns:

mimetype instance

getMimetypeFromBlobWithDefault

public String getMimetypeFromBlobWithDefault(Blob blob,
                                             String defaultMimetype)
                                      throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Finds the mimetype of a Blob content and returns provided default if not possible.

Specified by:

getMimetypeFromBlobWithDefault in interface MimetypeRegistry

Parameters:

blob - content to be analyzed

defaultMimetype - defaultMimeType to be used if no found

Returns:

the string mimetype

Throws:

MimetypeDetectionException

getMimetypeFromFilenameAndBlobWithDefault

public String getMimetypeFromFilenameAndBlobWithDefault(String filename,
                                                        Blob blob,
                                                        String defaultMimetype)
                                                 throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Finds the mimetype of some content according to its filename and / or binary content.

Specified by:

getMimetypeFromFilenameAndBlobWithDefault in interface MimetypeRegistry

Parameters:

filename - extension to analyze

blob - content to be analyzed if filename is ambiguous

defaultMimetype - defaultMimeType to be used if no found

Returns:

the string mimetype

Throws:

MimetypeDetectionException

getMimetypeFromFilenameWithBlobMimetypeFallback

public String getMimetypeFromFilenameWithBlobMimetypeFallback(String filename,
                                                              Blob blob,
                                                              String defaultMimetype)
                                                       throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Finds the mimetype of some content according to its filename or binary mime type or binary content.

Specified by:

getMimetypeFromFilenameWithBlobMimetypeFallback in interface MimetypeRegistry

Parameters:

filename - extension to analyze

blob - content to be analyzed if filename is ambiguous

defaultMimetype - defaultMimeType to be used if no found

Returns:

the string mimetype

Throws:

MimetypeDetectionException

updateMimetype

public Blob updateMimetype(Blob blob,
                           String filename,
                           Boolean withBlobMimetypeFallback)
                    throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Update the mimetype field of a Blob based on the provided filename with fallback to binary. If the embedded filename is null, the provided filename is embedded into the blob as well.

Specified by:

updateMimetype in interface MimetypeRegistry

Parameters:

blob - content to be analyzed if filename is ambiguous

filename - with extension to analyze

withBlobMimetypeFallback - to consider blob mimetype as fallback or not

Returns:

updated blob (persisted if necessary)

Throws:

MimetypeDetectionException

updateMimetype

public Blob updateMimetype(Blob blob,
                           String filename)
                    throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Update the mimetype field of a Blob based on the provided filename with fallback to binary sniffing. If the embedded filename is null, the provided filename is embedded into the blob as well.

Specified by:

updateMimetype in interface MimetypeRegistry

Parameters:

blob - content to be analyzed if filename is ambiguous

filename - with extension to analyze

Returns:

updated blob (persisted if necessary)

Throws:

MimetypeDetectionException

updateMimetype

public Blob updateMimetype(Blob blob)
                    throws MimetypeDetectionException

Description copied from interface: MimetypeRegistry

Update the mimetype field of a Blob based on the embedded filename with fallback to binary sniffing. This method should not be called if the embedded filename is null for performance reasons (+ the fact that binary sniffing is no very reliable).

Specified by:

updateMimetype in interface MimetypeRegistry

Parameters:

blob - content to be analyzed if filename is ambiguous

Returns:

updated blob (persisted if necessary)

Throws:

MimetypeDetectionException