org.odpi.openmetadata.adminservices.spring

Class ConfigDefaultsResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigDefaultsResource

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

ConfigDefaultsResource sets properties in the configuration document that are used as default values when configuring the subsystems in an OMAG Server. If these values are updated after a subsystem is configured, they do not impact that subsystem's configuration.

Constructor Summary

Constructors

Constructor and Description
ConfigDefaultsResource()

Method Summary

Modifier and Type	Method and Description
EventBusConfigResponse	getEventBus(String userId, String serverName) Return the current configuration for the event bus.
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	setServerRootURL(String userId, String serverName, URLRequestBody requestBody) Set up the default root URL for this server's platform that is used to construct full URL paths to calls for this server's REST interfaces.
VoidResponse	setServerURLRoot(String userId, String serverName, String url) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDefaultsResource

public ConfigDefaultsResource()

Method Detail

setServerURLRoot

@Deprecated
 @PostMapping(path="/server-url-root")
public VoidResponse setServerURLRoot(@PathVariable
                                                                                        String userId,
                                                                                        @PathVariable
                                                                                        String serverName,
                                                                                        @RequestParam
                                                                                        String url)

Deprecated.

Set up the default root URL for this server that is used to construct full URL paths to calls for this server's REST interfaces. It is a value that is sent to other servers to allow them to call this server. The default value is "localhost:8080". ServerURLRoot is used as a default value during the configuration of the server's subsystems. If it is updated after a subsystem is configured then the new value is ignored.

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.

setServerRootURL

@PostMapping(path="/server-url-root-for-caller")
public VoidResponse setServerRootURL(@PathVariable
                                                                                      String userId,
                                                                                      @PathVariable
                                                                                      String serverName,
                                                                                      @RequestBody
                                                                                      URLRequestBody requestBody)

Set up the default root URL for this server's platform that is used to construct full URL paths to calls for this server's REST interfaces. It is a value that is sent to other servers to allow them to call this server. The default value is "http://localhost:8080". ServerRootURL is used as a default value during the configuration of the server's subsystems. If it is updated after a subsystem is configured then the new value is ignored.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

requestBody - String url.

Returns:

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

setEventBus

@PostMapping(path="/event-bus")
public VoidResponse setEventBus(@PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String serverName,
                                                                @RequestParam(required=false)
                                                                String connectorProvider,
                                                                @RequestParam(required=false)
                                                                String topicURLRoot,
                                                                @RequestBody(required=false)
                                                                Map<String,Object> configurationProperties)

Set up the default event bus for embedding in event-driven connector. The resulting connector will be used for example, in the OMRS Topic Connector for each cohort, the in and out topics for each Access Service and possibly the local repository's 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 or serviceMode parameter.

getEventBus

@GetMapping(path="/event-bus")
public EventBusConfigResponse getEventBus(@PathVariable
                                                                         String userId,
                                                                         @PathVariable
                                                                         String serverName)

Return the current configuration for the event bus.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

event bus config 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.