Package org.odpi.openmetadata.accessservices.securityofficer.spring

Class SecurityOfficerOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.securityofficer.spring.SecurityOfficerOMASResource

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

Constructor Summary

Constructors

Constructor	Description
SecurityOfficerOMASResource()

Method Summary

Modifier and Type	Method	Description
SecurityOfficerOMASAPIResponse	deleteSecurityTagBySchemaElementIdentifier(String serverName, String userId, String schemaElementId)	Delete the security tag for the given schema element
SecurityOfficerOMASAPIResponse	getSecurityTagBySchemaElementIdentifier(String serverName, String userId)	Returns the security tags available
SecurityOfficerOMASAPIResponse	getSecurityTagBySchemaElementIdentifier(String serverName, String userId, String schemaElementId)	Returns the security tag for the given schema element
SecurityOfficerOMASAPIResponse	getSecurityTagBySchemaElementIdentifier(String serverName, String userId, String schemaElementId, SecurityClassification securityTagClassification)	Save or update the security tag for the given schema element

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityOfficerOMASResource

public SecurityOfficerOMASResource()

Method Detail

getSecurityTagBySchemaElementIdentifier

@GetMapping(path="/security-tag/element/{schemaElementId}",
            produces="application/json")
public SecurityOfficerOMASAPIResponse getSecurityTagBySchemaElementIdentifier(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @PathVariable
                                                                              String schemaElementId)

Returns the security tag for the given schema element

Parameters:

serverName - name of the server instances for this request

userId - String - userId of user making request.

schemaElementId - unique identifier of the schema element

getSecurityTagBySchemaElementIdentifier

@PostMapping(path="/security-tag/element/{schemaElementId}",
             produces="application/json")
public SecurityOfficerOMASAPIResponse getSecurityTagBySchemaElementIdentifier(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @PathVariable
                                                                              String schemaElementId,
                                                                              @RequestBody
                                                                              SecurityClassification securityTagClassification)

Save or update the security tag for the given schema element

Parameters:

serverName - name of the server instances for this request

userId - String - userId of user making request.

securityTagClassification - security tag assigned to the schema element

schemaElementId - unique identifier of the schema element

deleteSecurityTagBySchemaElementIdentifier

@DeleteMapping(path="/security-tag/element/{schemaElementId}",
               produces="application/json")
public SecurityOfficerOMASAPIResponse deleteSecurityTagBySchemaElementIdentifier(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String schemaElementId)

Delete the security tag for the given schema element

Parameters:

serverName - name of the server instances for this request

userId - String - userId of user making request.

schemaElementId - unique identifier of the schema element

getSecurityTagBySchemaElementIdentifier

@GetMapping(path="/security-tag",
            produces="application/json")
public SecurityOfficerOMASAPIResponse getSecurityTagBySchemaElementIdentifier(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId)

Returns the security tags available

Parameters:

serverName - name of the server instances for this request

userId - String - userId of user making request.