com.atlassian.confluence.content

Class DefaultCustomContentManager

java.lang.Object

com.atlassian.confluence.core.DefaultContentEntityManager

com.atlassian.confluence.content.DefaultCustomContentManager

All Implemented Interfaces:

CustomContentManager, ContentEntityManager, ContentDraftManagerInternal, ContentEntityManagerInternal

@ParametersAreNonnullByDefault
public class DefaultCustomContentManager
extends DefaultContentEntityManager
implements CustomContentManager

Generic manager for pluggable content.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.content.CustomContentManager

CustomContentManager.SortField, CustomContentManager.SortOrder

Field Summary

Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager

ITERATE_ALL

Constructor Summary

Constructors

Constructor and Description

DefaultCustomContentManager(CustomContentDao customContentDao, LinkManager linkManager, ConfluenceIndexer indexer, LabelManager labelManager, AttachmentManager attachmentManager, HibernateSessionManager hibernateSessionManager, com.google.common.base.Supplier<XhtmlContent> xhtmlContent, com.atlassian.event.api.EventPublisher eventPublisher, NotificationManager notificationManager, ContentTypeManager contentTypeManager, RelationManager relationManager, ContentFactory contentFactory, com.google.common.base.Supplier<UserAccessor> userAccessor)

Method Summary

Modifier and Type	Method and Description
long	countChildrenOfType(CustomContentEntityObject content, String contentModuleKey) Get the total number of children of a piece of content with the given type
Iterator<CustomContentEntityObject>	findAllChildren(CustomContentEntityObject content) Get an iterator of all children of a piece of content.
Iterator<CustomContentEntityObject>	findAllContainedOfType(long containerContentId, String pluginModuleKey) Get an iterator of contained content of a piece of content with a given type.
Collection<CustomContentEntityObject>	findAllInSpace(Space space) Deprecated.
<T> PageResponse<T>	findByQuery(ContentQuery<T> query, boolean cacheable, LimitedRequest request, com.google.common.base.Predicate<T> predicate) Get the results of a query for CustomContentEntityObjects
<T> Iterator<T>	findByQuery(ContentQuery<T> query, int offset, int maxResults) Get the results of a query for CustomContentEntityObjects
Iterator<CustomContentEntityObject>	findChildrenOfType(CustomContentEntityObject content, String pluginContentKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder) Get an iterator of children of a piece of content with a given type.
Iterator<CustomContentEntityObject>	findCurrentInSpace(Space space, String pluginContentKey, int offset, int maxResults, CustomContentManager.SortField sortField, CustomContentManager.SortOrder sortOrder) Get an iterator of all the current, non-deleted content of the given type in the given space.
<T> T	findFirstObjectByQuery(ContentQuery<T> query) Find the first result of a query for CustomContentEntityObjects.
int	findTotalInSpace(Space space, String pluginContentKey) Get the total count of current, non-deleted content of the given type in the given space.
CustomContentEntityObject	getById(long id) Find a single CustomContentEntityObject by its id
PageResponse<Content>	getChildrenOfType(ContentEntityObject entity, String contentModuleKey, LimitedRequest limitedRequest, Expansions expansions, Depth depth, com.google.common.base.Predicate<? super CustomContentEntityObject> predicate) Returns the children of a CustomContentEntityObject, limited to the pagination requested.
CustomContentEntityObject	newPluginContentEntityObject(String contentModuleKey) Create a new CustomContentEntityObject for the given module.
protected void	publishCreateEvent(ContentEntityObject obj) This method publishes *CreateEventss.
protected void	publishCreateEvent(ContentEntityObject obj, SaveContext saveContext)
protected void	publishRemoveEvent(ContentEntityObject obj) This method publishes *RemoveEvents.
protected void	publishUpdateEvent(ContentEntityObject obj, ContentEntityObject origObj, SaveContext saveContext) This method publishes *UpdateEvents.
void	removeAllInSpace(String pluginContentKey, Space space) Remove all plugin content of a particular type from a given space.
void	removeAllPluginContent(String contentModuleKey) Remove all plugin content of a particular type
void	removeAllPluginContentInSpace(Space space) Remove all plugin content (of all types) from a given space.
void	removeContentEntity(ContentEntityObject obj) Removes given content entity object and all associated domain objects i.e.
void	setContentFactory(ContentFactory contentFactory)
void	setContentTypeManager(ContentTypeManager contentTypeManager)
CustomContentEntityObject	updatePluginModuleKey(CustomContentEntityObject content, String pluginModuleKey) Update the type of an existing CustomContentEntityObject with the specified module key.

Methods inherited from class com.atlassian.confluence.core.DefaultContentEntityManager

createDraft, findDraftFor, findDraftFor, findUnpublishedContentWithUserContributions, getAttachmentManager, getBodyContentForRevert, getById, getById, getByIds, getContentEntityObjectDao, getEventPublisher, getHibernateSessionManager, getIndexer, getLabelManager, getLinkManager, getNextVersion, getNotificationManager, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageDao, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion, setAttachmentManager, suppressNotificationsOnEventIfRequired, updateContentLinkingTo, updateContentLinkingTo, updateOutgoingLinksInContent, updateOutgoingLinksInContent, updateSingleContentLinkinTo, updateSingleContentLinkinTo, updateSingleContentLinkinTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.content.CustomContentManager

saveContentEntity

Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager

getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveNewVersion, saveNewVersion, updateContentLinkingTo, updateOutgoingLinksInContent, updateSingleContentLinkinTo, updateSingleContentLinkinTo

Constructor Detail

DefaultCustomContentManager

public DefaultCustomContentManager(CustomContentDao customContentDao,
                                   LinkManager linkManager,
                                   ConfluenceIndexer indexer,
                                   LabelManager labelManager,
                                   AttachmentManager attachmentManager,
                                   HibernateSessionManager hibernateSessionManager,
                                   com.google.common.base.Supplier<XhtmlContent> xhtmlContent,
                                   com.atlassian.event.api.EventPublisher eventPublisher,
                                   NotificationManager notificationManager,
                                   ContentTypeManager contentTypeManager,
                                   RelationManager relationManager,
                                   ContentFactory contentFactory,
                                   com.google.common.base.Supplier<UserAccessor> userAccessor)

Method Detail

newPluginContentEntityObject

@Nonnull
public CustomContentEntityObject newPluginContentEntityObject(String contentModuleKey)

Description copied from interface: CustomContentManager

Create a new CustomContentEntityObject for the given module. This method will ensure that the plugin delegate and various necessary arguments are set.

Specified by:

newPluginContentEntityObject in interface CustomContentManager

Parameters:

contentModuleKey - the module complete key of the content's ContentAdapter module

Returns:

a blank entity object for that plugin

updatePluginModuleKey

@Nonnull
public CustomContentEntityObject updatePluginModuleKey(CustomContentEntityObject content,
                                                                String pluginModuleKey)

Description copied from interface: CustomContentManager

Update the type of an existing CustomContentEntityObject with the specified module key.

Specified by:

updatePluginModuleKey in interface CustomContentManager

pluginModuleKey - the module complete key of the content's ContentAdapter module

Returns:

a blank entity object for that plugin

getById

@Nullable
public CustomContentEntityObject getById(long id)

Description copied from interface: CustomContentManager

Find a single CustomContentEntityObject by its id

Specified by:

getById in interface CustomContentManager

Specified by:

getById in interface ContentEntityManager

Overrides:

getById in class DefaultContentEntityManager

Parameters:

id - the ID of the entity to retrieve

Returns:

ContentEntityObject with the given id.

findByQuery

@Nonnull
public <T> Iterator<T> findByQuery(ContentQuery<T> query,
                                            int offset,
                                            int maxResults)

Description copied from interface: CustomContentManager

Get the results of a query for CustomContentEntityObjects

Specified by:

findByQuery in interface CustomContentManager

Parameters:

query - the query to perform

offset - the first result to return

maxResults - the maximum number of results to return

Returns:

an iterator of the results of the query

findByQuery

@Nonnull
public <T> PageResponse<T> findByQuery(ContentQuery<T> query,
                                                boolean cacheable,
                                                LimitedRequest request,
                                                com.google.common.base.Predicate<T> predicate)

Description copied from interface: CustomContentManager

Get the results of a query for CustomContentEntityObjects

Specified by:

findByQuery in interface CustomContentManager

Parameters:

query - the query to perform

cacheable - whether the results for the given query can be cached

request - the limited pagination request

predicate - the filter to apply to the results

Returns:

a PageResponse of the results of the query, after filtering with the given predicate

findFirstObjectByQuery

@Nullable
public <T> T findFirstObjectByQuery(ContentQuery<T> query)

Description copied from interface: CustomContentManager

Find the first result of a query for CustomContentEntityObjects. This is a convenience method for queries where we expect to only retrieve a single result.

Specified by:

findFirstObjectByQuery in interface CustomContentManager

Parameters:

query - the query to perform

Returns:

the first result of the query, or null if no results are returned

findTotalInSpace

public int findTotalInSpace(Space space,
                            String pluginContentKey)

Description copied from interface: CustomContentManager

Get the total count of current, non-deleted content of the given type in the given space.

Specified by:

findTotalInSpace in interface CustomContentManager

Parameters:

space - the space to count content in

pluginContentKey - the plugin module complete key of the content to be searched for

Returns:

the total number of non-deleted, non-historical versions of content of the given type in that space

findCurrentInSpace

@Nonnull
public Iterator<CustomContentEntityObject> findCurrentInSpace(Space space,
                                                                       String pluginContentKey,
                                                                       int offset,
                                                                       int maxResults,
                                                                       CustomContentManager.SortField sortField,
                                                                       CustomContentManager.SortOrder sortOrder)

Description copied from interface: CustomContentManager

Get an iterator of all the current, non-deleted content of the given type in the given space.

Specified by:

findCurrentInSpace in interface CustomContentManager

Parameters:

space - the space to retrieve content from

pluginContentKey - the plugin module complete key of the content to be searched for

sortField - what field to sort the content on

sortOrder - which direction to sort the content in

Returns:

an iterator of the non-deleted, non-historical versions of content of the given type in that space

countChildrenOfType

public long countChildrenOfType(CustomContentEntityObject content,
                                String contentModuleKey)

Description copied from interface: CustomContentManager

Get the total number of children of a piece of content with the given type

Specified by:

countChildrenOfType in interface CustomContentManager

Parameters:

content - the content to look for children of

contentModuleKey - the module key for the type of child to look for

Returns:

the number of available children of that type

findChildrenOfType

@Nonnull
public Iterator<CustomContentEntityObject> findChildrenOfType(CustomContentEntityObject content,
                                                                       String pluginContentKey,
                                                                       int offset,
                                                                       int maxResults,
                                                                       CustomContentManager.SortField sortField,
                                                                       CustomContentManager.SortOrder sortOrder)

Description copied from interface: CustomContentManager

Get an iterator of children of a piece of content with a given type.

Specified by:

findChildrenOfType in interface CustomContentManager

Parameters:

content - the content to look for children of

pluginContentKey - the module key of the type of child to look for

offset - the offset of the first result

maxResults - the maximum total results to return

sortField - what field to sort the content on

sortOrder - which direction to sort the content in

getChildrenOfType

@Nonnull
public PageResponse<Content> getChildrenOfType(ContentEntityObject entity,
                                                        String contentModuleKey,
                                                        LimitedRequest limitedRequest,
                                                        Expansions expansions,
                                                        Depth depth,
                                                        com.google.common.base.Predicate<? super CustomContentEntityObject> predicate)

Description copied from interface: CustomContentManager

Returns the children of a CustomContentEntityObject, limited to the pagination requested. This method will return children that have the entity as a container, and children that have the entity as a parent.

Specified by:

getChildrenOfType in interface CustomContentManager

Parameters:

entity - the content to look for children of

contentModuleKey - the module key of the type of child to look for

limitedRequest - the pagination requested

expansions - the expansions applied to results

depth - the depth to return children to

predicate - predicates used to filter the CustomContentEntityObjects

Returns:

findAllChildren

@Nonnull
public Iterator<CustomContentEntityObject> findAllChildren(CustomContentEntityObject content)

Description copied from interface: CustomContentManager

Get an iterator of all children of a piece of content.

Specified by:

findAllChildren in interface CustomContentManager

Parameters:

content - the content to look for children of

findAllContainedOfType

@Nonnull
public Iterator<CustomContentEntityObject> findAllContainedOfType(long containerContentId,
                                                                           String pluginModuleKey)

Description copied from interface: CustomContentManager

Get an iterator of contained content of a piece of content with a given type.

Specified by:

findAllContainedOfType in interface CustomContentManager

Parameters:

containerContentId - the content id of the content to look contained for

pluginModuleKey - the module key of the type of contained to look for

removeAllInSpace

public void removeAllInSpace(String pluginContentKey,
                             Space space)

Description copied from interface: CustomContentManager

Remove all plugin content of a particular type from a given space.

Specified by:

removeAllInSpace in interface CustomContentManager

Parameters:

pluginContentKey - the plugin module complete key of the content to be searched for

space - the space from which to delete all content of that type

publishCreateEvent

protected void publishCreateEvent(ContentEntityObject obj)

Description copied from class: DefaultContentEntityManager

This method publishes *CreateEventss. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishCreateEvent in class DefaultContentEntityManager

Parameters:

obj - the created content entity object

publishCreateEvent

protected void publishCreateEvent(ContentEntityObject obj,
                                  @Nullable
                                  SaveContext saveContext)

Overrides:

publishCreateEvent in class DefaultContentEntityManager

publishUpdateEvent

protected void publishUpdateEvent(ContentEntityObject obj,
                                  @Nullable
                                  ContentEntityObject origObj,
                                  @Nullable
                                  SaveContext saveContext)

Description copied from class: DefaultContentEntityManager

This method publishes *UpdateEvents. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishUpdateEvent in class DefaultContentEntityManager

Parameters:

obj - the updated content entity object

origObj - the old version of the content entity object, for history purpose

saveContext - the associated SaveContext

publishRemoveEvent

protected void publishRemoveEvent(ContentEntityObject obj)

Description copied from class: DefaultContentEntityManager

This method publishes *RemoveEvents. Specific content entity object manager that need to publish those events should override this method.

Overrides:

publishRemoveEvent in class DefaultContentEntityManager

Parameters:

obj - the removed content entity object

removeAllPluginContentInSpace

public void removeAllPluginContentInSpace(Space space)

Description copied from interface: CustomContentManager

Remove all plugin content (of all types) from a given space. This usually happens when a space is removed. Plugins wishing to perform extra work on space removal should listen for the PluginContentWillBeRemovedForSpaceEvent event.

Specified by:

removeAllPluginContentInSpace in interface CustomContentManager

removeAllPluginContent

public void removeAllPluginContent(String contentModuleKey)

Description copied from interface: CustomContentManager

Remove all plugin content of a particular type

Specified by:

removeAllPluginContent in interface CustomContentManager

Parameters:

contentModuleKey - the plugin module complete key of the content to be searched for

removeContentEntity

public void removeContentEntity(ContentEntityObject obj)

Description copied from interface: ContentEntityManager

Removes given content entity object and all associated domain objects i.e. if we remove a page it removes all its labels and attachments

Specified by:

removeContentEntity in interface ContentEntityManager

Overrides:

removeContentEntity in class DefaultContentEntityManager

findAllInSpace

@Deprecated
 @Nonnull
public Collection<CustomContentEntityObject> findAllInSpace(Space space)

Deprecated.

This method is required for space exports to work properly. Which is a good sign that space exports are evil and need to be rewritten. If you call it from anywhere else, I will kill a puppy.

Specified by:

findAllInSpace in interface CustomContentManager

Parameters:

space - a space

Returns:

all plugin content within that space

setContentTypeManager

public void setContentTypeManager(ContentTypeManager contentTypeManager)

setContentFactory

public void setContentFactory(ContentFactory contentFactory)