org.odpi.openmetadata.adminservices

Class OMAGServerAdminServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminServices

public class OMAGServerAdminServices
extends Object

OMAGServerAdminServices provides the server-side implementation of the administrative interface for an Open Metadata and Governance (OMAG) Server. 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 defined by OMAGServerAdministration interface:

• 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 service instance 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.

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminServices()

Method Summary

Modifier and Type	Method and Description
VoidResponse	activateWithStoredConfig(String userId, String serverName) Activate the open metadata and governance services using the stored configuration information.
VoidResponse	activateWithSuppliedConfig(String userId, String serverName, OMAGServerConfig configuration) Activate the open metadata and governance services using the supplied configuration document.
VoidResponse	deactivatePermanently(String userId, String serverName) Terminate any open metadata and governance services.
VoidResponse	deactivateTemporarily(String userId, String serverName) Temporarily deactivate any open metadata and governance services.
VoidResponse	disableAccessServices(String userId, String serverName) Disable the access services.
VoidResponse	disableCohortRegistration(String userId, String serverName, String cohortName) Set up the mode for an open metadata repository cohort.
VoidResponse	enableAccessServices(String userId, String serverName, Map<String,Object> accessServiceOptions) Enable all access services that are installed into this server.
VoidResponse	enableCohortRegistration(String userId, String serverName, String cohortName, Map<String,Object> additionalProperties) Enable registration of server to an open metadata repository cohort.
OMAGServerConfigResponse	getCurrentConfiguration(String userId, String serverName) Return the complete set of configuration properties in use by the server.
VoidResponse	setAccessServicesConfig(String userId, String serverName, List<AccessServiceConfig> accessServicesConfig) Set up the configuration for all of the open metadata access services (OMASs).
VoidResponse	setCohortConfig(String userId, String serverName, String cohortName, CohortConfig cohortConfig) Set up the configuration properties for a cohort.
VoidResponse	setEnterpriseAccessConfig(String userId, String serverName, EnterpriseAccessConfig enterpriseAccessConfig) Set up the configuration that controls the enterprise repository services.
VoidResponse	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.
VoidResponse	setGraphLocalRepository(String userId, String serverName, Map<String,Object> additionalProperties) Set up a graph store as the local repository.
VoidResponse	setInMemLocalRepository(String userId, String serverName) Set up an in memory local repository.
VoidResponse	setLocalRepositoryConfig(String userId, String serverName, LocalRepositoryConfig localRepositoryConfig) Set up the configuration for the local repository.
VoidResponse	setLocalRepositoryEventMapper(String userId, String serverName, Connection connection) Provide the connection to the local repository's event mapper if needed.
VoidResponse	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.
VoidResponse	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.
VoidResponse	setNoRepositoryMode(String userId, String serverName) Remove all configuration for a local repository.
VoidResponse	setOrganizationName(String userId, String serverName, String name) Set up the name of the organization that is running this server.
VoidResponse	setRepositoryProxyConnection(String userId, String serverName, Connection connection) Provide the connection to the local repository - used when the local repository mode is set to repository proxy.
VoidResponse	setRepositoryProxyConnection(String userId, String serverName, String connectorProvider, Map<String,Object> additionalProperties) Provide the connection to the local repository.
VoidResponse	setServerType(String userId, String serverName, String typeName) Set up the descriptive type of the server.
VoidResponse	setServerURLRoot(String userId, String serverName, String url) Set up the root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces.
VoidResponse	setServerUserId(String userId, String serverName, String serverUserId) Set up the user id to use when there is no external user driving the work (for example when processing events from another server).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OMAGServerAdminServices

public OMAGServerAdminServices()

Method Detail

setServerURLRoot

public VoidResponse setServerURLRoot(String userId,
                                     String serverName,
                                     String url)

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.

url - - String url.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverURLRoot parameter.

setServerType

public VoidResponse setServerType(String userId,
                                  String serverName,
                                  String typeName)

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.

typeName - - short description for the type of server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverType parameter.

setOrganizationName

public VoidResponse setOrganizationName(String userId,
                                        String serverName,
                                        String name)

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.

name - - String name of the organization.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or organizationName parameter.

setServerUserId

public VoidResponse setServerUserId(String userId,
                                    String serverName,
                                    String serverUserId)

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.

serverUserId - - String user is for the server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverURLRoot parameter.

setMaxPageSize

public VoidResponse 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. 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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or maxPageSize parameter.

setEventBus

public VoidResponse 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. 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

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException it is too late to configure the event bus - other configuration already exists or OMAGInvalidParameterException invalid serverName parameter.

enableAccessServices

public VoidResponse enableAccessServices(String userId,
                                         String serverName,
                                         Map<String,Object> accessServiceOptions)

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

Returns:

void response or 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

public VoidResponse disableAccessServices(String userId,
                                          String serverName)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

setInMemLocalRepository

public VoidResponse setInMemLocalRepository(String userId,
                                            String serverName)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

setGraphLocalRepository

public VoidResponse setGraphLocalRepository(String userId,
                                            String serverName,
                                            Map<String,Object> additionalProperties)

Set up a graph store as the local repository.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

additionalProperties - additional properties for the event bus connection

Returns:

void response or 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

public VoidResponse setNoRepositoryMode(String userId,
                                        String serverName)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryMode parameter.

setRepositoryProxyConnection

public VoidResponse setRepositoryProxyConnection(String userId,
                                                 String serverName,
                                                 Connection connection)

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.

connection - connection to the OMRS repository connector.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or

setRepositoryProxyConnection

public VoidResponse setRepositoryProxyConnection(String userId,
                                                 String serverName,
                                                 String connectorProvider,
                                                 Map<String,Object> additionalProperties)

Provide the connection to the local repository. This is 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

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or repositoryProxyConnection parameter or OMAGConfigurationErrorException the local repository mode has not been set.

setLocalRepositoryEventMapper

public VoidResponse setLocalRepositoryEventMapper(String userId,
                                                  String serverName,
                                                  Connection connection)

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.

connection - connection to the OMRS repository event mapper.

Returns:

void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryEventMapper parameter or OMAGConfigurationErrorException the local repository mode has not been set

setLocalRepositoryEventMapper

public VoidResponse 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. 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

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryEventMapper parameter or OMAGConfigurationErrorException the event bus is not set.

enableCohortRegistration

public VoidResponse enableCohortRegistration(String userId,
                                             String serverName,
                                             String cohortName,
                                             Map<String,Object> additionalProperties)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter. OMAGConfigurationErrorException the event bus is not set.

disableCohortRegistration

public VoidResponse disableCohortRegistration(String userId,
                                              String serverName,
                                              String cohortName)

Set up the mode for 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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or serviceMode parameter.

setAccessServicesConfig

public VoidResponse setAccessServicesConfig(String userId,
                                            String serverName,
                                            List<AccessServiceConfig> accessServicesConfig)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.

setLocalRepositoryConfig

public VoidResponse setLocalRepositoryConfig(String userId,
                                             String serverName,
                                             LocalRepositoryConfig localRepositoryConfig)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or localRepositoryConfig parameter.

setEnterpriseAccessConfig

public VoidResponse setEnterpriseAccessConfig(String userId,
                                              String serverName,
                                              EnterpriseAccessConfig enterpriseAccessConfig)

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.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or enterpriseAccessConfig parameter.

setCohortConfig

public VoidResponse setCohortConfig(String userId,
                                    String serverName,
                                    String cohortName,
                                    CohortConfig cohortConfig)

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

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName, cohortName or cohortConfig parameter.

getCurrentConfiguration

public OMAGServerConfigResponse getCurrentConfiguration(String userId,
                                                        String serverName)

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 OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.

activateWithStoredConfig

public VoidResponse activateWithStoredConfig(String userId,
                                             String serverName)

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

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response or 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

public VoidResponse activateWithSuppliedConfig(String userId,
                                               String serverName,
                                               OMAGServerConfig configuration)

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

Returns:

void response or 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

public VoidResponse deactivateTemporarily(String userId,
                                          String serverName)

Temporarily deactivate any open metadata and governance services.

Parameters:

userId - - user that is issuing the request

serverName - - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.

deactivatePermanently

public VoidResponse deactivatePermanently(String userId,
                                          String serverName)

Terminate any open metadata and governance services.

Parameters:

userId - user that is issuing the request

serverName - local server name

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException the serverName is invalid.