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

Class DataEngineProxyConfig

java.lang.Object
org.odpi.openmetadata.adminservices.configuration.properties.AdminServicesConfigHeader
org.odpi.openmetadata.adminservices.configuration.properties.DataEngineProxyConfig
All Implemented Interfaces:
Serializable
public class DataEngineProxyConfig extends AdminServicesConfigHeader
DataEngineProxyConfig caches the properties that are used to setup up the connector to a Data Engine Proxy in the server. This configuration class should support various types of Data Engine connectors.
See Also:

  • Constructor Details

    • DataEngineProxyConfig

      public DataEngineProxyConfig()
      Default constructor

    • DataEngineProxyConfig

      public DataEngineProxyConfig(DataEngineProxyConfig template)
      Copy data from template
      Parameters:
      template - an existing Data Engine proxy configuration from which to copy

  • Method Details

    • getAccessServiceRootURL

      public String getAccessServiceRootURL()
      Provide the root URL of the Data Engine OMAS
      Returns:
      String

    • setAccessServiceRootURL

      public void setAccessServiceRootURL(String accessServiceRootURL)
      Set the root URL of the Data Engine OMAS
      Parameters:
      accessServiceRootURL - the URL of the Data Engine OMAS

    • getAccessServiceServerName

      public String getAccessServiceServerName()
      Provide the server name of the Data Engine OMAS
      Returns:
      String

    • setAccessServiceServerName

      public void setAccessServiceServerName(String accessServiceServerName)
      Set the server name of the Data Engine OMAS
      Parameters:
      accessServiceServerName - the name of the Data Engine OMAS

    • getDataEngineConnection

      public org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection getDataEngineConnection()
      Provide the connection to the Data Engine
      Returns:
      Connection

    • setDataEngineConnection

      public void setDataEngineConnection(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection dataEngineConnection)
      Set the connection to the Data Engine
      Parameters:
      dataEngineConnection - the connection to the Data Engine

    • getPollIntervalInSeconds

      public int getPollIntervalInSeconds()
      Provide the seconds to wait between each polling of the data engine for changes. Note that this is only used by Data Engine Connectors that require polling in order to find changes.
      Returns:
      int

    • setPollIntervalInSeconds

      public void setPollIntervalInSeconds(int pollIntervalInSeconds)
      Set the number of seconds to wait between each polling of the data engine for changes. Note that this is only used by Data Engine Connectors that require polling in order to find changes.
      Parameters:
      pollIntervalInSeconds - the number of seconds to wait between each poll for changes

    • getBatchWindowInSeconds

      public int getBatchWindowInSeconds()
      Provide the maximum number of seconds to include for a window of polling. When polling, the proxy will only look for changes from the last sync time through to the max sync time + this number of seconds, to ensure that the batches of results being polled do not become too large. Note that this is only used by Data Engine Connectors that require polling in order to find changes.
      Returns:
      int

    • setBatchWindowInSeconds

      public void setBatchWindowInSeconds(int batchWindowInSeconds)
      Set the number of seconds across which to include results for a window of polling. Note that this is only used by Data Engine Connectors that require polling in order to find changes.
      Parameters:
      batchWindowInSeconds - the number of seconds to include in each polling window
      See Also:

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isEventsClientEnabled

      public boolean isEventsClientEnabled()
      Configuration parameter controlling events client usage in the Data Engine Proxy server
      Returns:
      true if enabled

    • setEventsClientEnabled

      public void setEventsClientEnabled(boolean eventsClientEnabled)
      Sets configuration parameter controlling events client usage in the Data Engine Proxy server
      Parameters:
      eventsClientEnabled - can events be used?