Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminStoreServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.adminservices.server.OMAGServerAdminStoreServices
public class OMAGServerAdminStoreServices extends TokenController
OMAGServerAdminStoreServices provides the capability to store and retrieve configuration documents. A configuration document provides the configuration information for a server. By default, a server's configuration document is stored in its own file. However, it is possible to override the default location using setConfigurationStoreConnection. This override affects all server instances in this process.

  • Constructor Details

    • OMAGServerAdminStoreServices

      public OMAGServerAdminStoreServices()

  • Method Details

    • setAppPropertiesDefaultOMAGServerConfig

      public void setAppPropertiesDefaultOMAGServerConfig(String platformUserId, OMAGServerConfig defaultServerConfig)
      Override the default server configuration document. This is called from inside the platform and represents the definition from the application.properties.
      Parameters:
      platformUserId - calling user.
      defaultServerConfig - values to include in every new configured server.

    • setDefaultOMAGServerConfig

      public VoidResponse setDefaultOMAGServerConfig(String delegatingUserId, OMAGServerConfig defaultServerConfig)
      Override the default server configuration document set by the application properties.
      Parameters:
      delegatingUserId - external userId making request
      defaultServerConfig - values to include in every new configured server.
      Returns:
      void response

    • getDefaultOMAGServerConfig

      public OMAGServerConfigResponse getDefaultOMAGServerConfig(String delegatingUserId)
      Return the default server configuration document.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      OMAGServerConfig response

    • clearDefaultOMAGServerConfig

      public VoidResponse clearDefaultOMAGServerConfig(String delegatingUserId)
      Clear the default configuration document.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      void response

    • setAppPropertiesPlaceholderVariables

      public void setAppPropertiesPlaceholderVariables(String platformUserId, Map<String,String> placeholderVariables)
      Set up the placeholder variables that will be used on each server start up.
      Parameters:
      platformUserId - calling user.
      placeholderVariables - map of variable name to value.

    • setPlaceholderVariables

      public VoidResponse setPlaceholderVariables(String delegatingUserId, Map<String,String> placeholderVariables)
      Set up the placeholder variables that will be used on each server start up.
      Parameters:
      delegatingUserId - external userId making request
      placeholderVariables - map of variable name to value.
      Returns:
      void response

    • getPlaceholderVariables

      public StringMapResponse getPlaceholderVariables(String delegatingUserId)
      Return the placeholder variables that will be used on each server start up.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      string map response

    • clearPlaceholderVariables

      public VoidResponse clearPlaceholderVariables(String delegatingUserId)
      Clear the placeholder variables.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      void response

    • setAppPropertiesConfigurationStoreConnection

      public void setAppPropertiesConfigurationStoreConnection(String platformUserId, Connection connection)
      Override the default location of the configuration documents.
      Parameters:
      platformUserId - calling user.
      connection - connection used to create and configure the connector that interacts with the real store.

    • setConfigurationStoreConnection

      public VoidResponse setConfigurationStoreConnection(String delegatingUserId, Connection connection)
      Override the default location of the configuration documents.
      Parameters:
      delegatingUserId - external userId making request
      connection - connection used to create and configure the connector that interacts with the real store.
      Returns:
      void response

    • getConfigurationStoreConnection

      public ConnectionResponse getConfigurationStoreConnection(String delegatingUserId)
      Return the connection object for the configuration store. Null is returned if the server should use the default store.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      connection response

    • clearConfigurationStoreConnection

      public VoidResponse clearConfigurationStoreConnection(String delegatingUserId)
      Clear the connection object for the configuration store.
      Parameters:
      delegatingUserId - external userId making request
      Returns:
      connection response

    • getServerConfigForStartUp

      public OMAGServerConfig getServerConfigForStartUp(String userId, String delegatingUserId, String serverName, String methodName) throws InvalidParameterException, UserNotAuthorizedException, OMAGConfigurationErrorException
      Retrieve any saved configuration for this server.
      Parameters:
      userId - calling user
      delegatingUserId - external userId making request
      serverName - name of the server
      methodName - method requesting the server details
      Returns:
      configuration properties
      Throws:
      InvalidParameterException - problem with the configuration file
      UserNotAuthorizedException - user not authorized to make these changes
      OMAGConfigurationErrorException - unable to parse the OMAGServerConfig

    • saveServerConfig

      public void saveServerConfig(String serverName, String methodName, OMAGServerConfig serverConfig) throws InvalidParameterException
      Save the server's config ...
      Parameters:
      serverName - name of the server
      methodName - method requesting the server details
      serverConfig - properties to save
      Throws:
      InvalidParameterException - problem with the config file