org.odpi.openmetadata.accessservices.communityprofile.handlers

Class ExternalReferencesHandler

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.handlers.ExternalReferencesHandler

All Implemented Interfaces:

ExternalReferenceManagementInterface

public class ExternalReferencesHandler
extends Object
implements ExternalReferenceManagementInterface

ExternalReferencesHandler retrieves external references objects that are linked to a specific entity from the property server. It runs server-side in the CommunityProfile 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, RepositoryErrorHandler errorHandler) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
void	deleteExternalReference(String userId, String externalReferenceGUID, String externalReferenceId) Delete an external reference.
List<ExternalReference>	findExternalReferencesById(String userId, String resourceId, int startFrom, int pageSize) Retrieve the list of external references for this resourceId.
List<ExternalReference>	findExternalReferencesByURL(String userId, String url, int startFrom, int pageSize) Retrieve the list of external references for the supplied URL.
ExternalReference	getExternalReference(String userId, String externalReferenceGUID) Retrieve the external reference for this unique identifier (guid).
void	linkExternalReference(String userId, String attachedToGUID, String linkId, String linkDescription, String externalReferenceGUID) Link an external reference to an object.
List<ExternalReference>	retrieveAttachedExternalReferences(String userId, String attachedToGUID, int startFrom, int pageSize) Retrieve the list of external references attached to the supplied object.
String	storeExternalReference(String userId, String attachedToGUID, String linkId, String linkDescription, String resourceId, String resourceDisplayName, String resourceDescription, String resourceURL, String resourceVersion, String owningOrganization, Map<String,Object> resourceProperties, Map<String,String> additionalProperties) Store a new external reference.
void	unlinkExternalReference(String userId, String attachedToGUID, String externalReferenceGUID) Unlink an external reference from an object.

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,
                                 RepositoryErrorHandler errorHandler)

Construct the discovery engine configuration 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

errorHandler - handler for repository service errors

Method Detail

findExternalReferencesById

public List<ExternalReference> findExternalReferencesById(String userId,
                                                          String resourceId,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          PropertyServerException,
                                                          UserNotAuthorizedException

Retrieve the list of external references for this resourceId.

Specified by:

findExternalReferencesById in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

resourceId - unique reference id assigned by the resource owner (supports wildcards).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information.

Throws:

InvalidParameterException - guid invalid or 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.

findExternalReferencesByURL

public List<ExternalReference> findExternalReferencesByURL(String userId,
                                                           String url,
                                                           int startFrom,
                                                           int pageSize)
                                                    throws InvalidParameterException,
                                                           PropertyServerException,
                                                           UserNotAuthorizedException

Retrieve the list of external references for the supplied URL.

Specified by:

findExternalReferencesByURL in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

url - URL of the external resource.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information.

Throws:

InvalidParameterException - guid invalid or 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.

getExternalReference

public ExternalReference getExternalReference(String userId,
                                              String externalReferenceGUID)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Retrieve the external reference for this unique identifier (guid).

Specified by:

getExternalReference in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

externalReferenceGUID - unique identifier (guid) of the external reference details.

Returns:

links to addition information.

Throws:

InvalidParameterException - guid invalid or 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.

retrieveAttachedExternalReferences

public List<ExternalReference> retrieveAttachedExternalReferences(String userId,
                                                                  String attachedToGUID,
                                                                  int startFrom,
                                                                  int pageSize)
                                                           throws InvalidParameterException,
                                                                  PropertyServerException,
                                                                  UserNotAuthorizedException

Retrieve the list of external references attached to the supplied object.

Specified by:

retrieveAttachedExternalReferences in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

attachedToGUID - object linked to external reference.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

links to addition information.

Throws:

InvalidParameterException - guid invalid or 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.

linkExternalReference

public void linkExternalReference(String userId,
                                  String attachedToGUID,
                                  String linkId,
                                  String linkDescription,
                                  String externalReferenceGUID)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException

Link an external reference to an object.

Specified by:

linkExternalReference in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

attachedToGUID - object linked to external references.

linkId - identifier for the reference from the perspective of the object that the reference is being attached to.

linkDescription - description for the reference from the perspective of the object that the reference is being attached to.

externalReferenceGUID - unique identifier (guid) of the external reference details.

Throws:

InvalidParameterException - problem with the GUID or 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.

unlinkExternalReference

public void unlinkExternalReference(String userId,
                                    String attachedToGUID,
                                    String externalReferenceGUID)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Unlink an external reference from an object.

Specified by:

unlinkExternalReference in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

attachedToGUID - object linked to external references.

externalReferenceGUID - identifier of the external reference.

Throws:

InvalidParameterException - problem with the GUID or 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.

storeExternalReference

public String storeExternalReference(String userId,
                                     String attachedToGUID,
                                     String linkId,
                                     String linkDescription,
                                     String resourceId,
                                     String resourceDisplayName,
                                     String resourceDescription,
                                     String resourceURL,
                                     String resourceVersion,
                                     String owningOrganization,
                                     Map<String,Object> resourceProperties,
                                     Map<String,String> additionalProperties)
                              throws InvalidParameterException,
                                     PropertyServerException,
                                     UserNotAuthorizedException

Store a new external reference.

Specified by:

storeExternalReference in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

attachedToGUID - object linked to external references.

linkId - identifier for the reference from the perspective of the object that the reference is being attached to.

linkDescription - description for the reference from the perspective of the object that the reference is being attached to.

resourceId - unique reference id assigned by the resource owner.

resourceDisplayName - display name for the resource.

resourceDescription - generic description of the resource.

resourceURL - URL to access the resource.

resourceVersion - version number of the resource.

owningOrganization - organization the owns the resource.

resourceProperties - properties defined as part of a subclass of ExternalReference

additionalProperties - arbitrary additional properties.

Returns:

unique identifier (guid) of the new ExternalReference.

Throws:

InvalidParameterException - problem with the GUID or 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.

deleteExternalReference

public void deleteExternalReference(String userId,
                                    String externalReferenceGUID,
                                    String externalReferenceId)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Delete an external reference.

Specified by:

deleteExternalReference in interface ExternalReferenceManagementInterface

Parameters:

userId - the name of the calling user.

externalReferenceGUID - unique identifier (guid) of the external reference.

externalReferenceId - unique name of the external reference.

Throws:

InvalidParameterException - problem with the GUID or 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.