Difference between revisions of "SMILA/Documentation/ApertureMimeTypeIdentifier"

From Eclipsepedia

Jump to: navigation, search
(Description)
m (Description)
Line 7: Line 7:
 
=== Description ===
 
=== Description ===
  
This service implements the [http://build.eclipse.org/rt/smila/javadoc/current/index.html?org/eclipse/smila/common/mimetype/package-summary.html MimeTypeIdentifier] interface using the mimetype "magic" identification functionality of [http://aperture.sourceforge.net/index.html Aperture]. The service uses either the document's content (a byte[]), a file extension or both. For best results it is recommended that you use both (input data and extension) to identify the mime type of the data, since the aperture mime type identification mainly focuses on the magic numbers in the file and so often fails to determine e.g. office documents' mime types when no conten is given.
+
This service implements the [http://build.eclipse.org/rt/smila/javadoc/current/index.html?org/eclipse/smila/common/mimetype/package-summary.html MimeTypeIdentifier] interface using the "magic" identification of MIME types in [http://aperture.sourceforge.net/index.html Aperture]. The service uses either the document's content (a byte[]), a file extension or both. For best results, it is recommended to use both input data and extension to identify the MIME type of data, since the MIME type identification of Aperture mainly focuses on the magic numbers in the file and so often fails to determine e.g. office documents' MIME types when no content is given.
  
For further information on the aperture mime type extraction please consult the apropriate [http://aperture.sourceforge.net/ Aperture] documentation pages (e.g. [http://sourceforge.net/apps/trac/aperture/wiki/MIMETypeIdentification MIMETypeIdentification]).
+
For further information on the MIME type extraction in Aperture please consult the respective documentation pages (e.g. [http://sourceforge.net/apps/trac/aperture/wiki/MIMETypeIdentification MIMETypeIdentification]).
  
The javadoc for the implemented interface can be found [http://build.eclipse.org/rt/smila/javadoc/current/index.html?org/eclipse/smila/common/mimetype/package-summary.html here].
+
The JavaDoc of the implemented interface can be found [http://build.eclipse.org/rt/smila/javadoc/current/index.html?org/eclipse/smila/common/mimetype/package-summary.html here].
  
 
To enable the service, start bundle <tt>org.eclipse.smila.aperture</tt> and get a OSGi service reference for interface <tt>org.eclipse.smila.common.mimetype.MimeTypeIdentifier</tt>. You should take care not to start the <tt>org.eclipse.smila.common.mimetype.impl</tt> bundle to ensure that the Aperture based implementation is used and not simplistic one that SMILA provides as a fallback. We have set the service rankings of those services such that the Aperture implementation should be preferred if both are running, but it's always better to be sure what happens in your system ;-)
 
To enable the service, start bundle <tt>org.eclipse.smila.aperture</tt> and get a OSGi service reference for interface <tt>org.eclipse.smila.common.mimetype.MimeTypeIdentifier</tt>. You should take care not to start the <tt>org.eclipse.smila.common.mimetype.impl</tt> bundle to ensure that the Aperture based implementation is used and not simplistic one that SMILA provides as a fallback. We have set the service rankings of those services such that the Aperture implementation should be preferred if both are running, but it's always better to be sure what happens in your system ;-)
Line 17: Line 17:
 
==== Interaction with the MimeTypeIdentifyPipelet ====
 
==== Interaction with the MimeTypeIdentifyPipelet ====
  
When the Aperture based MimeTypeIdentifier is started, it uses the <tt>org.eclipse.smila.processing.pipelets.MimeTypeIdentifyPipelet</tt> automatically (if no other MimeTypeIdentifier service with yet a higher service ranking is active, of course).
+
When the Aperture based <tt>MimeTypeIdentifier</tt> is started, it uses the <tt>org.eclipse.smila.processing.pipelets.MimeTypeIdentifyPipelet</tt> automatically (if no other MimeTypeIdentifier service with yet a higher service ranking is active, of course).
  
For information on how to configure the mime type identification pipelet, which uses the MimeTypeIdentifier service to recognize attachment mime types please refer to [[SMILA/Documentation/Bundle_org.eclipse.smila.processing.pipelets#Bundle:_org.eclipse.smila.processing.pipelets.MimeTypeIdentifyPipelet|MimeTypeIdentifyPipelet]].
+
For information on how to configure the MIME type identification pipelet, which uses the <tt>MimeTypeIdentifier</tt> service to recognize the MIME types of attachments please refer to [[SMILA/Documentation/Bundle_org.eclipse.smila.processing.pipelets#Bundle:_org.eclipse.smila.processing.pipelets.MimeTypeIdentifyPipelet|MimeTypeIdentifyPipelet]].
  
 
[[Category:SMILA]] [[Category:SMILA/Processing Service]]
 
[[Category:SMILA]] [[Category:SMILA/Processing Service]]

Revision as of 05:04, 22 September 2011

This component is not yet available in our repository. We are in the process of creating CQs for the required third party code and hopefully get permission to use it in our project.

Class: org.eclipse.smila.aperture.ApertureMimeTypeIdentifier

Located in bundle: org.eclipse.smila.aperture

Description

This service implements the MimeTypeIdentifier interface using the "magic" identification of MIME types in Aperture. The service uses either the document's content (a byte[]), a file extension or both. For best results, it is recommended to use both input data and extension to identify the MIME type of data, since the MIME type identification of Aperture mainly focuses on the magic numbers in the file and so often fails to determine e.g. office documents' MIME types when no content is given.

For further information on the MIME type extraction in Aperture please consult the respective documentation pages (e.g. MIMETypeIdentification).

The JavaDoc of the implemented interface can be found here.

To enable the service, start bundle org.eclipse.smila.aperture and get a OSGi service reference for interface org.eclipse.smila.common.mimetype.MimeTypeIdentifier. You should take care not to start the org.eclipse.smila.common.mimetype.impl bundle to ensure that the Aperture based implementation is used and not simplistic one that SMILA provides as a fallback. We have set the service rankings of those services such that the Aperture implementation should be preferred if both are running, but it's always better to be sure what happens in your system ;-)

Interaction with the MimeTypeIdentifyPipelet

When the Aperture based MimeTypeIdentifier is started, it uses the org.eclipse.smila.processing.pipelets.MimeTypeIdentifyPipelet automatically (if no other MimeTypeIdentifier service with yet a higher service ranking is active, of course).

For information on how to configure the MIME type identification pipelet, which uses the MimeTypeIdentifier service to recognize the MIME types of attachments please refer to MimeTypeIdentifyPipelet.