com.atlassian.confluence.api.impl.service.audit.uri

Interface ResourceUriGenerator

All Known Implementing Classes:

AttachmentUriGenerator, CommentUriGenerator, GroupUriGenerator, PageUriGenerator, ResourceUriGenerator.NoopGenerator, SpaceUriGenerator, UserUriGenerator

public interface ResourceUriGenerator

Defines how links to resources should be generated

Since:

7.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceUriGenerator.NoopGenerator

Method Summary

Modifier and Type	Method and Description
Map<String,URI>	generate(URI baseUrl, Set<String> identifiers) For each of the identifiers in identifiers set calculate the corresponding URI and return a mapping from the identifier to this URI.

Method Detail

generate

Map<String,URI> generate(URI baseUrl,
                         Set<String> identifiers)

For each of the identifiers in identifiers set calculate the corresponding URI and return a mapping from the identifier to this URI. If the identifier doesn't have corresponding URI, the map shouldn't include it. The URI is calculated with respect to provided baseUrl.

This method signature receives a Set and returns a Map to make possible potential optimizations from using batch operations (for example the implementation might fetch several records in a single database query).

Returns:

a map with a key set being a subset of identifiers. For each identifier key the value of the map is a corresponding URI of the resource.