Package org.odpi.openmetadata.adminservices.spring

Class ConfigOpenMetadataServerSecurityResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigOpenMetadataServerSecurityResource

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

ConfigOpenMetadataServerSecurityResource provides the API to configure the security connector that validates Open Metadata and Governance requests issued to a specific OMAG server.

Constructor Summary

Constructors

Constructor	Description
ConfigOpenMetadataServerSecurityResource()

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearServerSecurityConnection(String userId, String serverName)	Clear the connection object for the server security connector.
ConnectionResponse	getServerSecurityConnection(String userId, String serverName)	Return the connection object for the server security connector.
VoidResponse	setServerSecurityConnection(String userId, String serverName, Connection connection)	Override the default server security connector.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigOpenMetadataServerSecurityResource

public ConfigOpenMetadataServerSecurityResource()

Method Detail

setServerSecurityConnection

@PostMapping(path="/connection")
public VoidResponse setServerSecurityConnection(@PathVariable
                                                String userId,
                                                @PathVariable
                                                String serverName,
                                                @RequestBody
                                                Connection connection)

Override the default server security connector.

Parameters:

userId - calling user.

serverName - server to configure

connection - connection used to create and configure the connector.

Returns:

void response

getServerSecurityConnection

@GetMapping(path="/connection")
public ConnectionResponse getServerSecurityConnection(@PathVariable
                                                      String userId,
                                                      @PathVariable
                                                      String serverName)

Return the connection object for the server security connector.

Parameters:

userId - calling user

serverName - server to retrieve configuration from

Returns:

connection response

clearServerSecurityConnection

@DeleteMapping(path="/connection")
public VoidResponse clearServerSecurityConnection(@PathVariable
                                                  String userId,
                                                  @PathVariable
                                                  String serverName)

Clear the connection object for the server security connector. This sets the server security back to default.

Parameters:

userId - calling user

serverName - server to configure

Returns:

connection response