Class OMRSConfigurationFactory

java.lang.Object
org.odpi.openmetadata.repositoryservices.admin.OMRSConfigurationFactory

public class OMRSConfigurationFactory extends Object
OMRSConfigurationFactory sets up default configuration for the OMRS components. It is used by the OMAG server while it manages the changes made to the server configuration by the server administrator. The aim is to build up the RepositoryServicesConfig object that is used to initialize the OMRSOperationalServices.
  • Constructor Details

    • OMRSConfigurationFactory

      public OMRSConfigurationFactory()
      Default constructor
  • Method Details

    • getInMemoryLocalRepositoryConfig

      public LocalRepositoryConfig getInMemoryLocalRepositoryConfig(String localServerName, String localServerURL)
      Return the configuration for an in-memory local repository.
      Parameters:
      localServerName - name of the local server
      localServerURL - URL root of local server used for REST calls
      Returns:
      LocalRepositoryConfig object
    • getLocalGraphLocalRepositoryConfig

      public LocalRepositoryConfig getLocalGraphLocalRepositoryConfig(String localServerName, String localServerURL, Map<String,Object> storageProperties)
      Return the configuration for a local repository that is using the built-in graph repository.
      Parameters:
      localServerName - name of local server
      localServerURL - URL root of local server used for REST calls
      storageProperties - properties used to configure Egeria Graph DB
      Returns:
      LocalRepositoryConfig object
    • getXTDBInMemLocalRepository

      public LocalRepositoryConfig getXTDBInMemLocalRepository(String localServerName, String localServerURL)
      Return the configuration for a local repository that is using the built-in XTDB in-memory repository.
      Parameters:
      localServerName - name of local server
      localServerURL - URL root of local server used for REST calls
      Returns:
      LocalRepositoryConfig object
    • getXTDBKVLocalRepository

      public LocalRepositoryConfig getXTDBKVLocalRepository(String localServerName, String localServerURL)
      Return the configuration for a local repository that is using the built-in XTDB KV (RocksDB) repository.
      Parameters:
      localServerName - name of local server
      localServerURL - URL root of local server used for REST calls
      Returns:
      LocalRepositoryConfig object
    • XTDBLocalRepository

      public LocalRepositoryConfig XTDBLocalRepository(String localServerName, String localServerURL, Map<String,Object> storageProperties)
      Return the configuration for a local repository that is using the built-in XTDB repository. Details of the storage backend to use are supplied in the storageProperties.
      Parameters:
      localServerName - name of local server
      localServerURL - URL root of local server used for REST calls
      storageProperties - properties used to configure Egeria XTDB DB
      Returns:
      LocalRepositoryConfig object
    • getReadOnlyLocalRepositoryConfig

      public LocalRepositoryConfig getReadOnlyLocalRepositoryConfig(String localServerName, String localServerURL)
      Return the configuration for an in-memory local repository.
      Parameters:
      localServerName - name of the local server
      localServerURL - URL root of local server used for REST calls
      Returns:
      LocalRepositoryConfig object
    • getPluginRepositoryLocalRepositoryConfig

      public LocalRepositoryConfig getPluginRepositoryLocalRepositoryConfig(String localServerName, String localServerURL)
      Return the local repository configuration for a plugin repository.
      Parameters:
      localServerName - name of local server
      localServerURL - url used to call local server
      Returns:
      LocalRepositoryConfig object
    • getRepositoryProxyLocalRepositoryConfig

      public LocalRepositoryConfig getRepositoryProxyLocalRepositoryConfig(String localServerName, String localServerURL)
      Return the local repository configuration for a repository proxy.
      Parameters:
      localServerName - name of local server
      localServerURL - url used to call local server
      Returns:
      LocalRepositoryConfig object
    • getDefaultEnterpriseAccessConfig

      public EnterpriseAccessConfig getDefaultEnterpriseAccessConfig(String localServerName, String localServerId)
      Return the default settings for the enterprise repository services' configuration. Note the remote enterprise topic connector is null. This is only set up by an explicit call.
      Parameters:
      localServerName - name of the local server
      localServerId - identifier of the server - used to pick up the right offset for the inbound messages.
      Returns:
      EnterpriseAccessConfig parameters
    • getDefaultCohortConfig

      public CohortConfig getDefaultCohortConfig(String localServerName, String cohortName, CohortTopicStructure cohortTopicStructure, Map<String,Object> configurationProperties, String eventBusConnectorProvider, String topicURLRoot, String serverId, Map<String,Object> eventBusConfigurationProperties)
      Return a CohortConfig object that is pre-configured with default values.
      Parameters:
      localServerName - name of the local server
      cohortName - name of the cohort
      cohortTopicStructure - the style of cohort topic set up to use
      configurationProperties - name value property pairs for the topic connection
      eventBusConnectorProvider - class name of the event bus connector's provider
      topicURLRoot - root name for the topic URL
      serverId - identifier of the server - used to pick up the right offset for the inbound messages.
      eventBusConfigurationProperties - name value property pairs for the event bus connection
      Returns:
      default values in a CohortConfig object
    • getDefaultRepositoryServicesConfig

      public RepositoryServicesConfig getDefaultRepositoryServicesConfig()
      Returns a repository services config with the audit log set up.
      Returns:
      minimally configured repository services config