org.odpi.openmetadata.adminservices

Class OMAGServerAdminServices

java.lang.Object

org.odpi.openmetadata.adminservices.OMAGServerAdminServices

public class OMAGServerAdminServices
extends Object

OMAGServerAdminServices provides part of the server-side implementation of the administrative interface for an Open Metadata and Governance (OMAG) Server. In particular, this class supports the configuration of the server name, server type and organization name. It also supports the setting up of the Open Metadata Repository Services' local repository and cohort.

Constructor Summary

Constructors

Constructor and Description
OMAGServerAdminServices()

Method Summary

Modifier and Type	Method and Description
VoidResponse	addAuditLogDestination(String userId, String serverName, Connection auditLogDestination) Set up the list of audit log destinations.
VoidResponse	addConsoleAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Set up the console (stdout) audit log destination for the server.
VoidResponse	addEventTopicAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Set up the File based audit log destination for the server.
VoidResponse	addFileAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Set up the File based audit log destination for the server.
VoidResponse	addSLF4JAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Set up the SLF4J audit log destination for the server.
VoidResponse	addStartUpOpenMetadataArchiveFile(String userId, String serverName, String fileName) Add a new open metadata archive to load at startup.
VoidResponse	clearAuditLogDestinations(String userId, String serverName) Set up the list of audit log destinations.
VoidResponse	deployOMAGServerConfig(String userId, String serverName, URLRequestBody destinationPlatform) Push the configuration for the server to another OMAG Server Platform.
VoidResponse	disableCohortRegistration(String userId, String serverName, String cohortName) Set up the mode for an open metadata repository cohort.
VoidResponse	enableCohortRegistration(String userId, String serverName, String cohortName, Map<String,Object> configurationProperties) Enable registration of server to an open metadata repository cohort.
GUIDResponse	getLocalMetadataCollectionId(String userId, String serverName) Return the local metadata collection id.
OMAGServerConfigResponse	getStoredConfiguration(String userId, String serverName) Return the complete set of configuration properties in use by the server.
VoidResponse	setAuditLogDestinations(String userId, String serverName, List<Connection> auditLogDestinations) Set up the list of audit log destinations.
VoidResponse	setCohortConfig(String userId, String serverName, String cohortName, CohortConfig cohortConfig) Set up the configuration properties for a cohort.
VoidResponse	setDefaultAuditLog(String userId, String serverName) Set up the default audit log for the server.
VoidResponse	setEventBus(String userId, String serverName, String connectorProvider, String topicURLRoot, Map<String,Object> configurationProperties) Set up the default event bus for embedding in event-driven connector.
VoidResponse	setGraphLocalRepository(String userId, String serverName) Set up a graph store as the local repository.
VoidResponse	setInMemLocalRepository(String userId, String serverName) Set up an in memory local repository.
VoidResponse	setLocalMetadataCollectionName(String userId, String serverName, String localMetadataCollectionName) Set up the local metadata collection name.
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	setOMAGServerConfig(String userId, String serverName, OMAGServerConfig omagServerConfig) Set up the configuration properties for an OMAG Server in a single command.
VoidResponse	setOpenMetadataArchives(String userId, String serverName, List<Connection> openMetadataArchives) Set up the list of open metadata archives.
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	setServerPassword(String userId, String serverName, String serverPassword) Set up the user id to use when there is no external user driving the work (for example when processing events from another server).
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 that is used by other members of the cohorts that this server connects to.
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

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.

setServerPassword

public VoidResponse setServerPassword(String userId,
                                      String serverName,
                                      String serverPassword)

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.

serverPassword - String password 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> configurationProperties)

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. When the event bus is configured, it is used only on future configuration. It does not effect existing configuration.

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.

configurationProperties - 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.

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 that is used by other members of the cohorts that this server connects to. The default value is "localhost:8080". ServerURLRoot is used during the configuration of the local repository. If called after the local repository is configured, it has no effect.

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.

setDefaultAuditLog

public VoidResponse setDefaultAuditLog(String userId,
                                       String serverName)

Set up the default audit log for the server.

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 null userId parameter.

addConsoleAuditLogDestination

public VoidResponse addConsoleAuditLogDestination(String userId,
                                                  String serverName,
                                                  List<String> supportedSeverities)

Set up the console (stdout) audit log destination for the server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Returns:

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

addSLF4JAuditLogDestination

public VoidResponse addSLF4JAuditLogDestination(String userId,
                                                String serverName,
                                                List<String> supportedSeverities)

Set up the SLF4J audit log destination for the server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Returns:

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

addFileAuditLogDestination

public VoidResponse addFileAuditLogDestination(String userId,
                                               String serverName,
                                               List<String> supportedSeverities)

Set up the File based audit log destination for the server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Returns:

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

addEventTopicAuditLogDestination

public VoidResponse addEventTopicAuditLogDestination(String userId,
                                                     String serverName,
                                                     List<String> supportedSeverities)

Set up the File based audit log destination for the server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

supportedSeverities - list of severities that should be logged to this destination (empty list means all)

Returns:

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

addStartUpOpenMetadataArchiveFile

public VoidResponse addStartUpOpenMetadataArchiveFile(String userId,
                                                      String serverName,
                                                      String fileName)

Add a new open metadata archive to load at startup.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

fileName - name of the open metadata archive file.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or fileName 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)

Set up a graph store as the local repository.

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

getLocalMetadataCollectionId

public GUIDResponse getLocalMetadataCollectionId(String userId,
                                                 String serverName)

Return the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

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

setLocalMetadataCollectionName

public VoidResponse setLocalMetadataCollectionName(String userId,
                                                   String serverName,
                                                   String localMetadataCollectionName)

Set up the local metadata collection name. If this is not set then the default value is the local server name.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

localMetadataCollectionName - metadata collection name

Returns:

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

enableCohortRegistration

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

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.

configurationProperties - additional properties for 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.

setAuditLogDestinations

public VoidResponse setAuditLogDestinations(String userId,
                                            String serverName,
                                            List<Connection> auditLogDestinations)

Set up the list of audit log destinations. These destinations are expressed as Connection objects to the connectors that will handle the audit log records.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

auditLogDestinations - list of connection objects

Returns:

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

addAuditLogDestination

public VoidResponse addAuditLogDestination(String userId,
                                           String serverName,
                                           Connection auditLogDestination)

Set up the list of audit log destinations. These destinations are expressed as Connection objects to the connectors that will handle the audit log records.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

auditLogDestination - connection object for audit log destination

Returns:

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

clearAuditLogDestinations

public VoidResponse clearAuditLogDestinations(String userId,
                                              String serverName)

Set up the list of audit log destinations. These destinations are expressed as Connection objects to the connectors that will handle the audit log records.

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.

setOpenMetadataArchives

public VoidResponse setOpenMetadataArchives(String userId,
                                            String serverName,
                                            List<Connection> openMetadataArchives)

Set up the list of open metadata archives. These are open metadata types and instances that are loaded at repository start up.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

openMetadataArchives - list of connection objects

Returns:

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

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.

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.

setOMAGServerConfig

public VoidResponse setOMAGServerConfig(String userId,
                                        String serverName,
                                        OMAGServerConfig omagServerConfig)

Set up the configuration properties for an OMAG Server in a single command.

Parameters:

userId - user that is issuing the request

serverName - local server name

omagServerConfig - configuration for the server

Returns:

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

deployOMAGServerConfig

public VoidResponse deployOMAGServerConfig(String userId,
                                           String serverName,
                                           URLRequestBody destinationPlatform)

Push the configuration for the server to another OMAG Server Platform.

Parameters:

userId - user that is issuing the request

serverName - local server name

destinationPlatform - location of the platform where the config is to be deployed to

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException there is a problem using the supplied configuration or OMAGInvalidParameterException invalid serverName or destinationPlatform parameter.

getStoredConfiguration

public OMAGServerConfigResponse getStoredConfiguration(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.