Class OMAGServerAdminStoreServices
java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminStoreServices
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionClear the connection object for the configuration store.clearDefaultOMAGServerConfig
(String userId) Clear the default configuration document.clearPlaceholderVariables
(String userId) Clear the placeholder variables.Return the connection object for the configuration store.getDefaultOMAGServerConfig
(String userId) Return the default server configuration document.getPlaceholderVariables
(String userId) Return the placeholder variables that will be used on each server start up.getServerConfig
(String userId, String serverName, boolean adminCall, String methodName) Retrieve any saved configuration for this server.getServerConfigForStartUp
(String userId, String serverName, String methodName) Retrieve any saved configuration for this server.void
saveServerConfig
(String serverName, String methodName, OMAGServerConfig serverConfig) Save the server's config ...setConfigurationStoreConnection
(String userId, Connection connection) Override the default location of the configuration documents.setDefaultOMAGServerConfig
(String userId, OMAGServerConfig defaultServerConfig) Override the default server configuration document.setPlaceholderVariables
(String userId, Map<String, String> placeholderVariables) Set up the placeholder variables that will be used on each server start up.
-
Constructor Details
-
OMAGServerAdminStoreServices
public OMAGServerAdminStoreServices()
-
-
Method Details
-
setDefaultOMAGServerConfig
Override the default server configuration document.- Parameters:
userId
- calling user.defaultServerConfig
- values to include in every new configured server.- Returns:
- void response
-
getDefaultOMAGServerConfig
Return the default server configuration document.- Parameters:
userId
- calling user- Returns:
- OMAGServerConfig response
-
clearDefaultOMAGServerConfig
Clear the default configuration document.- Parameters:
userId
- calling user- Returns:
- void response
-
setPlaceholderVariables
Set up the placeholder variables that will be used on each server start up.- Parameters:
userId
- calling user.placeholderVariables
- map of variable name to value.- Returns:
- void response
-
getPlaceholderVariables
Return the placeholder variables that will be used on each server start up.- Parameters:
userId
- calling user- Returns:
- string map response
-
clearPlaceholderVariables
Clear the placeholder variables.- Parameters:
userId
- calling user- Returns:
- void response
-
setConfigurationStoreConnection
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
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
Clear the connection object for the configuration store.- Parameters:
userId
- calling user- Returns:
- connection response
-
getServerConfig
public OMAGServerConfig getServerConfig(String userId, String serverName, boolean adminCall, String methodName) throws OMAGInvalidParameterException, OMAGNotAuthorizedException, InvalidParameterException Retrieve any saved configuration for this server.- Parameters:
userId
- calling userserverName
- name of the serveradminCall
- flag to indicate whether themethodName
- method requesting the server details- Returns:
- configuration properties
- Throws:
OMAGInvalidParameterException
- problem with the configuration fileOMAGNotAuthorizedException
- user not authorized to make these changesInvalidParameterException
-
getServerConfigForStartUp
public OMAGServerConfig getServerConfigForStartUp(String userId, String serverName, String methodName) throws OMAGInvalidParameterException, OMAGNotAuthorizedException, OMAGConfigurationErrorException Retrieve any saved configuration for this server.- Parameters:
userId
- calling userserverName
- name of the servermethodName
- method requesting the server details- Returns:
- configuration properties
- Throws:
OMAGInvalidParameterException
- problem with the configuration fileOMAGNotAuthorizedException
- user not authorized to make these changesOMAGConfigurationErrorException
- unable to parse the OMAGServerConfig
-
saveServerConfig
public void saveServerConfig(String serverName, String methodName, OMAGServerConfig serverConfig) throws OMAGInvalidParameterException Save the server's config ...- Parameters:
serverName
- name of the servermethodName
- method requesting the server detailsserverConfig
- properties to save- Throws:
OMAGInvalidParameterException
- problem with the config file
-