Package com.pullreports.model.config

Class CatalogConfiguration

Object

com.pullreports.model.config.CatalogConfiguration

public class CatalogConfiguration
extends Object

A CatalogConfiguration is a collection of one or more ReportConfigurations that all share the same directory path within the Pull Reports REST API. Group ReportConfigurations into a CatalogConfiguration to share common configuration such as database connectivity, security, or export decoration.

During Pull Reports initialization, CatalogConfigurations are parsed from Catalog XML configuration files or provided by CatalogConfigurationFactorys.

Schema analog: <catalog>

See Also:

• CatalogConfigurationFactory

Constructor Summary

Constructors

Constructor	Description
CatalogConfiguration(CatalogId id, String name, List<ReportConfiguration> reportConfigurations)
CatalogConfiguration(CatalogId id, String name, List<ReportConfiguration> reportConfigurations, AccessControlVoter accessControlVoter)

Method Summary

Modifier and Type	Method	Description
Optional<AccessControlVoter>	getAccessControlVoter()	An Optional which returns the AccessControlVoter for this CatalogConfiguration or the empty Optional.
CatalogId	getId()	Returns the unique Catalog id.
String	getName()	Returns the human-readable Catalog name.
List<ReportConfiguration>	getReportConfigurations()	Returns a List of one or more ReportConfigurations associated with this CatalogConfiguration.

Methods inherited from class java.lang.Object

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

Constructor Details

CatalogConfiguration

public CatalogConfiguration(CatalogId id,
 String name,
 List<ReportConfiguration> reportConfigurations)

CatalogConfiguration

public CatalogConfiguration(CatalogId id,
 String name,
 List<ReportConfiguration> reportConfigurations,
 AccessControlVoter accessControlVoter)

Method Details

getId

public CatalogId getId()

Returns the unique Catalog id. This id forms part of the Pull Reports REST API URL path.

Returns:

the unique Catalog id.

getName

public String getName()

Returns the human-readable Catalog name.

Returns:

the human-readable catalog name.

getReportConfigurations

public List<ReportConfiguration> getReportConfigurations()

Returns a List of one or more ReportConfigurations associated with this CatalogConfiguration.

Returns:

the List of ReportConfigurations associated with this Catalog.

getAccessControlVoter

public Optional<AccessControlVoter> getAccessControlVoter()

An Optional which returns the AccessControlVoter for this CatalogConfiguration or the empty Optional. The AccessControlVoter, if present, controls Pull Reports REST API access to the Catalog.

Returns:

The CatalogConfiguration's AccessControlVoter Optional or the empty Optional.