Package org.odpi.openmetadata.repositoryservices.rest.server.spring

Class MetadataHighwayServicesResource

java.lang.Object
org.odpi.openmetadata.repositoryservices.rest.server.spring.MetadataHighwayServicesResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/repository-services/users/{userId}/metadata-highway") public class MetadataHighwayServicesResource extends Object
MetadataHighwayServicesResource provides the server-side support for the OMRS Repository REST Services API that provide information about the local server's interaction with an open metadata repository cohort.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MetadataHighwayServicesResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse
    connectToCohort(String serverName, String userId, String cohortName)
    A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository.
    org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse
    disconnectFromCohort(String serverName, String userId, String cohortName)
    Disconnect communications from a specific cohort.
    org.odpi.openmetadata.repositoryservices.rest.properties.CohortListResponse
    getCohorts(String serverName, String userId)
    Return the details of the cohorts that this server is participating in.
    org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipResponse
    getLocalRegistration(String serverName, String userId)
    Return the local registration information used by this server to register with open metadata repository cohorts.
    org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipResponse
    getLocalRegistration(String serverName, String userId, String cohortName)
    Return the local registration information used by this server to register with the requested open metadata repository cohort.
    org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipListResponse
    getRemoteRegistrations(String serverName, String userId, String cohortName)
    Return the list of registrations received from remote members of the cohort.
    org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse
    unregisterFromCohort(String serverName, String userId, String cohortName)
    Unregister from a specific cohort and disconnect from cohort communications.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MetadataHighwayServicesResource

      public MetadataHighwayServicesResource()
      Default constructor

  • Method Details

    • getCohorts

      @GetMapping(path="/cohort-descriptions") public org.odpi.openmetadata.repositoryservices.rest.properties.CohortListResponse getCohorts(@PathVariable String serverName, @PathVariable String userId)
      Return the details of the cohorts that this server is participating in.
      Parameters:
      serverName - name of server
      userId - calling user
      Returns:
      variety of properties

    • getLocalRegistration

      @GetMapping(path="/local-registration") public org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipResponse getLocalRegistration(@PathVariable String serverName, @PathVariable String userId)
      Return the local registration information used by this server to register with open metadata repository cohorts. No registration time is provided. Use the cohort specific version to retrieve the registration time.
      Parameters:
      serverName - server to query
      userId - calling user
      Returns:
      registration properties for server

    • getLocalRegistration

      @GetMapping(path="/cohorts/{cohortName}/local-registration") public org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipResponse getLocalRegistration(@PathVariable String serverName, @PathVariable String userId, @PathVariable String cohortName)
      Return the local registration information used by this server to register with the requested open metadata repository cohort.
      Parameters:
      serverName - server to query
      userId - calling user
      cohortName - name of the specific cohort to query for the registration information
      Returns:
      local registration properties for server

    • connectToCohort

      @GetMapping(path="/cohorts/{cohortName}/connect") public org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse connectToCohort(@PathVariable String serverName, @PathVariable String userId, @PathVariable String cohortName)
      A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository. It only needs to do this once and uses a timestamp to record that the registration event has been sent. If the server has already registered in the past, it sends a reregistration request.
      Parameters:
      serverName - server to query
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known

    • getRemoteRegistrations

      @GetMapping(path="/cohorts/{cohortName}/remote-members") public org.odpi.openmetadata.repositoryservices.rest.properties.CohortMembershipListResponse getRemoteRegistrations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String cohortName)
      Return the list of registrations received from remote members of the cohort.
      Parameters:
      serverName - server to query
      userId - calling user
      cohortName - name of the specific cohort
      Returns:
      list of registration information for remote members

    • disconnectFromCohort

      @GetMapping(path="/cohorts/{cohortName}/disconnect") public org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse disconnectFromCohort(@PathVariable String serverName, @PathVariable String userId, @PathVariable String cohortName)
      Disconnect communications from a specific cohort.
      Parameters:
      serverName - server to query
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known

    • unregisterFromCohort

      @GetMapping(path="/cohorts/{cohortName}/unregister") public org.odpi.openmetadata.repositoryservices.rest.properties.BooleanResponse unregisterFromCohort(@PathVariable String serverName, @PathVariable String userId, @PathVariable String cohortName)
      Unregister from a specific cohort and disconnect from cohort communications.
      Parameters:
      serverName - server to query
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known