Package org.odpi.openmetadata.accessservices.assetowner.client

Class AssetOwnerBaseClient

java.lang.Object

org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwnerBaseClient

All Implemented Interfaces:

RelatedElementsManagementInterface, ConnectorFactoryInterface

Direct Known Subclasses:

AssetCertificationManager, AssetLicenseManager, AssetOwner, ExternalReferenceManager

public class AssetOwnerBaseClient
extends ConnectedAssetClientBase
implements RelatedElementsManagementInterface

AssetOwnerBaseClient supports the common properties and functions for the Community Profile OMAS.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	defaultAssetType
protected NullRequestBody	nullRequestBody
protected final AssetOwnerRESTClient	restClient
protected static final String	serviceURLName
protected final String	urlTemplatePrefix

Fields inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

auditLog, invalidParameterHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clearCatalogTemplate(String userId, String elementGUID, String templateGUID)	Remove a "CatalogTemplate" relationship between two referenceables.
void	clearMoreInformation(String userId, String elementGUID, String detailGUID)	Remove a "MoreInformation" relationship between two referenceables.
void	clearResource(String userId, String elementGUID, String resourceGUID)	Remove a "ResourceList" relationship between two referenceables.
void	clearStakeholder(String userId, String elementGUID, String stakeholderGUID)	Remove a "Stakeholder" relationship between two referenceables.
List<RelatedElement>	getCatalogTemplateList(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the list of templates assigned to an element via the "CatalogTemplate" relationship.
List<RelatedElement>	getDescriptiveElements(String userId, String detailGUID, int startFrom, int pageSize)	Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElement>	getMoreInformation(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElement>	getResourceList(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
List<RelatedElement>	getStakeholderCommissionedElements(String userId, String stakeholderGUID, int startFrom, int pageSize)	Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
List<RelatedElement>	getStakeholders(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
List<RelatedElement>	getSupportedByResource(String userId, String resourceGUID, int startFrom, int pageSize)	Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
List<RelatedElement>	getSupportedByTemplate(String userId, String templateGUID, int startFrom, int pageSize)	Retrieve the list of elements assigned to a template via the "CatalogTemplate" relationship.
void	removeReferenceable(String userId, String elementGUID, String elementGUIDParameterName, String urlTemplate, String methodName)	Remove the metadata element.
void	setupCatalogTemplate(String userId, String elementGUID, String templateGUID)	Create a "CatalogTemplate" relationship between a consuming element and a template element.
void	setupMoreInformation(String userId, String elementGUID, RelationshipProperties properties, String detailGUID)	Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
void	setupResource(String userId, String elementGUID, ResourceListProperties properties, String resourceGUID)	Create a "ResourceList" relationship between a consuming element and an element that represents resources.
void	setupStakeholder(String userId, String elementGUID, StakeholderProperties properties, String stakeholderGUID)	Create a "Stakeholder" relationship between an element and its stakeholder.
void	updateRelationship(String userId, String relationshipGUID, String relationshipGUIDParameterName, boolean isMergeUpdate, String relationshipName, RelationshipProperties properties, String urlTemplate, String methodName)	Update the properties of a multi-link relationship.

Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase

getAnchorAssetFromGUID, getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionByName, getConnectionForAsset, getConnectorByConnection, getConnectorByGUID, getConnectorByName, getConnectorForAsset, getConnectorForConnection, logAssetAuditMessage, saveConnection, saveConnection

Methods inherited from class java.lang.Object

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

Field Details

restClient

protected final AssetOwnerRESTClient restClient

serviceURLName

protected static final String serviceURLName

See Also:

• Constant Field Values

defaultAssetType

protected static final String defaultAssetType

See Also:

• Constant Field Values

urlTemplatePrefix

protected final String urlTemplatePrefix

See Also:

• Constant Field Values

nullRequestBody

protected NullRequestBody nullRequestBody

Constructor Details

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 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 services

auditLog - logging destination

Throws:

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

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize,
 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 services

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

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

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 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 services

Throws:

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

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 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 services

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.

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 int maxPageSize,
 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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

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

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 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 services

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.

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 AssetOwnerRESTClient restClient,
 int maxPageSize)
                     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 services

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

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

AssetOwnerBaseClient

public AssetOwnerBaseClient(String serverName,
 String serverPlatformURLRoot,
 AssetOwnerRESTClient 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 services

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 Details

updateRelationship

public void updateRelationship(String userId,
 String relationshipGUID,
 String relationshipGUIDParameterName,
 boolean isMergeUpdate,
 String relationshipName,
 RelationshipProperties properties,
 String urlTemplate,
 String methodName)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of a multi-link relationship.

Parameters:

userId - calling user

relationshipGUID - unique identifier of the primary element

relationshipGUIDParameterName - name of parameter passing the relationshipGUID

isMergeUpdate - should the supplied properties overlay the existing properties or replace them

relationshipName - type name of relationship

properties - describes the properties for the relationship

urlTemplate - URL to call (no expected placeholders)

methodName - calling method

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeReferenceable

public void removeReferenceable(String userId,
 String elementGUID,
 String elementGUIDParameterName,
 String urlTemplate,
 String methodName)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to remove

elementGUIDParameterName - name of parameter passing the elementGUID

urlTemplate - URL to call (no expected placeholders)

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupMoreInformation

public void setupMoreInformation(String userId,
 String elementGUID,
 RelationshipProperties properties,
 String detailGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.

Specified by:

setupMoreInformation in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

properties - properties of the relationship

detailGUID - unique identifier of the element that provides the detail

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearMoreInformation

public void clearMoreInformation(String userId,
 String elementGUID,
 String detailGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "MoreInformation" relationship between two referenceables.

Specified by:

clearMoreInformation in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

detailGUID - unique identifier of the element that provides the detail

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getMoreInformation

public List<RelatedElement> getMoreInformation(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.

Specified by:

getMoreInformation in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDescriptiveElements

public List<RelatedElement> getDescriptiveElements(String userId,
 String detailGUID,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.

Specified by:

getDescriptiveElements in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

detailGUID - unique identifier of the element that provides the detail

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupStakeholder

public void setupStakeholder(String userId,
 String elementGUID,
 StakeholderProperties properties,
 String stakeholderGUID)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "Stakeholder" relationship between an element and its stakeholder.

Specified by:

setupStakeholder in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

properties - properties of the relationship

stakeholderGUID - unique identifier of the stakeholder

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearStakeholder

public void clearStakeholder(String userId,
 String elementGUID,
 String stakeholderGUID)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "Stakeholder" relationship between two referenceables.

Specified by:

clearStakeholder in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

stakeholderGUID - unique identifier of the stakeholder

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getStakeholders

public List<RelatedElement> getStakeholders(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.

Specified by:

getStakeholders in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getStakeholderCommissionedElements

public List<RelatedElement> getStakeholderCommissionedElements(String userId,
 String stakeholderGUID,
 int startFrom,
 int pageSize)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.

Specified by:

getStakeholderCommissionedElements in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

stakeholderGUID - unique identifier of the stakeholder

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupResource

public void setupResource(String userId,
 String elementGUID,
 ResourceListProperties properties,
 String resourceGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "ResourceList" relationship between a consuming element and an element that represents resources.

Specified by:

setupResource in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

properties - properties of the relationship

resourceGUID - unique identifier of the resource

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearResource

public void clearResource(String userId,
 String elementGUID,
 String resourceGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "ResourceList" relationship between two referenceables.

Specified by:

clearResource in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

resourceGUID - unique identifier of the resource

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getResourceList

public List<RelatedElement> getResourceList(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.

Specified by:

getResourceList in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSupportedByResource

public List<RelatedElement> getSupportedByResource(String userId,
 String resourceGUID,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.

Specified by:

getSupportedByResource in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

resourceGUID - unique identifier of the resource

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupCatalogTemplate

public void setupCatalogTemplate(String userId,
 String elementGUID,
 String templateGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "CatalogTemplate" relationship between a consuming element and a template element.

Specified by:

setupCatalogTemplate in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

templateGUID - unique identifier of the template

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearCatalogTemplate

public void clearCatalogTemplate(String userId,
 String elementGUID,
 String templateGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "CatalogTemplate" relationship between two referenceables.

Specified by:

clearCatalogTemplate in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

templateGUID - unique identifier of the template

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCatalogTemplateList

public List<RelatedElement> getCatalogTemplateList(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of templates assigned to an element via the "CatalogTemplate" relationship.

Specified by:

getCatalogTemplateList in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSupportedByTemplate

public List<RelatedElement> getSupportedByTemplate(String userId,
 String templateGUID,
 int startFrom,
 int pageSize)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of elements assigned to a template via the "CatalogTemplate" relationship.

Specified by:

getSupportedByTemplate in interface RelatedElementsManagementInterface

Parameters:

userId - calling user

templateGUID - unique identifier of the template

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

pageSize - maximum number of elements to return.

Returns:

list of related elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)