org.odpi.openmetadata.accessservices.governanceprogram.handlers

Class ExternalReferencesHandler

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.handlers.ExternalReferencesHandler

public class ExternalReferencesHandler
extends Object

ExternalReferencesHandler retrieves external references objects that are linked to a specific entity from the property server. It runs server-side in the GovernanceProgram OMAS and retrieves entities and relationships through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
ExternalReferencesHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, OMRSRepositoryHelper repositoryHelper, RepositoryHandler repositoryHandler) Construct the handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
List<ExternalReference>	retrieveExternalReferences(String userId, String attachedEntityGUID) Retrieve the list of external references for this entity.
void	storeExternalReferences(String userId, String attachedEntityGUID, List<ExternalReference> externalReferences) Store the list of external references.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalReferencesHandler

public ExternalReferencesHandler(String serviceName,
                                 String serverName,
                                 InvalidParameterHandler invalidParameterHandler,
                                 OMRSRepositoryHelper repositoryHelper,
                                 RepositoryHandler repositoryHandler)

Construct the handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

Method Detail

storeExternalReferences

public void storeExternalReferences(String userId,
                                    String attachedEntityGUID,
                                    List<ExternalReference> externalReferences)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Store the list of external references.

Parameters:

userId - the name of the calling user.

attachedEntityGUID - entity linked to external references

externalReferences - links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Throws:

InvalidParameterException - the external references are not correctly specified, or are null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.

retrieveExternalReferences

public List<ExternalReference> retrieveExternalReferences(String userId,
                                                          String attachedEntityGUID)
                                                   throws InvalidParameterException,
                                                          PropertyServerException,
                                                          UserNotAuthorizedException

Retrieve the list of external references for this entity.

Parameters:

userId - the name of the calling user.

attachedEntityGUID - entity linked to external references

Returns:

links to addition information. This could be, for example, the home page for the governance officer, or details of the role.

Throws:

InvalidParameterException - the external references are not correctly specified, or are null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.