Package org.odpi.openmetadata.adminservices.spring

Class ConfigOpenMetadataServerSecurityResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigOpenMetadataServerSecurityResource

@RestController
@RequestMapping("/open-metadata/admin-services/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 serverName, String delegatingUserId)	Clear the connection object for the server security connector.
ConnectionResponse	getServerSecurityConnection(String serverName, String delegatingUserId)	Return the connection object for the server security connector.
VoidResponse	setServerSecurityConnection(String serverName, String delegatingUserId, Connection connection)	Override the existing server security connector.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigOpenMetadataServerSecurityResource

public ConfigOpenMetadataServerSecurityResource()

Method Details

setServerSecurityConnection

@PostMapping(path="/connection")
public VoidResponse setServerSecurityConnection(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId,
 @RequestBody
 Connection connection)

Override the existing server security connector.

Parameters:

serverName - server to configure

delegatingUserId - external userId making request

connection - connection used to create and configure the connector.

Returns:

void response

getServerSecurityConnection

@GetMapping(path="/connection")
public ConnectionResponse getServerSecurityConnection(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId)

Return the connection object for the server security connector.

Parameters:

serverName - server to retrieve configuration from

delegatingUserId - external userId making request

Returns:

connection response

clearServerSecurityConnection

@DeleteMapping(path="/connection")
public VoidResponse clearServerSecurityConnection(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String delegatingUserId)

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

Parameters:

serverName - server to configure

delegatingUserId - external userId making request

Returns:

connection response