Package org.odpi.openmetadata.adminservices.store

Class OMAGServerConfigStoreConnectorBase

java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.adminservices.store.OMAGServerConfigStoreConnectorBase
All Implemented Interfaces:
OMAGServerConfigStore
public abstract class OMAGServerConfigStoreConnectorBase extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements OMAGServerConfigStore
OMAGServerConfigStoreConnectorBase provides the base class for an OMAG Server's configuration document store. It defines the specific interface for this type of connector. A new connector instance is created for each OMAG Server configuration document that is to be retrieved or stored.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    org.odpi.openmetadata.frameworks.connectors.ConnectorBase.ProtectedConnection

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    serverName
     

    Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, securedProperties

  • Constructor Summary

    Constructors
    Constructor
    Description
    OMAGServerConfigStoreConnectorBase()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    getStoreName(String template, String... params)
    This method provides the ability to generate the name of the store based on a template and insert values.
    void
    setServerName(String serverName)
    Set up the name of the server for this configuration document.

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

    disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, start, toString

    Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

    clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.odpi.openmetadata.adminservices.store.OMAGServerConfigStore

    removeServerConfig, retrieveServerConfig, saveServerConfig

  • Field Details

    • serverName

      protected String serverName

  • Constructor Details

    • OMAGServerConfigStoreConnectorBase

      public OMAGServerConfigStoreConnectorBase()

  • Method Details

    • setServerName

      public void setServerName(String serverName)
      Set up the name of the server for this configuration document.
      Specified by:
      setServerName in interface OMAGServerConfigStore
      Parameters:
      serverName - name of the server

    • getStoreName

      protected String getStoreName(String template, String... params)
      This method provides the ability to generate the name of the store based on a template and insert values. Typically this is to allow the server name to be embedded into the store name, but other values, such as the platform name may also be needed for some store implementations.
      Parameters:
      template - this is the template with placeholders
      params - this is the list of parameters that can be embedded in the template if placeholders are present (no error results of the placeholders are not present.
      Returns:
      formatted string