com.edorasware.commons.core.content.internal

Class DefaultConfigurableContentManager

java.lang.Object

com.edorasware.commons.core.content.internal.DefaultConfigurableContentManager

All Implemented Interfaces:

ContentManager, ConfigurableContentManager

public class DefaultConfigurableContentManager
extends Object
implements ConfigurableContentManager

Default ConfigurableContentManager implementation. This implementation uses the CurrentTenantService to set the scope of the operations of the content provider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRE_PROCESS_ORIGINAL_FILE_NAME
static String	PRE_PROCESS_PROCESSED_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultConfigurableContentManager(List<ContentProvider> contentProviders, CurrentTenantService currentTenantService, CurrentUserService currentUserService, org.springframework.transaction.PlatformTransactionManager transactionManager) Constructor for the ConfigurableContentManager.

Method Summary

Modifier and Type	Method and Description
ContentReference	addContent(ContentInfo contentInfo, org.springframework.core.io.Resource resource, long inputStreamLength) Add content with the specified ContentInfo and the content itself as InputStream.
void	addContentProvider(ContentProvider contentProvider) Add a ContentProvider to the content manager.
void	deleteContent() Deletes all the content of the content manager.
int	deleteContent(ContentReference contentReference) Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content.
void	deleteContent(ContentReference contentReference, String version) Deletes a specific version of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content with that version.
void	deleteContent(String contentSourceId) Deletes the content that is associated to the supplied ContentSourceId.
org.springframework.core.io.Resource	getContent(ContentReference contentReference) Returns the latest version of the content.
org.springframework.core.io.Resource	getContent(ContentReference contentReference, String version) Returns the specified version of the content.
byte[]	getContentAsBytes(ContentReference contentReference) Returns the latest version of the content as a byte array.
byte[]	getContentAsBytes(ContentReference contentReference, String version) Returns the specified version of the content as a byte array.
Optional<ContentMetadata>	getContentMetadata(ContentReference contentReference) Returns the metadata of the latest version of the content.
Optional<ContentMetadata>	getContentMetadata(ContentReference contentReference, String version) Returns the metadata of the supplied version of the content.
List<ContentProvider>	getContentProviders() Returns the ContentProviders.
Optional<ContentReference>	getContentReference(String contentReferenceId) Gets the content reference associated to the supplied ContentReferenceId.
List<ContentReference>	getContentReferences(String contentSourceId) Gets a list of all the content references associated to the supplied ContentSourceId.
List<String>	getContentVersions(ContentReference contentReference) Returns a list with all the versions of the content of the specified ContentReference.
ContentProvider	getDefaultContentProvider() Returns the default ContentProvider configured for the content manager instance.
void	processContent(ContentScope contentScope, ContentProcessor contentProcessor) Process all content with the given content processor
void	setContentListeners(List<ContentListener> contentListeners) Set the ContentListeners for the content manager.
void	setContentPreProcessingConfiguration(ContentPreProcessingConfiguration contentPreProcessingConfiguration) Set the ContentPreProcessingConfiguration which is required if you want to pre process the content added or updated in a separate job.
void	setContentSourceId(ContentReference contentReference, String contentSourceId) Sets the ContentSourceId for a selected ContentReference.
ContentReference	updateContent(ContentReference contentReference, org.springframework.core.io.Resource resource, long inputStreamLength, ContentMetadata contentMetadata) This method behaves exactly like calling ContentManager.updateContent(ContentReference, Resource, long, ContentMetadata, boolean) with the last parameter set to false.
ContentReference	updateContent(ContentReference contentReference, org.springframework.core.io.Resource resource, long inputStreamLength, ContentMetadata contentMetadata, boolean overwriteVersion) Updates the the content and the metadata of the specified ContentReference with the specified InputStream and ContentMetadata, with the option to overwrite te existing version.
void	updateContentMetadata(ContentReference contentReference, ContentMetadata contentMetadata) Updates the content metadata.

Methods inherited from class java.lang.Object

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

Field Detail

PRE_PROCESS_ORIGINAL_FILE_NAME

public static final String PRE_PROCESS_ORIGINAL_FILE_NAME

See Also:

Constant Field Values

PRE_PROCESS_PROCESSED_FILE_NAME

public static final String PRE_PROCESS_PROCESSED_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultConfigurableContentManager

public DefaultConfigurableContentManager(List<ContentProvider> contentProviders,
                                         CurrentTenantService currentTenantService,
                                         CurrentUserService currentUserService,
                                         org.springframework.transaction.PlatformTransactionManager transactionManager)

Constructor for the ConfigurableContentManager. It requires a list of content providers and the current tenant service. The first element of the list of content providers is considered to be the default one.

Parameters:

contentProviders - A list of content providers that can be used with this content manager.

currentTenantService - the current tenant service that will be used to establish the content scope of the content manager instance

currentUserService - the current user service used to get the current user for the content pre processing jobs

transactionManager - the transaction manager

Throws:

IllegalArgumentException - if the current tenant service is null or if the supplied list of content providers is null, if it contains null values or if it not contains at least a valid content provider

Method Detail

addContent

@Transactional
public ContentReference addContent(ContentInfo contentInfo,
                                                  org.springframework.core.io.Resource resource,
                                                  long inputStreamLength)

Description copied from interface: ContentManager

Add content with the specified ContentInfo and the content itself as InputStream. The provided InputStream will always be closed. This method triggers the ContentListener.contentAdded(ContentEvent) method of the registered content listeners.

Specified by:

addContent in interface ContentManager

Parameters:

contentInfo - the content info

resource - the content as input stream

inputStreamLength - the length of the input stream

Returns:

the content reference of the added content

getContent

@Transactional(readOnly=true)
public org.springframework.core.io.Resource getContent(ContentReference contentReference)

Description copied from interface: ContentManager

Returns the latest version of the content. The version of the specified ContentReference is not taken into account.

Specified by:

getContent in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as input stream of the specified content reference. Must be closed after the data has been read.

getContentAsBytes

@Transactional(readOnly=true)
public byte[] getContentAsBytes(ContentReference contentReference)

Description copied from interface: ContentManager

Returns the latest version of the content as a byte array.

Note	Whenever possible you should use the stream-based content access methods as they will allow large content to be processed without requiring that the whole content be loaded into memory at the same time.

Specified by:

getContentAsBytes in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as a byte array

getContent

@Transactional(readOnly=true)
public org.springframework.core.io.Resource getContent(ContentReference contentReference,
                                                                                     String version)

Description copied from interface: ContentManager

Returns the specified version of the content. The version of the specified ContentReference is not taken into account.

Specified by:

getContent in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

version - the version of the content to be returned

Returns:

the content as input stream of the specified content reference and its version. Must be closed after the data has been read.

getContentAsBytes

@Transactional(readOnly=true)
public byte[] getContentAsBytes(ContentReference contentReference,
                                                              String version)

Description copied from interface: ContentManager

Returns the specified version of the content as a byte array.

Note	Whenever possible you should use the stream-based content access methods as they will allow large content to be processed without requiring that the whole content be loaded into memory at the same time.

Specified by:

getContentAsBytes in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the content as a byte array

getContentMetadata

@Cacheable(value="edorasGear-contentMetadataByContentReferenceId",
           condition="#contentReference != null",
           key="#contentReference.getId()")
public Optional<ContentMetadata> getContentMetadata(ContentReference contentReference)

Description copied from interface: ContentManager

Returns the metadata of the latest version of the content. The version of the specified ContentReference is not taken into account.

Specified by:

getContentMetadata in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

Returns:

the Optional content metadata object of the specified content reference.

getContentMetadata

public Optional<ContentMetadata> getContentMetadata(ContentReference contentReference,
                                                    String version)

Description copied from interface: ContentManager

Returns the metadata of the supplied version of the content. The version of the specified ContentReference is not taken into account.

Specified by:

getContentMetadata in interface ContentManager

Parameters:

contentReference - the content reference of the content to be returned

version - the version

Returns:

the content metadata object of the specified content reference.

getContentVersions

@Transactional(readOnly=true)
 @Cacheable(value="edorasGear-contentVersionsByContentReferenceId",
           condition="#contentReference != null",
           key="#contentReference.getId()")
public List<String> getContentVersions(ContentReference contentReference)

Description copied from interface: ContentManager

Returns a list with all the versions of the content of the specified ContentReference. The first entry of the list holds the first version and the last entry the last one.

Specified by:

getContentVersions in interface ContentManager

Parameters:

contentReference - the content reference of the content versions to be returned

Returns:

a list with all the content versions

getContentReferences

@Transactional(readOnly=true)
 @Cacheable(value="edorasGear-contentReferencesByContentSourceId",
           condition="#contentSourceId != null",
           key="#contentSourceId")
public List<ContentReference> getContentReferences(String contentSourceId)

Description copied from interface: ContentManager

Gets a list of all the content references associated to the supplied ContentSourceId. In case of a multi-versioned content reference, the last version is retrieved.

Specified by:

getContentReferences in interface ContentManager

Parameters:

contentSourceId - the content source id

Returns:

the content references

getContentReference

@Transactional(readOnly=true)
public Optional<ContentReference> getContentReference(String contentReferenceId)

Description copied from interface: ContentManager

Gets the content reference associated to the supplied ContentReferenceId. In case of a multi-versioned content reference, the last version is retrieved.

Specified by:

getContentReference in interface ContentManager

Parameters:

contentReferenceId - the content reference id

Returns:

an optional content reference

updateContent

@Transactional
 @CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId"},key="#contentReference.getId()") @CacheEvict(value="edorasOne-previewedDocuments",key="#contentReference")
public ContentReference updateContent(ContentReference contentReference,
                                                                                                                                                                                                                                                                                            org.springframework.core.io.Resource resource,
                                                                                                                                                                                                                                                                                            long inputStreamLength,
                                                                                                                                                                                                                                                                                            ContentMetadata contentMetadata)

Description copied from interface: ContentManager

This method behaves exactly like calling ContentManager.updateContent(ContentReference, Resource, long, ContentMetadata, boolean) with the last parameter set to false.

Specified by:

updateContent in interface ContentManager

Parameters:

contentReference - the content reference to be updated

resource - the updated content as input stream

inputStreamLength - the length of the input stream

contentMetadata - the optional content metadata

Returns:

the content reference with the new version

updateContent

@Transactional
 @CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId"},key="#contentReference.getId()") @CacheEvict(value="edorasOne-previewedDocuments",key="#contentReference")
public ContentReference updateContent(ContentReference contentReference,
                                                                                                                                                                                                                                                                                            org.springframework.core.io.Resource resource,
                                                                                                                                                                                                                                                                                            long inputStreamLength,
                                                                                                                                                                                                                                                                                            ContentMetadata contentMetadata,
                                                                                                                                                                                                                                                                                            boolean overwriteVersion)

Description copied from interface: ContentManager

Updates the the content and the metadata of the specified ContentReference with the specified InputStream and ContentMetadata, with the option to overwrite te existing version. A new ContentReference will be returned with the new version set if the overwrite flag is set to false. The same ContentReference will be returned if the overwrite flag is set to true. The source id of the specified content reference must not be changed. The provided InputStream will always be closed. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Specified by:

updateContent in interface ContentManager

Parameters:

contentReference - the content reference to be updated

resource - the updated content as input stream

inputStreamLength - the length of the input stream

contentMetadata - the optional content metadata

overwriteVersion - true if the content that is about to be updated shall be overwritten, otherwise false

Returns:

the content reference with the new version (or the same if the overwrite flag is set to true)

updateContentMetadata

@CacheEvict(value="edorasGear-contentMetadataByContentReferenceId",key="#contentReference.getId()") @CacheEvict(value="edorasOne-previewedDocuments",key="#contentReference")
public void updateContentMetadata(ContentReference contentReference,
                                                                                                                                                                                                                ContentMetadata contentMetadata)

Description copied from interface: ContentManager

Updates the content metadata. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Specified by:

updateContentMetadata in interface ContentManager

Parameters:

contentReference - the content reference

contentMetadata - the content metadata

setContentSourceId

@CacheEvict(value="edorasGear-contentReferencesByContentSourceId",
            key="#contentSourceId")
public void setContentSourceId(ContentReference contentReference,
                                                                                                                                      String contentSourceId)

Description copied from interface: ContentManager

Sets the ContentSourceId for a selected ContentReference. All the versions of the content reference are updated. This method triggers the ContentListener.contentUpdated(ContentEvent) method of the registered content listeners.

Specified by:

setContentSourceId in interface ContentManager

Parameters:

contentReference - the content reference

contentSourceId - the content source id

deleteContent

@CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId","edorasGear-contentReferencesByContentSourceId","edorasOne-previewedDocuments"},
            allEntries=true)
public void deleteContent()

Description copied from interface: ConfigurableContentManager

Deletes all the content of the content manager. CAUTION: Double check what you are doing before calling this method. All the configured content providers are called to delete the content. This method is intended only for maintenance purposes. No ContentListener will be called upon a full content deletion.

Specified by:

deleteContent in interface ConfigurableContentManager

deleteContent

@Transactional
 @CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId"},key="#contentReference.getId()") @CacheEvict(value="edorasOne-previewedDocuments",key="#contentReference") @CacheEvict(value="edorasGear-contentReferencesByContentSourceId",allEntries=true)
public int deleteContent(ContentReference contentReference)

Description copied from interface: ContentManager

Deletes all versions of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Specified by:

deleteContent in interface ContentManager

Parameters:

contentReference - the content reference to be deleted

Returns:

the number of content versions deleted

deleteContent

@Transactional
 @CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId"},key="#contentReference.getId()") @CacheEvict(value="edorasOne-previewedDocuments",key="#contentReference") @CacheEvict(value="edorasGear-contentReferencesByContentSourceId",allEntries=true)
public void deleteContent(ContentReference contentReference,
                                                                                                                                                                                                                                                                                                                                                                   String version)

Description copied from interface: ContentManager

Deletes a specific version of the specified ContentReference such that the passed in ContentReference cannot be used anymore to retrieve content with that version. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Specified by:

deleteContent in interface ContentManager

Parameters:

contentReference - the content reference to be deleted

version - the version of the content to be deleted

deleteContent

@CacheEvict(cacheNames={"edorasGear-contentMetadataByContentReferenceId","edorasGear-contentVersionsByContentReferenceId","edorasOne-previewedDocuments"},allEntries=true) @CacheEvict(value="edorasGear-contentReferencesByContentSourceId",key="#contentSourceId")
public void deleteContent(String contentSourceId)

Description copied from interface: ContentManager

Deletes the content that is associated to the supplied ContentSourceId. All the configured content providers are called to delete the content. This method triggers the ContentListener.contentDeleted(ContentEvent, Optional) method of the registered content listeners.

Specified by:

deleteContent in interface ContentManager

Parameters:

contentSourceId - the content source id

addContentProvider

public void addContentProvider(ContentProvider contentProvider)

Description copied from interface: ConfigurableContentManager

Add a ContentProvider to the content manager.

Specified by:

addContentProvider in interface ConfigurableContentManager

Parameters:

contentProvider - the content provider to be added

setContentListeners

@Autowired(required=false)
public void setContentListeners(List<ContentListener> contentListeners)

Description copied from interface: ConfigurableContentManager

Set the ContentListeners for the content manager.

Specified by:

setContentListeners in interface ConfigurableContentManager

Parameters:

contentListeners - the list of content listeners to be added

setContentPreProcessingConfiguration

public void setContentPreProcessingConfiguration(ContentPreProcessingConfiguration contentPreProcessingConfiguration)

Description copied from interface: ConfigurableContentManager

Set the ContentPreProcessingConfiguration which is required if you want to pre process the content added or updated in a separate job.

Specified by:

setContentPreProcessingConfiguration in interface ConfigurableContentManager

Parameters:

contentPreProcessingConfiguration - the content pre processing configuration

getContentProviders

public List<ContentProvider> getContentProviders()

Description copied from interface: ConfigurableContentManager

Returns the ContentProviders.

Specified by:

getContentProviders in interface ConfigurableContentManager

Returns:

the content providers

getDefaultContentProvider

public ContentProvider getDefaultContentProvider()

Description copied from interface: ContentManager

Returns the default ContentProvider configured for the content manager instance.

Specified by:

getDefaultContentProvider in interface ContentManager

Returns:

the default content provider

processContent

public void processContent(ContentScope contentScope,
                           ContentProcessor contentProcessor)

Description copied from interface: ConfigurableContentManager

Process all content with the given content processor

Specified by:

processContent in interface ConfigurableContentManager

Parameters:

contentScope - contentScope for which content will be processed

contentProcessor - content processor which will be applied on all content