Package org.odpi.openmetadata.adminservices.configuration.properties

Class LocalRepositoryConfig

java.lang.Object
org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
org.odpi.openmetadata.adminservices.configuration.properties.LocalRepositoryConfig
All Implemented Interfaces:
Serializable
public class LocalRepositoryConfig extends AdminServicesConfigHeader
LocalRepositoryConfig provides the properties to control the behavior of the metadata repository associated with this server.
  • metadataCollectionId - unique id of local repository's metadata collection. If this value is set to null, the server will generate a unique Id.
  • metadataCollectionName - display name of local repository's metadata collection. If this value is set to null, the server will use the local server name.
  • localRepositoryLocalConnection - the connection properties used to create a locally optimized connector to the local repository for use by this local server's components. If this value is null then the localRepositoryRemoteConnection is used.
  • localRepositoryRemoteConnection - the connection properties used to create a connector to the local repository for use by remote servers.
  • eventsToSaveRule - enumeration describing which open metadata repository events should be saved to the local repository.
  • selectedTypesToSave - list of TypeDefs in supported of the eventsToSave.SELECTED_TYPES option.
  • eventsToSendRule - enumeration describing which open metadata repository events should be sent from the local repository.
  • selectedTypesToSend - list of TypeDefs in supported of the eventsToSend.SELECTED_TYPES option.
  • eventMapperConnection - the connection properties for the event mapper for the local repository. The event mapper is an optional component used when the local repository has proprietary external APIs that can change metadata in the repository without going through the OMRS interfaces. It maps the proprietary events from the local repository to the OMRS Events.
See Also:

  • Constructor Details

    • LocalRepositoryConfig

      public LocalRepositoryConfig()
      Default constructor used for JSON to Java processes - does not do anything useful because all local variables are initialized to null in their declaration.

    • LocalRepositoryConfig

      public LocalRepositoryConfig(LocalRepositoryConfig template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getMetadataCollectionId

      public String getMetadataCollectionId()
      Return the unique id of local repository's metadata collection. If this value is set to null, the server will generate a unique Id.
      Returns:
      String unique Id

    • setMetadataCollectionId

      public void setMetadataCollectionId(String metadataCollectionId)
      Set up the unique id of local repository's metadata collection. If this value is set to null, the server will generate a unique Id.
      Parameters:
      metadataCollectionId - String unique Id

    • getMetadataCollectionName

      public String getMetadataCollectionName()
      Return the display name of the metadata collection. (The local server name is used if this is null).
      Returns:
      string name

    • setMetadataCollectionName

      public void setMetadataCollectionName(String metadataCollectionName)
      Set up the display name of the metadata collection. (The local server name is used if this is null).
      Parameters:
      metadataCollectionName - string name

    • getLocalRepositoryMode

      public LocalRepositoryMode getLocalRepositoryMode()
      Return the mode that the local repository is operating in. The enum implementation has the description of each mode.
      Returns:
      LocalRepositoryMode enum

    • setLocalRepositoryMode

      public void setLocalRepositoryMode(LocalRepositoryMode localRepositoryMode)
      Set up the mode that the local repository is operating in. The enum implementation has the description of each mode.
      Parameters:
      localRepositoryMode - LocalRepositoryMode enum

    • getLocalRepositoryLocalConnection

      public Connection getLocalRepositoryLocalConnection()
      Return the connection properties used to create a locally optimized connector to the local repository for use by this local server's components. If this value is null then the localRepositoryRemoteConnection is used.
      Returns:
      Connection properties object

    • setLocalRepositoryLocalConnection

      public void setLocalRepositoryLocalConnection(Connection localRepositoryLocalConnection)
      Set up the connection properties used to create a locally optimized connector to the local repository for use by this local server's components. If this value is null then the localRepositoryRemoteConnection is used.
      Parameters:
      localRepositoryLocalConnection - Connection properties object

    • getLocalRepositoryRemoteConnection

      public Connection getLocalRepositoryRemoteConnection()
      Return the connection properties used to create a connector to the local repository for use by remote servers.
      Returns:
      Connection properties object

    • setLocalRepositoryRemoteConnection

      public void setLocalRepositoryRemoteConnection(Connection localRepositoryRemoteConnection)
      Set up the connection properties used to create a connector to the local repository for use by remote servers.
      Parameters:
      localRepositoryRemoteConnection - Connection properties object

    • getEventsToSaveRule

      public OpenMetadataExchangeRule getEventsToSaveRule()
      Return the enumeration describing which open metadata repository events should be saved to the local repository.
      Returns:
      OpenMetadataExchangeRule enum

    • setEventsToSaveRule

      public void setEventsToSaveRule(OpenMetadataExchangeRule eventsToSaveRule)
      Set up the enumeration describing which open metadata repository events should be saved to the local repository.
      Parameters:
      eventsToSaveRule - OpenMetadataExchangeRule enum

    • getSelectedTypesToSave

      public List<TypeDefSummary> getSelectedTypesToSave()
      Return the list of TypeDefs in supported of the eventsToSave.SELECTED_TYPES option.
      Returns:
      list of types

    • setSelectedTypesToSave

      public void setSelectedTypesToSave(List<TypeDefSummary> selectedTypesToSave)
      Set up the list of TypeDefs in supported of the eventsToSave.SELECTED_TYPES option.
      Parameters:
      selectedTypesToSave - list of types

    • getEventsToSendRule

      public OpenMetadataExchangeRule getEventsToSendRule()
      Return the enumeration describing which open metadata repository events should be sent from the local repository.
      Returns:
      OpenMetadataExchangeRule enum

    • setEventsToSendRule

      public void setEventsToSendRule(OpenMetadataExchangeRule eventsToSendRule)
      Set up the enumeration describing which open metadata repository events should be sent from the local repository.
      Parameters:
      eventsToSendRule - OpenMetadataExchangeRule enum

    • getSelectedTypesToSend

      public List<TypeDefSummary> getSelectedTypesToSend()
      Return the list of TypeDefs in supported of the eventsToSend.SELECTED_TYPES option.
      Returns:
      list of types

    • setSelectedTypesToSend

      public void setSelectedTypesToSend(List<TypeDefSummary> selectedTypesToSend)
      Set up the list of TypeDefs in supported of the eventsToSend.SELECTED_TYPES option.
      Parameters:
      selectedTypesToSend - list of types

    • getEventMapperConnection

      public Connection getEventMapperConnection()
      Return the connection properties for the event mapper for the local repository. The event mapper is an optional component used when the local repository has proprietary external APIs that can change metadata in the repository without going through the OMRS interfaces. It maps the proprietary events from the local repository to the OMRS Events.
      Returns:
      Connection properties object

    • setEventMapperConnection

      public void setEventMapperConnection(Connection eventMapperConnection)
      Set up the connection properties for the event mapper for the local repository. The event mapper is an optional component used when the local repository has proprietary external APIs that can change metadata in the repository without going through the OMRS interfaces. It maps the proprietary events from the local repository to the OMRS Events.
      Parameters:
      eventMapperConnection - Connection properties object

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.

    • equals

      public boolean equals(Object objectToCompare)
      Validate that an object is equal depending on their stored values.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - object
      Returns:
      boolean result

    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class Object
      Returns:
      in hash code