Package com.atlassian.confluence.core

Interface PluginDataSourceFactory

All Known Implementing Classes:

DefaultPluginDataSourceFactory

public interface PluginDataSourceFactory

Produces DataSources for plugin module resources.

Since:

5.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PluginDataSourceFactory.FilterByType
static interface	PluginDataSourceFactory.ResourceView	A view on the ResourceDescriptor.

Method Summary

Modifier and Type	Method	Description
Optional<javax.activation.DataSource>	getResourceFromModuleByName(String moduleKey, String resourceName)	Extract a resource identified by name from a module and expose it as DataSource.
Optional<Iterable<javax.activation.DataSource>>	getResourcesFromModules(String moduleKey)	Extract all resources from a module and expose them as DataSources.
Optional<Iterable<javax.activation.DataSource>>	getResourcesFromModules(String moduleKey, @Nullable Predicate<PluginDataSourceFactory.ResourceView> filter)	Extract resources from a module and expose them as DataSources.

Method Details

getResourcesFromModules

Optional<Iterable<javax.activation.DataSource>> getResourcesFromModules(String moduleKey,
 @Nullable Predicate<PluginDataSourceFactory.ResourceView> filter)

Extract resources from a module and expose them as DataSources.

Parameters:

moduleKey - the key used to locate the module

filter - an optional filter for resources

Returns:

maybe the DataSources if the module could be located, the container is empty if the filter did not match anything

Since:

7.0.1

getResourcesFromModules

Optional<Iterable<javax.activation.DataSource>> getResourcesFromModules(String moduleKey)

Extract all resources from a module and expose them as DataSources.

Since:

7.0.1

See Also:

• getResourcesFromModules(String, Predicate)

getResourceFromModuleByName

Optional<javax.activation.DataSource> getResourceFromModuleByName(String moduleKey,
 String resourceName)

Extract a resource identified by name from a module and expose it as DataSource.

Parameters:

moduleKey - the key used to locate the module

resourceName - the name of the resource

Returns:

maybe the DataSource if the module could be located and contained a resource with the given name

Since:

7.0.1