Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminStoreServices

java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminStoreServices
public class OMAGServerAdminStoreServices extends Object
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

    • setConfigurationStoreConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setConfigurationStoreConnection(String userId, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
      Override the default location of the configuration documents.
      Parameters:
      userId - calling user.
      connection - connection used to create and configure the connector that interacts with the real store.
      Returns:
      void response

    • getConfigurationStoreConnection

      public org.odpi.openmetadata.adminservices.rest.ConnectionResponse getConfigurationStoreConnection(String userId)
      Return the connection object for the configuration store. Null is returned if the server should use the default store.
      Parameters:
      userId - calling user
      Returns:
      connection response

    • clearConfigurationStoreConnection

      public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConfigurationStoreConnection(String userId)
      Clear the connection object for the configuration store.
      Parameters:
      userId - calling user
      Returns:
      connection response

    • getServerConfig

      public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getServerConfig(String userId, String serverName, boolean adminCall, String methodName) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException
      Retrieve any saved configuration for this server.
      Parameters:
      userId - calling user
      serverName - name of the server
      adminCall - flag to indicate whether the
      methodName - method requesting the server details
      Returns:
      configuration properties
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - problem with the configuration file
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - user not authorized to make these changes

    • saveServerConfig

      public void saveServerConfig(String serverName, String methodName, org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig serverConfig) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
      Save the server's config ...
      Parameters:
      serverName - name of the server
      methodName - method requesting the server details
      serverConfig - properties to save
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - problem with the config file