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

Class 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 Detail

      • RexViewRESTServices

        public RexViewRESTServices()
        Default constructor

    • Method Detail

      • getResourceEndpointList

        public 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 TypeExplorerResponse getTypeExplorer​(String serverName,
                                            String userId,
                                            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 RexEntityDetailResponse getEntity​(String serverName,
                                         String userId,
                                         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 RexRelationshipResponse getRelationship​(String serverName,
                                               String userId,
                                               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 RexSearchResponse findEntities​(String serverName,
                                      String userId,
                                      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 RexSearchResponse findRelationships​(String serverName,
                                           String userId,
                                           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 RexPreTraversalResponse preTraversal​(String serverName,
                                            String userId,
                                            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 RexTraversalResponse traversal​(String serverName,
                                      String userId,
                                      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.