com.atlassian.confluence.api.extension

Interface ModelMetadataProvider

@PublicSpi
public interface ModelMetadataProvider

Provides additional metadata such as Likes and Watches to API Model objects.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,?>	getMetadata(java.lang.Object entity, Expansions expansions) Returns keyed metadata based on the passed entity and the expansions.
java.util.Map<java.lang.Object,java.util.Map<java.lang.String,?>>	getMetadataForAll(java.lang.Iterable<java.lang.Object> entities, Expansions expansions) Fetches metadata for a list of entities, returning a map of maps of metadata.
java.util.List<java.lang.String>	getMetadataProperties() get the list of properties that the MetadataProvider provides metadata for

Method Detail

getMetadata

java.util.Map<java.lang.String,?> getMetadata(java.lang.Object entity,
                                            Expansions expansions)

Returns keyed metadata based on the passed entity and the expansions.

Parameters:

entity - a Confluence API object (e.g. Content, Space)

expansions - indicating which metadata (and at which depth) to include

Returns:

Jackson-serializable metadata keyed by globally-unique strings, else an empty Map

getMetadataForAll

java.util.Map<java.lang.Object,java.util.Map<java.lang.String,?>> getMetadataForAll(java.lang.Iterable<java.lang.Object> entities,
                                                                                  Expansions expansions)

Fetches metadata for a list of entities, returning a map of maps of metadata. Initially keyed by the entity, and then by the metadata property. Implementors should attempt to fetch the metadata efficiently and try to avoid performing an individual query per entity.

Parameters:

entities - - a list of entities to fetch the metadata for

expansions - - indicating which metadata (and at which depth) should be fetched for each entity

Returns:

a map of maps of metadata, keyed by entity.

getMetadataProperties

java.util.List<java.lang.String> getMetadataProperties()

get the list of properties that the MetadataProvider provides metadata for

Returns: