org.odpi.openmetadata.adminservices

Interface OMAGServerAdministration

public interface OMAGServerAdministration

OMAGServerAdministration defines the administrative interface for an Open Metadata and Governance (OMAG) Server. It is used to create both the Java client and the RESTful server-side implementation. It provides all of the configuration properties for the Open Metadata Access Services (OMASs) and delegates administration requests to the Open Metadata Repository Services (OMRS).

There are four types of operations supported by OMAGServerAdministration:

• Basic configuration - these methods use the minimum of configuration information to run the server using default properties.
• Advanced Configuration - provides access to all configuration properties to provide fine-grained control of the server.
• Initialization and shutdown - these methods control the initialization and shutdown of the open metadata and governance services based on the supplied configuration.
• Operational status and control - these methods query the status of the open metadata and governance services as well as the audit log.

Method Summary

Modifier and Type	Method and Description
void	activateWithStoredConfig(String userId, String serverName) Activate the open metadata and governance services using the stored configuration information.
void	activateWithSuppliedConfig(String userId, String serverName, OMAGServerConfig configuration) Activate the open metadata and governance services using the supplied configuration document.
void	deactivatePermanently(String userId, String serverName) Permanently deactivate any open metadata and governance services and unregister from any cohorts.
void	deactivateTemporarily(String userId, String serverName) Temporarily deactivate any open metadata and governance services.
void	disableAccessServices(String userId, String serverName) Disable the access services.
void	disableCohortRegistration(String userId, String serverName, String cohortName) Unregister this server from an open metadata repository cohort.
void	enableAccessServices(String userId, String serverName, Map<String,Object> accessServiceOptions) Enable all access services that are installed into this server.
void	enableCohortRegistration(String userId, String serverName, String cohortName, Map<String,Object> additionalProperties) Enable registration of server to an open metadata repository cohort.
OMAGServerConfig	getCurrentConfiguration(String userId, String serverName) Return the complete set of configuration properties in use by the server.
String	getServerOrigin() Return the origin of this server implementation.
void	setAccessServicesConfig(String userId, String serverName, List<AccessServiceConfig> accessServicesConfig) Set up the configuration for all of the open metadata access services (OMASs).
void	setCohortConfig(String userId, String serverName, String cohortName, CohortConfig cohortConfig) Set up the configuration properties for a cohort.
void	setEnterpriseAccessConfig(String userId, String serverName, EnterpriseAccessConfig enterpriseAccessConfig) Set up the configuration that controls the enterprise repository services.
void	setEventBus(String userId, String serverName, String connectorProvider, String topicURLRoot, Map<String,Object> additionalProperties) Set up the default event bus for embedding in event-driven connector.
void	setGraphLocalRepository(String userId, String serverName) Set up a graph store as the local repository.
void	setInMemLocalRepository(String userId, String serverName) Set up an in memory local repository.
void	setLocalRepositoryConfig(String userId, String serverName, LocalRepositoryConfig localRepositoryConfig) Set up the configuration for the local repository.
void	setLocalRepositoryEventMapper(String userId, String serverName, Connection localRepositoryEventMapper) Provide the connection to the local repository's event mapper if needed.
void	setLocalRepositoryEventMapper(String userId, String serverName, String connectorProvider, String eventSource, Map<String,Object> additionalProperties) Provide the connection to the local repository's event mapper if needed.
void	setMaxPageSize(String userId, String serverName, int maxPageSize) Set an upper limit in the page size that can be requested on a REST call to the server.
void	setNoRepositoryMode(String userId, String serverName) Remove all configuration for a local repository.
void	setOrganizationName(String userId, String serverName, String organizationName) Set up the name of the organization that is running this server.
void	setRepositoryProxyConnection(String userId, String serverName, Connection repositoryProxyConnection) Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
void	setRepositoryProxyConnection(String userId, String serverName, String connectorProvider, Map<String,Object> additionalProperties) Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
void	setServerType(String userId, String serverName, String serverType) Set up the descriptive type of the server.
void	setServerURLRoot(String userId, String serverName, String serverURLRoot) Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces.
void	setServerUserId(String userId, String serverName, String id) Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Method Detail

getServerOrigin

String getServerOrigin()

Return the origin of this server implementation.

Returns:

OMAG Server Origin

setServerURLRoot

void setServerURLRoot(String userId,
                      String serverName,
                      String serverURLRoot)
               throws OMAGNotAuthorizedException,
                      OMAGInvalidParameterException

Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces. The default value is "localhost:8080".

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverURLRoot - String url.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or serverURLRoot parameter.

setServerType

void setServerType(String userId,
                   String serverName,
                   String serverType)
            throws OMAGNotAuthorizedException,
                   OMAGInvalidParameterException

Set up the descriptive type of the server. This value is added to distributed events to make it easier to understand the source of events. The default value is "Open Metadata and Governance Server".

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverType - short description for the type of server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or serverType parameter.

setOrganizationName

void setOrganizationName(String userId,
                         String serverName,
                         String organizationName)
                  throws OMAGNotAuthorizedException,
                         OMAGInvalidParameterException

Set up the name of the organization that is running this server. This value is added to distributed events to make it easier to understand the source of events. The default value is null.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

organizationName - String name of the organization.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

setServerUserId

void setServerUserId(String userId,
                     String serverName,
                     String id)
              throws OMAGNotAuthorizedException,
                     OMAGInvalidParameterException

Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Parameters:

userId - user that is issuing the request.

serverName - local server name.

id - String user is for the server.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid serverName or serverURLRoot parameter.

setMaxPageSize

void setMaxPageSize(String userId,
                    String serverName,
                    int maxPageSize)
             throws OMAGNotAuthorizedException,
                    OMAGInvalidParameterException

Set an upper limit in the page size that can be requested on a REST call to the server. The default value is 1000.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

maxPageSize - max number of elements that can be returned on a request.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

setEventBus

void setEventBus(String userId,
                 String serverName,
                 String connectorProvider,
                 String topicURLRoot,
                 Map<String,Object> additionalProperties)
          throws OMAGNotAuthorizedException,
                 OMAGInvalidParameterException,
                 OMAGConfigurationErrorException

Set up the default event bus for embedding in event-driven connector. The resulting connector will be used in the OMRS Topic Connector for each cohort, the in and out topics for each Access Service and the local repositories event mapper.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

connectorProvider - connector provider for the event bus (if it is null then Kafka is assumed).

topicURLRoot - the common root of the topics used by the open metadata server.

additionalProperties - property name/value pairs used to configure the connection to the event bus connector

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGConfigurationErrorException - it is too late to configure the event bus - other configuration already exists.

OMAGInvalidParameterException - invalid serverName or serviceMode parameter.

enableAccessServices

void enableAccessServices(String userId,
                          String serverName,
                          Map<String,Object> accessServiceOptions)
                   throws OMAGNotAuthorizedException,
                          OMAGInvalidParameterException,
                          OMAGConfigurationErrorException

Enable all access services that are installed into this server. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceOptions - property name/value pairs used to configure the access services

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGConfigurationErrorException - the event bus has not been configured or

OMAGInvalidParameterException - invalid serverName parameter.

disableAccessServices

void disableAccessServices(String userId,
                           String serverName)
                    throws OMAGNotAuthorizedException,
                           OMAGInvalidParameterException

Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName parameter.

setInMemLocalRepository

void setInMemLocalRepository(String userId,
                             String serverName)
                      throws OMAGNotAuthorizedException,
                             OMAGInvalidParameterException

Set up an in memory local repository. This repository uses hashmaps to store content. It is useful for demos, testing and POCs.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or localRepositoryMode parameter.

setGraphLocalRepository

void setGraphLocalRepository(String userId,
                             String serverName)
                      throws OMAGNotAuthorizedException,
                             OMAGConfigurationErrorException,
                             OMAGInvalidParameterException

Set up a graph store as the local repository.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGConfigurationErrorException - the event bus has not been configured or

OMAGInvalidParameterException - invalid serverName or localRepositoryMode parameter.

setNoRepositoryMode

void setNoRepositoryMode(String userId,
                         String serverName)
                  throws OMAGNotAuthorizedException,
                         OMAGInvalidParameterException

Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or localRepositoryMode parameter.

setRepositoryProxyConnection

void setRepositoryProxyConnection(String userId,
                                  String serverName,
                                  Connection repositoryProxyConnection)
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Provide the connection to the local repository - used when the local repository mode is set to repository proxy.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

repositoryProxyConnection - connection to the OMRS repository connector.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

OMAGConfigurationErrorException - the local repository mode has not been set

setRepositoryProxyConnection

void setRepositoryProxyConnection(String userId,
                                  String serverName,
                                  String connectorProvider,
                                  Map<String,Object> additionalProperties)
                           throws OMAGNotAuthorizedException,
                                  OMAGInvalidParameterException,
                                  OMAGConfigurationErrorException

Provide the connection to the local repository - used when the local repository mode is set to repository proxy.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

connectorProvider - connector provider class name to the OMRS repository connector.

additionalProperties - additional parameters to pass to the repository connector

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

OMAGConfigurationErrorException - the local repository mode has not been set.

setLocalRepositoryEventMapper

void setLocalRepositoryEventMapper(String userId,
                                   String serverName,
                                   Connection localRepositoryEventMapper)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Provide the connection to the local repository's event mapper if needed. The default value is null which means no event mapper. An event mapper is needed if the local repository has additional APIs that can change the metadata in the repository without going through the open metadata and governance services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

localRepositoryEventMapper - connection to the OMRS repository event mapper.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

OMAGConfigurationErrorException - the local repository mode has not been set

setLocalRepositoryEventMapper

void setLocalRepositoryEventMapper(String userId,
                                   String serverName,
                                   String connectorProvider,
                                   String eventSource,
                                   Map<String,Object> additionalProperties)
                            throws OMAGNotAuthorizedException,
                                   OMAGInvalidParameterException,
                                   OMAGConfigurationErrorException

Provide the connection to the local repository's event mapper if needed. The default value is null which means no event mapper. An event mapper is needed if the local repository has additional APIs that can change the metadata in the repository without going through the open metadata and governance services.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

connectorProvider - Java class name of the connector provider for the OMRS repository event mapper.

eventSource - topic name or URL to the native event source.

additionalProperties - additional properties for the event mapper connection

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or organizationName parameter.

OMAGConfigurationErrorException - the local repository mode has not been set

enableCohortRegistration

void enableCohortRegistration(String userId,
                              String serverName,
                              String cohortName,
                              Map<String,Object> additionalProperties)
                       throws OMAGNotAuthorizedException,
                              OMAGInvalidParameterException,
                              OMAGConfigurationErrorException

Enable registration of server to an open metadata repository cohort. This is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

cohortName - name of the cohort.

additionalProperties - additional properties for the event bus connection

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName, cohortName or serviceMode parameter or

OMAGConfigurationErrorException - the event bus is not set.

disableCohortRegistration

void disableCohortRegistration(String userId,
                               String serverName,
                               String cohortName)
                        throws OMAGNotAuthorizedException,
                               OMAGInvalidParameterException

Unregister this server from an open metadata repository cohort.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

cohortName - name of the cohort.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName, cohortName or serviceMode parameter.

setAccessServicesConfig

void setAccessServicesConfig(String userId,
                             String serverName,
                             List<AccessServiceConfig> accessServicesConfig)
                      throws OMAGNotAuthorizedException,
                             OMAGInvalidParameterException

Set up the configuration for all of the open metadata access services (OMASs). This overrides the current values.

Parameters:

userId - - user that is issuing the request.

serverName - - local server name.

accessServicesConfig - - list of configuration properties for each access service.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.

OMAGInvalidParameterException - invalid serverName or accessServicesConfig parameter.

setLocalRepositoryConfig

void setLocalRepositoryConfig(String userId,
                              String serverName,
                              LocalRepositoryConfig localRepositoryConfig)
                       throws OMAGNotAuthorizedException,
                              OMAGInvalidParameterException

Set up the configuration for the local repository. This overrides the current values.

Parameters:

userId - - user that is issuing the request.

serverName - - local server name.

localRepositoryConfig - - configuration properties for the local repository.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or localRepositoryConfig parameter.

setEnterpriseAccessConfig

void setEnterpriseAccessConfig(String userId,
                               String serverName,
                               EnterpriseAccessConfig enterpriseAccessConfig)
                        throws OMAGNotAuthorizedException,
                               OMAGInvalidParameterException

Set up the configuration that controls the enterprise repository services. These services are part of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event notifications that cover metadata from the local repository plus any repositories connected via open metadata repository cohorts.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

enterpriseAccessConfig - - enterprise repository services configuration properties.

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName or enterpriseAccessConfig parameter.

setCohortConfig

void setCohortConfig(String userId,
                     String serverName,
                     String cohortName,
                     CohortConfig cohortConfig)
              throws OMAGNotAuthorizedException,
                     OMAGInvalidParameterException

Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a cohort. Use setCohortMode to delete a cohort.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

cohortName - - name of the cohort

cohortConfig - - configuration for the cohort

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName, cohortName or cohortConfig parameter.

getCurrentConfiguration

OMAGServerConfig getCurrentConfiguration(String userId,
                                         String serverName)
                                  throws OMAGNotAuthorizedException,
                                         OMAGInvalidParameterException

Return the complete set of configuration properties in use by the server.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

Returns:

OMAGServerConfig properties or

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - invalid serverName parameter.

activateWithStoredConfig

void activateWithStoredConfig(String userId,
                              String serverName)
                       throws OMAGNotAuthorizedException,
                              OMAGInvalidParameterException,
                              OMAGConfigurationErrorException

Activate the open metadata and governance services using the stored configuration information.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - the server name is invalid or

OMAGConfigurationErrorException - there is a problem using the supplied configuration.

activateWithSuppliedConfig

void activateWithSuppliedConfig(String userId,
                                String serverName,
                                OMAGServerConfig configuration)
                         throws OMAGNotAuthorizedException,
                                OMAGInvalidParameterException,
                                OMAGConfigurationErrorException

Activate the open metadata and governance services using the supplied configuration document.

Parameters:

userId - - user that is issuing the request

configuration - - properties used to initialize the services

serverName - - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - the server name is invalid or

OMAGConfigurationErrorException - there is a problem using the supplied configuration.

deactivateTemporarily

void deactivateTemporarily(String userId,
                           String serverName)
                    throws OMAGNotAuthorizedException,
                           OMAGInvalidParameterException

Temporarily deactivate any open metadata and governance services.

Parameters:

userId - user that is issuing the request

serverName - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - the serverName is invalid.

deactivatePermanently

void deactivatePermanently(String userId,
                           String serverName)
                    throws OMAGNotAuthorizedException,
                           OMAGInvalidParameterException

Permanently deactivate any open metadata and governance services and unregister from any cohorts.

Parameters:

userId - user that is issuing the request

serverName - local server name

Throws:

OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command or

OMAGInvalidParameterException - the serverName is invalid.