SecurityOfficerRequestHandler (Security Officer OMAS Server-side 2.7 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.securityofficer.server.handler.SecurityOfficerRequestHandler

```
public class SecurityOfficerRequestHandler
extends Object
```
SecurityOfficerRequestHandler supports REST requests for security officer function.

Constructor Summary

Constructors
Constructor and Description
`SecurityOfficerRequestHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSMetadataCollection metadataCollection, OMRSRepositoryHelper repositoryHelper, RepositoryErrorHandler errorHandler, List<String> supportedZones, SecurityOfficerPublisher securityOfficerPublisher)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<SecuritySchemaElement>`	`deleteSecurityTagBySchemaElementId(String userId, String schemaElementId, String methodName)`
`List<SecurityClassification>`	`getAvailableSecurityTags(String userId, String methodName)`
`SecurityClassification`	`getSecurityTagBySchemaElementId(String userId, String schemaElementId, String methodName)`
`List<SecuritySchemaElement>`	`updateSecurityTagBySchemaElementId(String userId, String schemaElementId, SecurityClassification securityClassification, String methodName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityOfficerRequestHandler

public SecurityOfficerRequestHandler(String serviceName,
                                     String serverName,
                                     InvalidParameterHandler invalidParameterHandler,
                                     RepositoryHandler repositoryHandler,
                                     OMRSMetadataCollection metadataCollection,
                                     OMRSRepositoryHelper repositoryHelper,
                                     RepositoryErrorHandler errorHandler,
                                     List<String> supportedZones,
                                     SecurityOfficerPublisher securityOfficerPublisher)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; errorHandler - provides utilities for manipulating the repository services; supportedZones - setting of the supported zones for the handler; securityOfficerPublisher - outbound publisher

Method Detail

getSecurityTagBySchemaElementId

public SecurityClassification getSecurityTagBySchemaElementId(String userId,
                                                              String schemaElementId,
                                                              String methodName)
                                                       throws PropertyServerException

Throws:: PropertyServerException

updateSecurityTagBySchemaElementId

public List<SecuritySchemaElement> updateSecurityTagBySchemaElementId(String userId,
                                                                      String schemaElementId,
                                                                      SecurityClassification securityClassification,
                                                                      String methodName)
                                                               throws PropertyServerException,
                                                                      RepositoryErrorException,
                                                                      ClassificationErrorException,
                                                                      UserNotAuthorizedException,
                                                                      EntityNotKnownException,
                                                                      FunctionNotSupportedException,
                                                                      InvalidParameterException,
                                                                      PropertyErrorException,
                                                                      EntityProxyOnlyException,
                                                                      TypeDefNotKnownException,
                                                                      TypeErrorException,
                                                                      PagingErrorException

Throws:: PropertyServerException; RepositoryErrorException; ClassificationErrorException; UserNotAuthorizedException; EntityNotKnownException; FunctionNotSupportedException; InvalidParameterException; PropertyErrorException; EntityProxyOnlyException; TypeDefNotKnownException; TypeErrorException; PagingErrorException

deleteSecurityTagBySchemaElementId

public List<SecuritySchemaElement> deleteSecurityTagBySchemaElementId(String userId,
                                                                      String schemaElementId,
                                                                      String methodName)
                                                               throws PropertyServerException,
                                                                      RepositoryErrorException,
                                                                      UserNotAuthorizedException,
                                                                      EntityProxyOnlyException,
                                                                      InvalidParameterException,
                                                                      EntityNotKnownException,
                                                                      ClassificationErrorException,
                                                                      TypeErrorException,
                                                                      TypeDefNotKnownException,
                                                                      PagingErrorException,
                                                                      FunctionNotSupportedException,
                                                                      PropertyErrorException

Throws:: PropertyServerException; RepositoryErrorException; UserNotAuthorizedException; EntityProxyOnlyException; InvalidParameterException; EntityNotKnownException; ClassificationErrorException; TypeErrorException; TypeDefNotKnownException; PagingErrorException; FunctionNotSupportedException; PropertyErrorException

getAvailableSecurityTags

public List<SecurityClassification> getAvailableSecurityTags(String userId,
                                                             String methodName)
                                                      throws PropertyServerException,
                                                             RepositoryErrorException,
                                                             InvalidParameterException,
                                                             TypeDefNotKnownException,
                                                             UserNotAuthorizedException,
                                                             TypeErrorException,
                                                             FunctionNotSupportedException,
                                                             ClassificationErrorException,
                                                             PagingErrorException,
                                                             PropertyErrorException

Throws:: PropertyServerException; RepositoryErrorException; InvalidParameterException; TypeDefNotKnownException; UserNotAuthorizedException; TypeErrorException; FunctionNotSupportedException; ClassificationErrorException; PagingErrorException; PropertyErrorException

Class SecurityOfficerRequestHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecurityOfficerRequestHandler

Method Detail

getSecurityTagBySchemaElementId

updateSecurityTagBySchemaElementId

deleteSecurityTagBySchemaElementId

getAvailableSecurityTags