Package org.odpi.openmetadata.viewservices.classificationexplorer.server

Class ClassificationExplorerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.classificationexplorer.server.ClassificationExplorerRESTServices
public class ClassificationExplorerRESTServices extends TokenController
The ClassificationExplorerRESTServices provides the implementation of the Classification Explorer Open Metadata View Service (OMVS). This interface provides view interfaces for glossary UIs.

  • Constructor Details

    • ClassificationExplorerRESTServices

      public ClassificationExplorerRESTServices()
      Default constructor

  • Method Details

    • getImpactClassifiedElements

      public MetadataElementSummariesResponse getImpactClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the impact classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getConfidenceClassifiedElements

      public MetadataElementSummariesResponse getConfidenceClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getCriticalityClassifiedElements

      public MetadataElementSummariesResponse getCriticalityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the criticality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getConfidentialityClassifiedElements

      public MetadataElementSummariesResponse getConfidentialityClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidentiality classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getRetentionClassifiedElements

      public MetadataElementSummariesResponse getRetentionClassifiedElements(String serverName, String urlMarker, LevelIdentifierQueryProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getSecurityTaggedElements

      public MetadataElementSummariesResponse getSecurityTaggedElements(String serverName, String urlMarker, SecurityTagQueryProperties requestBody)
      Return information about the elements classified with the security tags classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getOwnersElements

      public MetadataElementSummariesResponse getOwnersElements(String serverName, String urlMarker, FindNameProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getMembersOfSubjectArea

      public MetadataElementSummariesResponse getMembersOfSubjectArea(String serverName, String urlMarker, FindNameProperties requestBody)
      Return information about the elements classified with the confidence classification.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getElementsByOrigin

      public MetadataElementSummariesResponse getElementsByOrigin(String serverName, String urlMarker, FindDigitalResourceOriginProperties requestBody)
      Return information about the elements from a specific origin.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      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

    • getMeanings

      public RelatedMetadataElementSummariesResponse getMeanings(String serverName, String urlMarker, String elementGUID, SemanticAssignmentQueryProperties requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that is being assigned to the glossary term
      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

    • getSemanticAssignees

      public RelatedMetadataElementSummariesResponse getSemanticAssignees(String serverName, String urlMarker, String glossaryTermGUID, SemanticAssignmentQueryProperties requestBody)
      Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
      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

    • getGovernedElements

      public RelatedMetadataElementSummariesResponse getGovernedElements(String serverName, String urlMarker, String governanceDefinitionGUID, FindProperties requestBody)
      Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
      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

    • getGovernedByDefinitions

      public RelatedMetadataElementSummariesResponse getGovernedByDefinitions(String serverName, String urlMarker, String elementGUID, FindProperties requestBody)
      Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getSourceElements

      public RelatedMetadataElementSummariesResponse getSourceElements(String serverName, String urlMarker, String elementGUID, FindProperties requestBody)
      Retrieve the elements linked via a "SourcedFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically only one element is returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the governance definition that the returned elements are linked to
      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

    • getElementsSourcedFrom

      public RelatedMetadataElementSummariesResponse getElementsSourcedFrom(String serverName, String urlMarker, String elementGUID, FindProperties requestBody)
      Retrieve the elements linked via a "SourcedFrom" relationship to the requested element. The elements returned were created using the requested element as a template.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getScopes

      public RelatedMetadataElementSummariesResponse getScopes(String serverName, String urlMarker, String elementGUID, FindProperties requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getScopedElements

      public RelatedMetadataElementSummariesResponse getScopedElements(String serverName, String urlMarker, String scopeGUID, FindProperties requestBody)
      Retrieve the elements linked via a "ScopedBy" relationship to the requested scope.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      scopeGUID - unique identifier of the element that the returned elements are linked to
      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

    • getResourceList

      public RelatedMetadataElementSummariesResponse getResourceList(String serverName, String urlMarker, String elementGUID, FindProperties requestBody)
      Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the returned elements are linked to
      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

    • getSupportedByResource

      public RelatedMetadataElementSummariesResponse getSupportedByResource(String serverName, String urlMarker, String resourceGUID, FindProperties requestBody)
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      resourceGUID - unique identifier of the element that the returned elements are linked to
      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

    • getLicensedElements

      public RelatedMetadataElementSummariesResponse getLicensedElements(String serverName, String urlMarker, String licenseTypeGUID, ResultsRequestBody requestBody)
      Return information about the elements linked to a license type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      licenseTypeGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getLicenses

      public RelatedMetadataElementSummariesResponse getLicenses(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Return information about the licenses linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifiedElements

      public CertificationElementsResponse getCertifiedElements(String serverName, String urlMarker, String certificationTypeGUID, ResultsRequestBody requestBody)
      Return information about the elements linked to a certification type.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      certificationTypeGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifications

      public CertificationElementsResponse getCertifications(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody)
      Return information about the certifications linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the license
      requestBody - additional query parameters
      Returns:
      properties of the license or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getMetadataElementByGUID

      public MetadataElementSummaryResponse getMetadataElementByGUID(String serverName, String urlMarker, String elementGUID, FindRequest requestBody)
      Retrieve the metadata element using its unique identifier.
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      elementGUID - unique identifier for the metadata element
      requestBody - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementByUniqueName

      public MetadataElementSummaryResponse getMetadataElementByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties requestBody)
      Retrieve the metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - unique name for the metadata element
      Returns:
      metadata element properties or InvalidParameterException the unique identifier is null or not known. UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store

    • getMetadataElementGUIDByUniqueName

      public GUIDResponse getMetadataElementGUIDByUniqueName(String serverName, String urlMarker, FindPropertyNameProperties requestBody)
      Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
      Parameters:
      serverName - name of server instance to route request to
      urlMarker - view service URL marker
      requestBody - unique name for the metadata element
      Returns:
      metadata element unique identifier (guid) or InvalidParameterException the unique identifier is null or not known or UserNotAuthorizedException the governance action service is not able to access the element or PropertyServerException there is a problem accessing the metadata store

    • getElements

      public MetadataElementSummariesResponse getElements(String serverName, String urlMarker, FindProperties requestBody)
      Retrieve elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByPropertyValue

      public MetadataElementSummariesResponse getElementsByPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByPropertyValue

      public MetadataElementSummariesResponse findElementsByPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)
      Retrieve elements by a value found in one of the properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassification

      public MetadataElementSummariesResponse getElementsByClassification(String serverName, String urlMarker, String classificationName, FindProperties requestBody)
      Retrieve elements with the requested classification name. It is also possible to limit the results by specifying a type name for the elements that should be returned. If no type name is specified then any type of element may be returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getElementsByClassificationWithPropertyValue

      public MetadataElementSummariesResponse getElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findElementsByClassificationWithPropertyValue

      public MetadataElementSummariesResponse findElementsByClassificationWithPropertyValue(String serverName, String urlMarker, String classificationName, FindPropertyNamesProperties requestBody)
      Retrieve elements with the requested classification name and with the requested a value found in one of the classification's properties specified. The value must be contained in the properties rather than needing to be an exact match. An open metadata type name may be supplied to restrict the results.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      classificationName - name of classification
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElements

      public RelatedMetadataElementSummariesResponse getRelatedElements(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindProperties requestBody)
      Retrieve related elements of the requested type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedElementsWithPropertyValue

      public RelatedMetadataElementSummariesResponse getRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the requested a value found in one of the classification's properties specified. The value must match exactly. An open metadata type name may be supplied to restrict the types of elements returned.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelatedElementsWithPropertyValue

      public RelatedMetadataElementSummariesResponse findRelatedElementsWithPropertyValue(String serverName, String urlMarker, String elementGUID, String relationshipTypeName, int startingAtEnd, FindPropertyNamesProperties requestBody)
      Retrieve elements linked via the requested relationship type name and with the relationship's properties specified. The value must be contained in one of the properties specified (or any property if no property names are specified). An open metadata type name may be supplied to restrict the linked elements that are matched.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the starting element
      relationshipTypeName - name of relationship
      startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationships

      public MetadataRelationshipSummariesResponse getRelationships(String serverName, String urlMarker, FindProperties requestBody)
      Retrieve relationships of the requested relationship type name.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelationshipsWithPropertyValue

      public MetadataRelationshipSummariesResponse getRelationshipsWithPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must match exactly.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findRelationshipsWithPropertyValue

      public MetadataRelationshipSummariesResponse findRelationshipsWithPropertyValue(String serverName, String urlMarker, FindPropertyNamesProperties requestBody)
      Retrieve relationships of the requested relationship type name and with the requested a value found in one of the relationship's properties specified. The value must only be contained in the properties rather than needing to be an exact match.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      requestBody - properties and optional open metadata type to search on
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • retrieveInstanceForGUID

      public ElementHeaderResponse retrieveInstanceForGUID(String serverName, String urlMarker, String guid, GetRequestBody requestBody)
      Retrieve the header for the instance identified by the supplied unique identifier. It may be an element (entity) or a relationship between elements.
      Parameters:
      serverName - name of the server instance to connect to
      urlMarker - view service URL marker
      guid - identifier to use in the lookup
      requestBody - effective time
      Returns:
      list of matching elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)