org.odpi.openmetadata.adminservices.spring

Class ConfigOpenMetadataSecurityResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigOpenMetadataSecurityResource

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

ConfigOpenMetadataSecurityResource provides the API to configure the security connector that validates platform requests that do not reference an OMAG server. These requests are used by the team that run the platform as a service.

Constructor Summary

Constructors

Constructor and Description
ConfigOpenMetadataSecurityResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearPlatformSecurityConnection(String userId) Clear the connection object for platform security.
VoidResponse	clearServerSecurityConnection(String userId, String serverName) Clear the connection object for the server security connector.
ConnectionResponse	getPlatformSecurityConnection(String userId) Return the connection object for platform security connector.
ConnectionResponse	getServerSecurityConnection(String userId, String serverName) Return the connection object for the server security connector.
VoidResponse	setPlatformSecurityConnection(String userId, PlatformSecurityRequestBody requestBody) Set up a platform 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

ConfigOpenMetadataSecurityResource

public ConfigOpenMetadataSecurityResource()

Method Detail

setPlatformSecurityConnection

@RequestMapping(method=POST,
                path="/platform/security/connection")
public VoidResponse setPlatformSecurityConnection(@PathVariable
                                                                                                                                     String userId,
                                                                                                                                     @RequestBody
                                                                                                                                     PlatformSecurityRequestBody requestBody)

Set up a platform security connector

Parameters:

userId - calling user.

requestBody - requestBody used to create and configure the connector that performs platform security

Returns:

void response

getPlatformSecurityConnection

@RequestMapping(method=GET,
                path="/platform/security/connection")
public ConnectionResponse getPlatformSecurityConnection(@PathVariable
                                                                                                                                          String userId)

Return the connection object for platform security connector. Null is returned if no platform security has been set up.

Parameters:

userId - calling user

Returns:

connection response

clearPlatformSecurityConnection

@RequestMapping(method=DELETE,
                path="/platform/security/connection")
public VoidResponse clearPlatformSecurityConnection(@PathVariable
                                                                                                                                         String userId)

Clear the connection object for platform security. This means there is no platform security set up.

Parameters:

userId - calling user

Returns:

void response

setServerSecurityConnection

@RequestMapping(method=POST,
                path="/servers/{serverName}/security/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

@RequestMapping(method=GET,
                path="/servers/{serverName}/security/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

@RequestMapping(method=DELETE,
                path="/servers/{serverName}/security/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