Package org.odpi.openmetadata.viewservices.privacyofficer.server

Class PrivacyOfficerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.privacyofficer.server.PrivacyOfficerRESTServices
public class PrivacyOfficerRESTServices extends TokenController
The PrivacyOfficerRESTServices provides the server-side implementation of the Privacy Officer Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • PrivacyOfficerRESTServices

      public PrivacyOfficerRESTServices()
      Default constructor

  • Method Details

    • linkPermittedProcessing

      public VoidResponse linkPermittedProcessing(String serverName, String dataProcessingPurposeGUID, String dataProcessingDescriptionGUID, NewRelationshipRequestBody requestBody)
      Link a data processing purpose to a data processing description.
      Parameters:
      serverName - name of called server
      dataProcessingPurposeGUID - unique identifier of the data processing purpose
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPermittedProcessing

      public VoidResponse detachPermittedProcessing(String serverName, String dataProcessingPurposeGUID, String dataProcessingDescriptionGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data processing purpose from a data processing description.
      Parameters:
      serverName - name of called server
      dataProcessingPurposeGUID - unique identifier of the data processing purpose
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDataProcessingTarget

      public VoidResponse linkDataProcessingTarget(String serverName, String dataProcessingActionGUID, String targetGUID, NewRelationshipRequestBody requestBody)
      Link a data processing action to a target element.
      Parameters:
      serverName - name of called server
      dataProcessingActionGUID - unique identifier of the data processing action
      targetGUID - unique identifier of the target element
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDataProcessingTarget

      public VoidResponse detachDataProcessingTarget(String serverName, String dataProcessingActionGUID, String targetGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data processing action from a target element.
      Parameters:
      serverName - name of called server
      dataProcessingActionGUID - unique identifier of the data processing action
      targetGUID - unique identifier of the target element
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDataProcessingSpecification

      public VoidResponse linkDataProcessingSpecification(String serverName, String elementGUID, String dataProcessingDescriptionGUID, NewRelationshipRequestBody requestBody)
      Attach a data processing description to the element that performs the processing.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that performs the data processing
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDataProcessingSpecification

      public VoidResponse detachDataProcessingSpecification(String serverName, String elementGUID, String dataProcessingDescriptionGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data processing description from the element that performed the processing.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that performs the data processing
      dataProcessingDescriptionGUID - unique identifier of the data processing description
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkDetailedProcessingAction

      public VoidResponse linkDetailedProcessingAction(String serverName, String parentProcessingActionGUID, String childProcessingActionGUID, NewRelationshipRequestBody requestBody)
      Attach a child data processing action to its parent data processing action.
      Parameters:
      serverName - name of the server to route the request to
      parentProcessingActionGUID - unique identifier of the parent data processing action
      childProcessingActionGUID - unique identifier of the child data processing action
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDetailedProcessingAction

      public VoidResponse detachDetailedProcessingAction(String serverName, String parentProcessingActionGUID, String childProcessingActionGUID, DeleteRelationshipRequestBody requestBody)
      Detach a child data processing action from its parent data processing action.
      Parameters:
      serverName - name of the server to route the request to
      parentProcessingActionGUID - unique identifier of the parent data processing action
      childProcessingActionGUID - unique identifier of the child data processing action
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)