org.odpi.openmetadata.adminservices.spring

Class ConfigRepositoryServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigRepositoryServicesResource

@RestController
 @RequestMapping(value="/open-metadata/admin-services/users/{userId}/servers/{serverName}")
public class ConfigRepositoryServicesResource
extends Object

ConfigRepositoryServicesResource provides the configuration services for setting up the repository services subsystems.

Constructor Summary

Constructors

Constructor and Description
ConfigRepositoryServicesResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	addAuditLogDestination(String userId, String serverName, Connection connection) Add an audit log destination that is defined by the supplied connection object.
VoidResponse	addConsoleAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Set up the console audit log for the server.
VoidResponse	addEventTopicAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Add an audit log destination that sends each log record as an event on the supplied event topic.
VoidResponse	addFileAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Add an audit log destination that creates log records as JSON files in a shared directory.
VoidResponse	addSLF4JAuditLogDestination(String userId, String serverName, List<String> supportedSeverities) Add an audit log destination that creates slf4j records.
VoidResponse	addStartUpOpenMetadataArchiveFile(String userId, String serverName, String fileName) Add a new open metadata archive to load at startup.
VoidResponse	clearAuditLogDestinations(String userId, String serverName) Clears all audit log destinations for this server.
VoidResponse	disableCohortRegistration(String userId, String serverName, String cohortName) Unregister this server from an open metadata repository cohort.
VoidResponse	enableCohortRegistration(String userId, String serverName, String cohortName, Map<String,Object> additionalProperties) Enable registration of server to an open metadata repository cohort.
GUIDResponse	getLocalMetadataCollectionId(String userId, String serverName) Return the local metadata collection id.
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	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 name) 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	setNoRepositoryMode(String userId, String serverName) Remove all configuration for a local repository.
VoidResponse	setOpenMetadataArchives(String userId, String serverName, List<Connection> openMetadataArchives) Set up the list of open metadata archives.
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 - used when the local repository mode is set to repository proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigRepositoryServicesResource

public ConfigRepositoryServicesResource()

Method Detail

setDefaultAuditLog

@PostMapping(path="/audit-log-destinations/default")
public VoidResponse setDefaultAuditLog(@PathVariable
                                                                                            String userId,
                                                                                            @PathVariable
                                                                                            String serverName)

Set up the default audit log for the server. This adds the console audit log destination.

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.

addConsoleAuditLogDestination

@PostMapping(path="/audit-log-destinations/console")
public VoidResponse addConsoleAuditLogDestination(@PathVariable
                                                                                                       String userId,
                                                                                                       @PathVariable
                                                                                                       String serverName,
                                                                                                       @RequestBody
                                                                                                       List<String> supportedSeverities)

Set up the console audit log for the server. This writes selected parts of the audit log record to stdout.

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

addSLF4JAuditLogDestination

@PostMapping(path="/audit-log-destinations/slf4j")
public VoidResponse addSLF4JAuditLogDestination(@PathVariable
                                                                                                   String userId,
                                                                                                   @PathVariable
                                                                                                   String serverName,
                                                                                                   @RequestBody
                                                                                                   List<String> supportedSeverities)

Add an audit log destination that creates slf4j records.

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

addFileAuditLogDestination

@PostMapping(path="/audit-log-destinations/files")
public VoidResponse addFileAuditLogDestination(@PathVariable
                                                                                                  String userId,
                                                                                                  @PathVariable
                                                                                                  String serverName,
                                                                                                  @RequestBody
                                                                                                  List<String> supportedSeverities)

Add an audit log destination that creates log records as JSON files in a shared directory.

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

addEventTopicAuditLogDestination

@PostMapping(path="/audit-log-destinations/event-topic")
public VoidResponse addEventTopicAuditLogDestination(@PathVariable
                                                                                                              String userId,
                                                                                                              @PathVariable
                                                                                                              String serverName,
                                                                                                              @RequestBody
                                                                                                              List<String> supportedSeverities)

Add an audit log destination that sends each log record as an event on the supplied event topic.

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

addAuditLogDestination

@PostMapping(path="/audit-log-destinations/connection")
public VoidResponse addAuditLogDestination(@PathVariable
                                                                                                   String userId,
                                                                                                   @PathVariable
                                                                                                   String serverName,
                                                                                                   @RequestBody
                                                                                                   Connection connection)

Add an audit log destination that is defined by the supplied connection object.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

connection - connection object that defines the audit log destination

Returns:

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

clearAuditLogDestinations

@PostMapping(path="/audit-log-destinations/none")
public VoidResponse clearAuditLogDestinations(@PathVariable
                                                                                                String userId,
                                                                                                @PathVariable
                                                                                                String serverName)

Clears all audit log destinations for this 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 localRepositoryMode parameter.

addStartUpOpenMetadataArchiveFile

@PostMapping(path="/open-metadata-archives/file")
public VoidResponse addStartUpOpenMetadataArchiveFile(@PathVariable
                                                                                                        String userId,
                                                                                                        @PathVariable
                                                                                                        String serverName,
                                                                                                        @RequestBody
                                                                                                        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.

setNoRepositoryMode

@DeleteMapping(path="/local-repository")
public VoidResponse setNoRepositoryMode(@PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 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.

setInMemLocalRepository

@PostMapping(path="/local-repository/mode/in-memory-repository")
public VoidResponse setInMemLocalRepository(@PathVariable
                                                                                                             String userId,
                                                                                                             @PathVariable
                                                                                                             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

@PostMapping(path="/local-repository/mode/local-graph-repository")
public VoidResponse setGraphLocalRepository(@PathVariable
                                                                                                               String userId,
                                                                                                               @PathVariable
                                                                                                               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.

setRepositoryProxyConnection

@PostMapping(path="/local-repository/mode/repository-proxy/connection")
public VoidResponse setRepositoryProxyConnection(@PathVariable
                                                                                                                         String userId,
                                                                                                                         @PathVariable
                                                                                                                         String serverName,
                                                                                                                         @RequestBody
                                                                                                                         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 OMAGConfigurationErrorException the local repository mode has not been set

setRepositoryProxyConnection

@PostMapping(path="/local-repository/mode/repository-proxy/details")
public VoidResponse setRepositoryProxyConnection(@PathVariable
                                                                                                                      String userId,
                                                                                                                      @PathVariable
                                                                                                                      String serverName,
                                                                                                                      @RequestParam
                                                                                                                      String connectorProvider,
                                                                                                                      @RequestBody(required=false)
                                                                                                                      Map<String,Object> additionalProperties)

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

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

@PostMapping(path="/local-repository/event-mapper-connection")
public VoidResponse setLocalRepositoryEventMapper(@PathVariable
                                                                                                                 String userId,
                                                                                                                 @PathVariable
                                                                                                                 String serverName,
                                                                                                                 @RequestBody
                                                                                                                 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, or the event mapper has not been set

setLocalRepositoryEventMapper

@PostMapping(path="/local-repository/event-mapper-details")
public VoidResponse setLocalRepositoryEventMapper(@PathVariable
                                                                                                              String userId,
                                                                                                              @PathVariable
                                                                                                              String serverName,
                                                                                                              @RequestParam
                                                                                                              String connectorProvider,
                                                                                                              @RequestParam
                                                                                                              String eventSource,
                                                                                                              @RequestBody(required=false)
                                                                                                              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 local repository mode has not been set.

setLocalMetadataCollectionName

@PostMapping(path="/local-repository/metadata-collection-name/{name}")
public VoidResponse setLocalMetadataCollectionName(@PathVariable
                                                                                                                          String userId,
                                                                                                                          @PathVariable
                                                                                                                          String serverName,
                                                                                                                          @PathVariable
                                                                                                                          String name)

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.

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

getLocalMetadataCollectionId

@GetMapping(path="/local-repository/metadata-collection-id")
public GUIDResponse getLocalMetadataCollectionId(@PathVariable
                                                                                                              String userId,
                                                                                                              @PathVariable
                                                                                                              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.

enableCohortRegistration

@PostMapping(path="/cohorts/{cohortName}")
public VoidResponse enableCohortRegistration(@PathVariable
                                                                                        String userId,
                                                                                        @PathVariable
                                                                                        String serverName,
                                                                                        @PathVariable
                                                                                        String cohortName,
                                                                                        @RequestBody(required=false)
                                                                                        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.

additionalProperties - additional properties for the event bus connection

Returns:

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

@DeleteMapping(path="/cohorts/{cohortName}")
public VoidResponse disableCohortRegistration(@PathVariable
                                                                                           String userId,
                                                                                           @PathVariable
                                                                                           String serverName,
                                                                                           @PathVariable
                                                                                           String cohortName)

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.

Returns:

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

setAuditLogDestinations

@PostMapping(path="/audit-log-destinations")
public VoidResponse setAuditLogDestinations(@PathVariable
                                                                                         String userId,
                                                                                         @PathVariable
                                                                                         String serverName,
                                                                                         @RequestBody
                                                                                         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.

setOpenMetadataArchives

@PostMapping(path="/open-metadata-archives")
public VoidResponse setOpenMetadataArchives(@PathVariable
                                                                                         String userId,
                                                                                         @PathVariable
                                                                                         String serverName,
                                                                                         @RequestBody
                                                                                         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

@PostMapping(path="/local-repository/configuration")
public VoidResponse setLocalRepositoryConfig(@PathVariable
                                                                                                  String userId,
                                                                                                  @PathVariable
                                                                                                  String serverName,
                                                                                                  @RequestBody
                                                                                                  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

@PostMapping(path="/cohorts/{cohortName}/configuration")
public VoidResponse setCohortConfig(@PathVariable
                                                                                             String userId,
                                                                                             @PathVariable
                                                                                             String serverName,
                                                                                             @PathVariable
                                                                                             String cohortName,
                                                                                             @RequestBody
                                                                                             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.