org.alfresco.repo.content.metadata

Class RFC822MetadataExtracter

java.lang.Object

org.alfresco.repo.content.metadata.AbstractMappingMetadataExtracter

org.alfresco.repo.content.metadata.RFC822MetadataExtracter

All Implemented Interfaces:

ContentWorker, MetadataEmbedder, MetadataExtracter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware

public class RFC822MetadataExtracter
extends AbstractMappingMetadataExtracter

Metadata extractor for RFC822 mime emails. Default configuration: (see RFC822MetadataExtractor.properties)

   messageFrom:              --      imap:messageFrom, cm:originator
   messageTo:                --      imap:messageTo
   messageCc:                --      imap:messageCc
   messageSubject:           --      imap:messageSubject, cm:title, cm:description, cm:subjectline
   messageSent:              --      imap:dateSent, cm:sentdate
   messageReceived:          --      imap:dateReceived
   All header names:
      Thread-Index:          --      imap:threadIndex
      Message-ID:            --      imap:messageId
 

Since:

3.2

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.content.metadata.MetadataExtracter

MetadataExtracter.OverwritePolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	KEY_MESSAGE_CC
protected static String	KEY_MESSAGE_FROM
protected static String	KEY_MESSAGE_RECEIVED
protected static String	KEY_MESSAGE_SENT
protected static String	KEY_MESSAGE_SUBJECT
protected static String	KEY_MESSAGE_TO
static String[]	SUPPORTED_MIMETYPES

Fields inherited from class org.alfresco.repo.content.metadata.AbstractMappingMetadataExtracter

logger, MEGABYTE_SIZE, metadataExtracterConfig, NAMESPACE_PROPERTY_PREFIX, PROPERTY_COMPONENT_EMBED, PROPERTY_COMPONENT_EXTRACT, PROPERTY_PREFIX_METADATA

Constructor Summary

Constructors

Constructor and Description
RFC822MetadataExtracter()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Serializable>	extractRaw(org.alfresco.service.cmr.repository.ContentReader reader) Override to provide the raw extracted metadata values.
Map<String,Set<org.alfresco.service.namespace.QName>>	getCurrentMapping() Back door for RM

Methods inherited from class org.alfresco.repo.content.metadata.AbstractMappingMetadataExtracter

checkIsEmbedSupported, checkIsSupported, embed, embedInternal, extract, extract, extract, filterSystemProperties, getBeanName, getDefaultEmbedMapping, getDefaultMapping, getEmbedMapping, getExecutorService, getLimits, getMapping, getMimetypeService, init, isEmbeddingSupported, isSupported, makeDate, newRawMap, putRawValue, readEmbedMappingProperties, readEmbedMappingProperties, readGlobalEmbedMappingProperties, readGlobalExtractMappingProperties, readMappingProperties, readMappingProperties, register, setApplicationContext, setBeanName, setDictionaryService, setEmbedMapping, setEmbedMappingProperties, setEnableStringTagging, setExecutorService, setFailOnTypeConversion, setInheritDefaultEmbedMapping, setInheritDefaultMapping, setMapping, setMappingProperties, setMetadataExtracterConfig, setMimetypeLimits, setMimetypeService, setOverwritePolicy, setProperties, setRegistry, setSupportedDateFormats, setSupportedEmbedMimetypes, setSupportedMimetypes

Methods inherited from class java.lang.Object

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

Field Detail

KEY_MESSAGE_FROM

protected static final String KEY_MESSAGE_FROM

See Also:

Constant Field Values

KEY_MESSAGE_TO

protected static final String KEY_MESSAGE_TO

See Also:

Constant Field Values

KEY_MESSAGE_CC

protected static final String KEY_MESSAGE_CC

See Also:

Constant Field Values

KEY_MESSAGE_SUBJECT

protected static final String KEY_MESSAGE_SUBJECT

See Also:

Constant Field Values

KEY_MESSAGE_SENT

protected static final String KEY_MESSAGE_SENT

See Also:

Constant Field Values

KEY_MESSAGE_RECEIVED

protected static final String KEY_MESSAGE_RECEIVED

See Also:

Constant Field Values

SUPPORTED_MIMETYPES

public static String[] SUPPORTED_MIMETYPES

Constructor Detail

RFC822MetadataExtracter

public RFC822MetadataExtracter()

Method Detail

extractRaw

protected Map<String,Serializable> extractRaw(org.alfresco.service.cmr.repository.ContentReader reader)
                                       throws Throwable

Description copied from class: AbstractMappingMetadataExtracter

Override to provide the raw extracted metadata values. An extracter should extract as many of the available properties as is realistically possible. Even if the default mapping doesn't handle all properties, it is possible for each instance of the extracter to be configured differently and more or less of the properties may be used in different installations.

Raw values must not be trimmed or removed for any reason. Null values and empty strings are

• Null: Removed
• Empty String: Passed to the OverwritePolicy
• Non Serializable: Converted to String or fails if that is not possible

Properties extracted and their meanings and types should be thoroughly described in the class-level javadocs of the extracter implementation, for example:

 editor: - the document editor        -->  cm:author
 title:  - the document title         -->  cm:title
 user1:  - the document summary
 user2:  - the document description   -->  cm:description
 user3:  -
 user4:  -
 

Specified by:

extractRaw in class AbstractMappingMetadataExtracter

Parameters:

reader - the document to extract the values from. This stream provided by the reader must be closed if accessed directly.

Returns:

Returns a map of document property values keyed by property name.

Throws:

Throwable - All exception conditions can be handled.

See Also:

AbstractMappingMetadataExtracter.getDefaultMapping()

getCurrentMapping

public final Map<String,Set<org.alfresco.service.namespace.QName>> getCurrentMapping()

Back door for RM

Returns:

Map