Package org.odpi.openmetadata.adminservices.spring

Class ConfigPropertiesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigPropertiesResource
@RestController @RequestMapping("/open-metadata/admin-services/servers/{serverName}") public class ConfigPropertiesResource extends Object
ConfigPropertiesResource provides part of the server-side implementation of the administrative interface for an Open Metadata and Governance (OMAG) Server. In particular, this resource supports the configuration of the server name, server type and organization name.

  • Constructor Details

    • ConfigPropertiesResource

      public ConfigPropertiesResource()

  • Method Details

    • getServerTypeClassification

      @GetMapping(path="/server-type-classification") public ServerTypeClassificationResponse getServerTypeClassification(@PathVariable String serverName)
      Return the derived server type that is created from the classification of the server configuration.
      Parameters:
      serverName - local server name.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or serverType parameter.

    • setOrganizationName

      @PostMapping(path="/organization-name") public VoidResponse setOrganizationName(@PathVariable String serverName, @RequestParam 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:
      serverName - local server name.
      name - String name of the organization.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or organizationName parameter.

    • setServerDescription

      @PostMapping(path="/server-description") public VoidResponse setServerDescription(@PathVariable String serverName, @RequestBody String description)
      Set up the description of this server. The default value is null.
      Parameters:
      serverName - local server description.
      description - String description of the server.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or organizationName parameter.

    • setServerUserId

      @PostMapping(path="/server-user-id") public VoidResponse setServerUserId(@PathVariable String serverName, @RequestParam String id)
      Set up the user id to use when there is no external user driving the work (for example when processing events from another server).
      Parameters:
      serverName - - local server name.
      id - - String user is for the server.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or serverURLRoot parameter.

    • setMaxPageSize

      @PostMapping(path="/max-page-size") public VoidResponse setMaxPageSize(@PathVariable String serverName, @RequestParam int limit)
      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:
      serverName - local server name.
      limit - max number of elements that can be returned on a request.
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or maxPageSize parameter.

    • setBasicServerProperties

      @PostMapping(path="/server-properties") public VoidResponse setBasicServerProperties(@PathVariable String serverName, @RequestBody ServerPropertiesRequestBody requestBody)
      Set up the basic server properties in a single request.
      Parameters:
      serverName - local server name.
      requestBody - property details
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or maxPageSize parameter.

    • getBasicServerProperties

      @GetMapping(path="/server-properties") public BasicServerPropertiesResponse getBasicServerProperties(@PathVariable String serverName)
      Get the basic server properties in a single request.
      Parameters:
      serverName - local server name.
      Returns:
      properties response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName or maxPageSize parameter.