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
CohortListResponse	getCohorts(String serverName, String userId)	Return the details of the cohorts that this server is participating in.
CohortMembershipResponse	getLocalRegistration(String serverName, String userId)	Return the local registration information used by this server to register with open metadata repository cohorts.
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.
CohortMembershipListResponse	getRemoteRegistrations(String serverName, String userId, String cohortName)	Return the list of registrations received from remote members of the cohort.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataHighwayServicesResource

public MetadataHighwayServicesResource()

Default constructor

Method Detail

getCohorts

@GetMapping(path="/cohort-descriptions")
public 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 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 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

getRemoteRegistrations

@GetMapping(path="/cohorts/{cohortName}/remote-members")
public 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