Package org.odpi.openmetadata.accessservices.datamanager.client

Class ExternalReferenceManagerClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.ExternalReferenceManagerClient

All Implemented Interfaces:

ExternalReferenceManagerInterface

public class ExternalReferenceManagerClient
extends java.lang.Object
implements ExternalReferenceManagerInterface

ExternalReferenceManagerClient supports the APIs to maintain links to external documentation and other resources.

Constructor Summary

Constructors

Constructor	Description
ExternalReferenceManagerClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
ExternalReferenceManagerClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)	Create a new client that passes userId and password in each HTTP request.
ExternalReferenceManagerClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
ExternalReferenceManagerClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)	Create a new client that is going to be used in an OMAG Server.
ExternalReferenceManagerClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createExternalReference(java.lang.String userId, java.lang.String anchorGUID, java.lang.String linkId, java.lang.String linkDescription, ExternalReferenceProperties properties)	Create a definition of a external reference.
void	deleteExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID)	Remove the definition of a external reference.
java.util.List<ExternalReferenceElement>	findExternalReferencesById(java.lang.String userId, java.lang.String resourceId, int startFrom, int pageSize)	Retrieve the list of external references for this resourceId (qualified name).
java.util.List<ExternalReferenceElement>	findExternalReferencesByURL(java.lang.String userId, java.lang.String url, int startFrom, int pageSize)	Retrieve the list of external references for this URL.
ExternalReferenceElement	getExternalReferenceByGUID(java.lang.String userId, java.lang.String externalReferenceGUID)	Return information about a specific external reference.
void	linkExternalReferenceToElement(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String linkId, java.lang.String linkDescription, java.lang.String externalReferenceGUID)	Link an external reference to an object.
java.util.List<ExternalReferenceElement>	retrieveAttachedExternalReferences(java.lang.String userId, java.lang.String attachedToGUID, int startFrom, int pageSize)	Retrieve the list of external references attached to the supplied object.
void	unlinkExternalReferenceFromElement(java.lang.String userId, java.lang.String attachedToGUID, java.lang.String externalReferenceGUID)	Remove the link between a external reference and an element.
void	updateExternalReference(java.lang.String userId, java.lang.String externalReferenceGUID, boolean isMergeUpdate, ExternalReferenceProperties properties)	Update the definition of a external reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalReferenceManagerClient

public ExternalReferenceManagerClient(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      AuditLog auditLog)
                               throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalReferenceManagerClient

public ExternalReferenceManagerClient(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot)
                               throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalReferenceManagerClient

public ExternalReferenceManagerClient(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password)
                               throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalReferenceManagerClient

public ExternalReferenceManagerClient(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password,
                                      AuditLog auditLog)
                               throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

ExternalReferenceManagerClient

public ExternalReferenceManagerClient(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      DataManagerRESTClient restClient,
                                      int maxPageSize,
                                      AuditLog auditLog)
                               throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createExternalReference

public java.lang.String createExternalReference(java.lang.String userId,
                                                java.lang.String anchorGUID,
                                                java.lang.String linkId,
                                                java.lang.String linkDescription,
                                                ExternalReferenceProperties properties)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Create a definition of a external reference.

Specified by:

createExternalReference in interface ExternalReferenceManagerInterface

Parameters:

userId - calling user

anchorGUID - optional element to link the external reference to that will act as an anchor - that is, this external reference will be deleted when the element is deleted

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

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

properties - properties for a external reference

Returns:

unique identifier of the external reference

Throws:

InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateExternalReference

public void updateExternalReference(java.lang.String userId,
                                    java.lang.String externalReferenceGUID,
                                    boolean isMergeUpdate,
                                    ExternalReferenceProperties properties)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Update the definition of a external reference.

Specified by:

updateExternalReference in interface ExternalReferenceManagerInterface

Parameters:

userId - calling user

externalReferenceGUID - unique identifier of external reference

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - properties to change

Throws:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteExternalReference

public void deleteExternalReference(java.lang.String userId,
                                    java.lang.String externalReferenceGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove the definition of a external reference.

Specified by:

deleteExternalReference in interface ExternalReferenceManagerInterface

Parameters:

userId - calling user

externalReferenceGUID - unique identifier of external reference

Throws:

InvalidParameterException - guid or userId is null; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkExternalReferenceToElement

public void linkExternalReferenceToElement(java.lang.String userId,
                                           java.lang.String attachedToGUID,
                                           java.lang.String linkId,
                                           java.lang.String linkDescription,
                                           java.lang.String externalReferenceGUID)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Link an external reference to an object.

Specified by:

linkExternalReferenceToElement in interface ExternalReferenceManagerInterface

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.

unlinkExternalReferenceFromElement

public void unlinkExternalReferenceFromElement(java.lang.String userId,
                                               java.lang.String attachedToGUID,
                                               java.lang.String externalReferenceGUID)
                                        throws InvalidParameterException,
                                               PropertyServerException,
                                               UserNotAuthorizedException

Remove the link between a external reference and an element. If the element is its anchor, the external reference is removed.

Specified by:

unlinkExternalReferenceFromElement in interface ExternalReferenceManagerInterface

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.

getExternalReferenceByGUID

public ExternalReferenceElement getExternalReferenceByGUID(java.lang.String userId,
                                                           java.lang.String externalReferenceGUID)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Return information about a specific external reference.

Specified by:

getExternalReferenceByGUID in interface ExternalReferenceManagerInterface

Parameters:

userId - calling user

externalReferenceGUID - unique identifier for the external reference

Returns:

properties of the external reference

Throws:

InvalidParameterException - externalReferenceGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findExternalReferencesById

public java.util.List<ExternalReferenceElement> findExternalReferencesById(java.lang.String userId,
                                                                           java.lang.String resourceId,
                                                                           int startFrom,
                                                                           int pageSize)
                                                                    throws InvalidParameterException,
                                                                           PropertyServerException,
                                                                           UserNotAuthorizedException

Retrieve the list of external references for this resourceId (qualified name).

Specified by:

findExternalReferencesById in interface ExternalReferenceManagerInterface

Parameters:

userId - the name of the calling user.

resourceId - unique reference id assigned by the resource owner (supports wildcards). This is the qualified name of the entity

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 java.util.List<ExternalReferenceElement> findExternalReferencesByURL(java.lang.String userId,
                                                                            java.lang.String url,
                                                                            int startFrom,
                                                                            int pageSize)
                                                                     throws InvalidParameterException,
                                                                            PropertyServerException,
                                                                            UserNotAuthorizedException

Retrieve the list of external references for this URL.

Specified by:

findExternalReferencesByURL in interface ExternalReferenceManagerInterface

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.

retrieveAttachedExternalReferences

public java.util.List<ExternalReferenceElement> retrieveAttachedExternalReferences(java.lang.String userId,
                                                                                   java.lang.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 ExternalReferenceManagerInterface

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.