Package org.odpi.openmetadata.viewservices.rex.server

Class RexViewRESTServices

java.lang.Object
org.odpi.openmetadata.viewservices.rex.server.RexViewRESTServices
public class RexViewRESTServices extends Object
The RexViewRESTServices provides the org.odpi.openmetadata.viewservices.rex.services implementation of the Repository Explorer Open Metadata View Service (OMVS). This interface provides view interfaces for enterprise architects.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RexViewRESTServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchResponse
    findEntities(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchBody requestBody)
    Find entities using searchText
    org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchResponse
    findRelationships(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchBody requestBody)
    Find relationships using searchText
    org.odpi.openmetadata.viewservices.rex.api.rest.RexEntityDetailResponse
    getEntity(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexEntityRequestBody requestBody)
    Get entity by GUID
    org.odpi.openmetadata.viewservices.rex.api.rest.RexRelationshipResponse
    getRelationship(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexRelationshipRequestBody requestBody)
    Get relationship by GUID
    org.odpi.openmetadata.viewservices.rex.api.rest.RexResourceEndpointListResponse
    getResourceEndpointList(String serverName, String userId)
    Retrieve platform origin
    org.odpi.openmetadata.viewservices.rex.api.rest.TypeExplorerResponse
    getTypeExplorer(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTypesRequestBody requestBody)
    Load types
    org.odpi.openmetadata.viewservices.rex.api.rest.RexPreTraversalResponse
    preTraversal(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalRequestBody requestBody)
    This method retrieves the neighborhood around a starting entity for pre=traversal
    org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalResponse
    traversal(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalRequestBody requestBody)
    This method retrieves the neighborhood around a starting entity.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RexViewRESTServices

      public RexViewRESTServices()
      Default constructor

  • Method Details

    • getResourceEndpointList

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexResourceEndpointListResponse getResourceEndpointList(String serverName, String userId)
      Retrieve platform origin
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      Returns:
      response the list of resource endpoints configured for the view service

    • getTypeExplorer

      public org.odpi.openmetadata.viewservices.rex.api.rest.TypeExplorerResponse getTypeExplorer(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTypesRequestBody requestBody)
      Load types
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - request body
      Returns:
      response the repository's type information or exception information

    • getEntity

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexEntityDetailResponse getEntity(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexEntityRequestBody requestBody)
      Get entity by GUID
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - request body
      Returns:
      the created category.
      • InvalidParameterException one of the parameters is null or invalid.

    • getRelationship

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexRelationshipResponse getRelationship(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexRelationshipRequestBody requestBody)
      Get relationship by GUID
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - request body
      Returns:
      the created category.
      • InvalidParameterException one of the parameters is null or invalid.

    • findEntities

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchResponse findEntities(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchBody requestBody)
      Find entities using searchText
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - request body
      Returns:
      a RexSearchResponse containing a map of entity digests that match the search parameters. The map has type Map of String to RexEntityDigest, where the key is the entity's GUID
      • InvalidParameterException one of the parameters is null or invalid.

    • findRelationships

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchResponse findRelationships(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexSearchBody requestBody)
      Find relationships using searchText
      Parameters:
      serverName - name of the local view server.
      userId - userId under which the request is performed
      requestBody - request body
      Returns:
      a RexSearchResponse containing a map of relationship digests that match the search parameters. The map has type Map of String to RexRelationshipDigest, where the key is the relationship's GUID
      • InvalidParameterException one of the parameters is null or invalid.

    • preTraversal

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexPreTraversalResponse preTraversal(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalRequestBody requestBody)
      This method retrieves the neighborhood around a starting entity for pre=traversal

      When exploring an entity neighborhood we return an InstanceGraph which contains te entities and relationships that were traversed.

      The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.

      Parameters:
      serverName - name of the server running the view-service.
      userId - user account under which to conduct operation.
      requestBody - request body containing parameters to formulate repository request
      Returns:
      response object containing the InstanceGraph for the traersal or exception information
      • InvalidParameterException one of the parameters is null or invalid.

    • traversal

      public org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalResponse traversal(String serverName, String userId, org.odpi.openmetadata.viewservices.rex.api.rest.RexTraversalRequestBody requestBody)
      This method retrieves the neighborhood around a starting entity.

      When exploring an entity neighborhood we return an InstanceGraph which contains te entities and relationships that were traversed.

      The method used is POST because the parameters supplied by the UI to the VS are conveyed in the request body.

      Parameters:
      serverName - name of the server running the view-service.
      userId - user account under which to conduct operation.
      requestBody - request body containing parameters to formulate repository request
      Returns:
      response object containing the InstanceGraph for the traersal or exception information
      • InvalidParameterException one of the parameters is null or invalid.