com.atlassian.confluence.core

Interface PluginDataSourceFactory

All Known Implementing Classes:

DefaultPluginDataSourceFactory

public interface PluginDataSourceFactory

Produces DataSources for plugin module resources.

Since:

5.2

See Also:

DataSourceFactory.forPlugin(String)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
default Optional<DataSource>	getResourceFromModuleByName(String moduleKey, String resourceName) Extract a resource identified by name from a module and expose it as DataSource.
default Optional<Iterable<DataSource>>	getResourcesFromModules(String moduleKey) Extract all resources from a module and expose them as DataSources.
Optional<Iterable<DataSource>>	getResourcesFromModules(String moduleKey, @Nullable Predicate<PluginDataSourceFactory.ResourceView> filter) Extract resources from a module and expose them as DataSources.
com.atlassian.fugue.Maybe<DataSource>	resourceFromModuleByName(String moduleKey, String resourceName) Deprecated. since 7.0.1. Use getResourceFromModuleByName(String, String)
com.atlassian.fugue.Maybe<Iterable<DataSource>>	resourcesFromModules(String moduleKey) Deprecated. since 7.0.1. Use getResourcesFromModules(String)

Method Detail

getResourcesFromModules

Optional<Iterable<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

resourcesFromModules

@Deprecated
com.atlassian.fugue.Maybe<Iterable<DataSource>> resourcesFromModules(String moduleKey)

Deprecated. since 7.0.1. Use getResourcesFromModules(String)

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

See Also:

getResourcesFromModules(String, Predicate)

getResourcesFromModules

default Optional<Iterable<DataSource>> getResourcesFromModules(String moduleKey)

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

Since:

7.0.1

See Also:

getResourcesFromModules(String, Predicate)

resourceFromModuleByName

@Deprecated
com.atlassian.fugue.Maybe<DataSource> resourceFromModuleByName(String moduleKey,
                                                                           String resourceName)

Deprecated. since 7.0.1. Use getResourceFromModuleByName(String, String)

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

getResourceFromModuleByName

default Optional<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