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

Class OMRSMetadataHighwayRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.repositoryservices.rest.server.OMRSMetadataHighwayRESTServices
public class OMRSMetadataHighwayRESTServices extends TokenController
OMRSMetadataHighwayRESTServices provides the server-side implementation for REST services that support the runtime queries of the connected cohorts.

  • Constructor Details

    • OMRSMetadataHighwayRESTServices

      public OMRSMetadataHighwayRESTServices()
      Default constructor

  • Method Details

    • getCohortList

      public CohortListResponse getCohortList(String serverName, String delegatingUserId)
      Return the details of the cohorts that this server is participating in.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      variety of properties

    • getLocalRegistration

      public CohortMembershipResponse getLocalRegistration(String serverName, String delegatingUserId)
      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
      delegatingUserId - external userId making request
      Returns:
      registration properties for server

    • getLocalRegistration

      public CohortMembershipResponse getLocalRegistration(String serverName, String delegatingUserId, 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
      delegatingUserId - external userId making request
      cohortName - name of cohort
      Returns:
      registration properties for server

    • connectToCohort

      public BooleanResponse connectToCohort(String serverName, String delegatingUserId, 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
      delegatingUserId - external userId making request
      cohortName - name of cohort
      Returns:
      flag indicating that the cohort name was recognized

    • getRemoteRegistrations

      public CohortMembershipListResponse getRemoteRegistrations(String serverName, String delegatingUserId, String cohortName)
      Return the list of remote registrations received from a specific cohort.
      Parameters:
      serverName - name of this server
      delegatingUserId - external userId making request
      cohortName - name of cohort
      Returns:
      list of remote members

    • disconnectFromCohort

      public BooleanResponse disconnectFromCohort(String serverName, String delegatingUserId, String cohortName)
      Disconnect communications from a specific cohort.
      Parameters:
      serverName - server to query
      delegatingUserId - external userId making request
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.

    • unregisterFromCohort

      public BooleanResponse unregisterFromCohort(String serverName, String delegatingUserId, String cohortName)
      Unregister from a specific cohort and disconnect from cohort communications.
      Parameters:
      serverName - server to query
      delegatingUserId - external userId making request
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.