Package org.odpi.openmetadata.viewservices.classificationmanager.server

Class ClassificationManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.classificationmanager.server.ClassificationManagerRESTServices
public class ClassificationManagerRESTServices extends TokenController
The ClassificationManagerRESTServices provides the implementation of the Classification ManagerOpen Metadata View Service (OMVS). This interface provides view interfaces for infrastructure and ops users.

  • Constructor Details

    • ClassificationManagerRESTServices

      public ClassificationManagerRESTServices()
      Default constructor

  • Method Details

    • setImpactClassification

      public VoidResponse setImpactClassification(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically a context event, to do or incident report) to indicate the level of impact that the event is expected to have on the organization The level of impact is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearImpactClassification

      public VoidResponse clearImpactClassification(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the impact classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConfidenceClassification

      public VoidResponse setConfidenceClassification(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate the level of confidence that the organization has that the data is complete, accurate and up-to-date. The level of confidence is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidenceClassification

      public VoidResponse clearConfidenceClassification(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidence to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setCriticalityClassification

      public VoidResponse setCriticalityClassification(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate how critical the element (or associated resource) is to the organization. The level of criticality is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearCriticalityClassification

      public VoidResponse clearCriticalityClassification(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the criticality classification from the element. This normally occurs when the organization has lost track of the level of criticality to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setConfidentialityClassification

      public VoidResponse setConfidentialityClassification(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically a data field, schema attribute or glossary term) to indicate the level of confidentiality that any data associated with the element should be given. If the classification is attached to a glossary term, the level of confidentiality is a suggestion for any element linked to the glossary term via the SemanticAssignment classification. The level of confidence is expressed by the levelIdentifier property.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearConfidentialityClassification

      public VoidResponse clearConfidentialityClassification(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the confidence classification from the element. This normally occurs when the organization has lost track of the level of confidentiality to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setRetentionClassification

      public VoidResponse setRetentionClassification(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify/reclassify the element (typically an asset) to indicate how long the element (or associated resource) is to be retained by the organization. The policy to apply to the element/resource is captured by the retentionBasis property. The dates after which the element/resource is archived and then deleted are specified in the archiveAfter and deleteAfter properties respectively.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearRetentionClassification

      public VoidResponse clearRetentionClassification(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the retention classification from the element. This normally occurs when the organization has lost track of, or no longer needs to track the retention period to assign to the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addGovernanceExpectations

      public VoidResponse addGovernanceExpectations(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateGovernanceExpectations

      public VoidResponse updateGovernanceExpectations(String serverName, String elementGUID, UpdateClassificationRequestBody requestBody)
      Update the governance expectations classification to an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearGovernanceExpectations

      public VoidResponse clearGovernanceExpectations(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the governance expectations classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addGovernanceMeasurements

      public VoidResponse addGovernanceMeasurements(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the governance measurements for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateGovernanceMeasurements

      public VoidResponse updateGovernanceMeasurements(String serverName, String elementGUID, UpdateClassificationRequestBody requestBody)
      Update the governance measurements for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearGovernanceMeasurements

      public VoidResponse clearGovernanceMeasurements(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the governance measurements classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSecurityTags

      public VoidResponse addSecurityTags(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the security tags for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element to attach to
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSecurityTags

      public VoidResponse clearSecurityTags(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the security tags classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of element
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addOwnership

      public VoidResponse addOwnership(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the ownership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearOwnership

      public VoidResponse clearOwnership(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the ownership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addOrigin

      public VoidResponse addOrigin(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the DigitalResourceOrigin classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearOrigin

      public VoidResponse clearOrigin(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the DigitalResourceOrigin classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addZoneMembership

      public VoidResponse addZoneMembership(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Add the zone membership classification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearZoneMembership

      public VoidResponse clearZoneMembership(String serverName, String elementGUID, MetadataSourceRequestBody requestBody)
      Remove the zone membership classification from an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - element where the classification needs to be cleared from.
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setupSemanticAssignment

      public VoidResponse setupSemanticAssignment(String serverName, String elementGUID, String glossaryTermGUID, NewRelationshipRequestBody requestBody)
      Create a semantic assignment relationship between a glossary term and an element (normally a schema attribute, data field or asset). This relationship indicates that the data associated with the element meaning matches the description in the glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearSemanticAssignment

      public VoidResponse clearSemanticAssignment(String serverName, String elementGUID, String glossaryTermGUID, DeleteRequestBody requestBody)
      Remove a semantic assignment relationship between an element and its glossary term.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      glossaryTermGUID - unique identifier of the glossary term that provides the meaning
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addScopeToElement

      public VoidResponse addScopeToElement(String serverName, String elementGUID, String scopeGUID, NewRelationshipRequestBody requestBody)
      Link a scope to an element using the ScopedBy relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      scopeGUID - identifier of the scope to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeScopeFromElement

      public VoidResponse removeScopeFromElement(String serverName, String elementGUID, String scopeGUID, DeleteRequestBody requestBody)
      Remove the ScopedBy relationship between a scope and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      scopeGUID - identifier of the scope to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addResourceListToElement

      public VoidResponse addResourceListToElement(String serverName, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)
      Link a resource to an element using the ResourceList relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeResourceListFromElement

      public VoidResponse removeResourceListFromElement(String serverName, String elementGUID, String resourceGUID, DeleteRequestBody requestBody)
      Remove the ResourceList relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addMoreInformationToElement

      public VoidResponse addMoreInformationToElement(String serverName, String elementGUID, String resourceGUID, NewRelationshipRequestBody requestBody)
      Link a resource to an element using the MoreInformation relationship.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to link
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeMoreInformationFromElement

      public VoidResponse removeMoreInformationFromElement(String serverName, String elementGUID, String resourceGUID, DeleteRequestBody requestBody)
      Remove the MoreInformation relationship between a resource and an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      resourceGUID - identifier of the resource to link
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem