com.atlassian.confluence.plugins.contentproperty

Class ContentPropertyServiceImpl

java.lang.Object

com.atlassian.confluence.plugins.contentproperty.ContentPropertyServiceImpl

All Implemented Interfaces:

ContentPropertyService

public class ContentPropertyServiceImpl
extends Object
implements ContentPropertyService

Server implementation of the ContentPropertyService. Contrast with the RemoteContentPropertyService.

Since:

5.6

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.api.service.content.ContentPropertyService

ContentPropertyService.ContentPropertyFetcher, ContentPropertyService.ContentPropertyFinder, ContentPropertyService.ParameterContentPropertyFinder, ContentPropertyService.SingleContentPropertyFetcher, ContentPropertyService.Validator

Field Summary

Fields inherited from interface com.atlassian.confluence.api.service.content.ContentPropertyService

MAXIMUM_KEY_LENGTH, MAXIMUM_PROPERTIES_PER_PAGE_REQUEST, MAXIMUM_VALUE_LENGTH

Constructor Summary

Constructors

Constructor and Description
ContentPropertyServiceImpl(CustomContentManager customContentManager, JsonPropertyFactory jsonPropertyFactory, StorageJsonPropertyManager storageContentPropertyManager, ContentPropertyFinderFactory contentPropertyFinderFactory, ContentPropertyService.Validator validator, ConfluenceIndexer confluenceIndexer)

Method Summary

Modifier and Type	Method and Description
JsonContentProperty	create(JsonContentProperty newProperty) Create a content property.
void	delete(JsonContentProperty property) Removes a content property from the system.
ContentPropertyService.ContentPropertyFinder	find(Expansion... expansions) Create a ContentPropertyService.ContentPropertyFinder for locating content, the expansions will be applied to each property that matches the finder.
JsonContentProperty	update(JsonContentProperty property) Updates a content property.
ContentPropertyService.Validator	validator()

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentPropertyServiceImpl

public ContentPropertyServiceImpl(CustomContentManager customContentManager,
                                  JsonPropertyFactory jsonPropertyFactory,
                                  StorageJsonPropertyManager storageContentPropertyManager,
                                  ContentPropertyFinderFactory contentPropertyFinderFactory,
                                  ContentPropertyService.Validator validator,
                                  ConfluenceIndexer confluenceIndexer)

Method Detail

find

public ContentPropertyService.ContentPropertyFinder find(Expansion... expansions)

Description copied from interface: ContentPropertyService

Create a ContentPropertyService.ContentPropertyFinder for locating content, the expansions will be applied to each property that matches the finder. JsonContentProperty objects will be retrieved by using the fetch methods on the returned ContentPropertyFinder.

Specified by:

find in interface ContentPropertyService

Parameters:

expansions - properties to expand

Returns:

the finder

create

public JsonContentProperty create(JsonContentProperty newProperty)
                           throws ServiceException

Description copied from interface: ContentPropertyService

Create a content property.

Specified by:

create in interface ContentPropertyService

Parameters:

newProperty - the property to create

Returns:

the property created

Throws:

ServiceException - if the property cannot be created

update

public JsonContentProperty update(JsonContentProperty property)
                           throws ServiceException

Description copied from interface: ContentPropertyService

Updates a content property.

Specified by:

update in interface ContentPropertyService

Parameters:

property - the updated JsonContentProperty with metadata about the change

Returns:

the updated content after being persisted

Throws:

ServiceException

delete

public void delete(JsonContentProperty property)
            throws ServiceException

Description copied from interface: ContentPropertyService

Removes a content property from the system.

Specified by:

delete in interface ContentPropertyService

Parameters:

property - the content property to remove

Throws:

ServiceException - if the content property cannot be found, or cannot be deleted

validator

public ContentPropertyService.Validator validator()

Specified by:

validator in interface ContentPropertyService

Returns:

the validator view of the ContentPropertyService.