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

Class AnonRepositoryServicesResource

java.lang.Object

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

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/repository-services")
public class AnonRepositoryServicesResource
extends Object

AnonRepositoryServicesResource provides the server-side support for the OMRS Repository REST Services API that do not include a userId.

Constructor Summary

Constructors

Constructor and Description
AnonRepositoryServicesResource() Default constructor

Method Summary

Modifier and Type	Method and Description
EntityDetailResponse	getEntityDetail(String serverName, String guid) Return the header, classifications and properties of a specific entity.
MetadataCollectionIdResponse	getMetadataCollectionId(String serverName) Returns the identifier of the metadata repository.
RelationshipResponse	getRelationship(String serverName, String guid) Return a requested relationship.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnonRepositoryServicesResource

public AnonRepositoryServicesResource()

Default constructor

Method Detail

getMetadataCollectionId

@GetMapping(path="/metadata-collection-id")
public MetadataCollectionIdResponse getMetadataCollectionId(@PathVariable
                                                                                                        String serverName)

Returns the identifier of the metadata repository. This is the identifier used to register the metadata repository with the metadata repository cohort. It is also the identifier used to identify the home repository of a metadata instance. This method has been deprecated as it does not work on a server that has security enabled.

Parameters:

serverName - unique identifier for requested server.

Returns:

String metadata collection id. or RepositoryErrorException if there is a problem communicating with the metadata repository.

getEntityDetail

@GetMapping(path="/instances/entity/{guid}")
public EntityDetailResponse getEntityDetail(@PathVariable
                                                                                         String serverName,
                                                                                         @PathVariable
                                                                                         String guid)

Return the header, classifications and properties of a specific entity. This method supports anonymous access to an instance. The call may fail if the metadata is secured.

Parameters:

serverName - unique identifier for requested server.

guid - String unique identifier for the entity.

Returns:

EntityDetailResponse: EntityDetail structure or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or EntityNotKnownException the requested entity instance is not known in the metadata collection or EntityProxyOnlyException the requested entity instance is only a proxy in the metadata collection or UserNotAuthorizedException the userId is not permitted to perform this operation.

getRelationship

@GetMapping(path="/instances/relationship/{guid}")
public RelationshipResponse getRelationship(@PathVariable
                                                                                               String serverName,
                                                                                               @PathVariable
                                                                                               String guid)

Return a requested relationship. This is the anonymous form for repository. The call may fail if security is required.

Parameters:

serverName - unique identifier for requested server.

guid - String unique identifier for the relationship.

Returns:

RelationshipResponse: A relationship structure or InvalidParameterException the guid is null or RepositoryErrorException there is a problem communicating with the metadata repository where the metadata collection is stored or RelationshipNotKnownException the metadata collection does not have a relationship with the requested GUID stored or UserNotAuthorizedException the userId is not permitted to perform this operation.