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

Class ValidValuesAssetOwner

java.lang.Object

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

org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

org.odpi.openmetadata.accessservices.assetowner.client.ValidValuesAssetOwner

All Implemented Interfaces:

AssetClassificationInterface, AssetConnectionManagementInterface, AssetDecommissioningInterface, AssetDuplicateManagementInterface, AssetKnowledgeInterface, AssetOnboardingInterface, AssetOnboardingValidValues, AssetReviewInterface

public class ValidValuesAssetOwner
extends AssetOwner
implements AssetOnboardingValidValues

ValidValuesAssetOwner provides the API operations to create and maintain lists of valid value definitions grouped into a valid value set. Both valid value definitions and valid value sets have the same attributes and so inherit from ValidValue where all of the attributes are defined. A set is just grouping of valid values. Valid value definitions and set can be nested many times in other valid value sets.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

restClient

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

auditLog, invalidParameterHandler, nullRequestBody, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	attachValidValueToSet(String userId, String setGUID, String validValueGUID)	Create a link between a valid value set or definition and a set.
String	createValidValueDefinition(String userId, String setGUID, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Create a new valid value definition.
String	createValidValueSet(String userId, String qualifiedName, String displayName, String description, String usage, String scope, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Create a new valid value set.
void	deleteValidValue(String userId, String validValueGUID, String qualifiedName)	Remove the valid value form the repository.
void	detachValidValueFromSet(String userId, String setGUID, String validValueGUID)	Remove the link between a valid value and a set it is a member of.
List<ValidValueElement>	findValidValues(String userId, String searchString, int startFrom, int pageSize)	Locate valid values that match the search string.
List<ValidValueElement>	getSetsForValidValue(String userId, String validValueGUID, int startFrom, int pageSize)	Page through the list of valid value sets that a valid value definition/set belongs to.
ValidValueElement	getValidValueByGUID(String userId, String validValueGUID)	Retrieve a specific valid value from the repository.
List<ValidValueElement>	getValidValueByName(String userId, String validValueName, int startFrom, int pageSize)	Retrieve a specific valid value from the repository.
List<ValidValueElement>	getValidValueSetMembers(String userId, String validValueSetGUID, int startFrom, int pageSize)	Page through the members of a valid value set.
void	updateValidValue(String userId, String validValueGUID, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, boolean isDeprecated, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Update the properties of the valid value.

Methods inherited from class org.odpi.openmetadata.accessservices.assetowner.client.AssetOwner

addAssetOrigin, addAssetToCatalog, addAssetToCatalog, addAssetToCatalogUsingTemplate, addCombinedSchemaToAsset, addConnectionToAsset, addSchemaAttribute, addSchemaAttributes, addSchemaTypeToAsset, addSecurityTags, addSemanticAssignment, addTemplateClassification, attachSchemaTypeToAsset, clearAssetConnection, clearConnectorType, clearEmbeddedConnection, clearEndpoint, createConnection, createConnectionFromTemplate, createEndpoint, createEndpointFromTemplate, deleteAsset, deleteAssetSchemaType, detachSchemaTypeFromAsset, findAssets, findConnections, findConnectorTypes, findEndpoints, getAssetProperties, getAssetsByName, getAssetSummary, getConnectionByGUID, getConnectionsByName, getConnectorToAsset, getConnectorTypeByGUID, getConnectorTypesByName, getDiscoveryAnalysisReports, getDiscoveryReportAnnotations, getEndpointByGUID, getEndpointsByName, getExtendedAnnotations, getTypesOfAnnotation, getTypesOfAnnotationWithDescriptions, getTypesOfAsset, getTypesOfAssetWithDescriptions, linkElementsAsDuplicates, publishAsset, removeAssetOrigin, removeConnection, removeEndpoint, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, scanConnections, setupAssetConnection, setupConnectorType, setupEmbeddedConnection, setupEndpoint, unlinkElementsAsDuplicates, updateAssetOwner, updateAssetOwner, updateAssetZones, updateConnection, updateEndpoint, withdrawAsset

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

getAssetForConnection, getAssetProperties, getAssetSummary, getConnectionByGUID, getConnectionByName, getConnectionForAsset, getConnectorForConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidValuesAssetOwner

public ValidValuesAssetOwner(String serverName,
                             String serverPlatformURLRoot,
                             AuditLog auditLog)
                      throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request and an audit log.

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.

ValidValuesAssetOwner

public ValidValuesAssetOwner(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 servers

Throws:

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

ValidValuesAssetOwner

public ValidValuesAssetOwner(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. There is also an audit log destination.

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.

ValidValuesAssetOwner

public ValidValuesAssetOwner(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 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.

ValidValuesAssetOwner

public ValidValuesAssetOwner(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 (view service or integration service typically).

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

createValidValueSet

public String createValidValueSet(String userId,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String usage,
                                  String scope,
                                  Map<String,String> additionalProperties,
                                  Map<String,Object> extendedProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a new valid value set. This just creates the Set itself. Members are added either as they are created, or they can be attached to a set after they are created.

Specified by:

createValidValueSet in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this set be used.

scope - what is the scope of this set's values.

additionalProperties - additional properties for this set.

extendedProperties - properties that need to be populated into a subtype.

Returns:

unique identifier for the new set

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

createValidValueDefinition

public String createValidValueDefinition(String userId,
                                         String setGUID,
                                         String qualifiedName,
                                         String displayName,
                                         String description,
                                         String usage,
                                         String scope,
                                         String preferredValue,
                                         Map<String,String> additionalProperties,
                                         Map<String,Object> extendedProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Create a new valid value definition.

Specified by:

createValidValueDefinition in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

setGUID - unique identifier of the set to attach this to.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this value be used.

preferredValue - the value that should be used in an implementation if possible.

additionalProperties - additional properties for this definition.

extendedProperties - properties that need to be populated into a subtype.

Returns:

unique identifier for the new definition

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

updateValidValue

public void updateValidValue(String userId,
                             String validValueGUID,
                             String qualifiedName,
                             String displayName,
                             String description,
                             String usage,
                             String scope,
                             String preferredValue,
                             boolean isDeprecated,
                             Map<String,String> additionalProperties,
                             Map<String,Object> extendedProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the properties of the valid value. All properties are updated. If only changing some if the properties, retrieve the current values from the repository and pass existing values back on this call if they are not to change.

Specified by:

updateValidValue in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

validValueGUID - unique identifier of the valid value.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this value be used.

scope - what is the scope of the values.

preferredValue - the value that should be used in an implementation if possible.

isDeprecated - is this value deprecated?

additionalProperties - additional properties for this valid value.

extendedProperties - properties that need to be populated into a subtype.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

deleteValidValue

public void deleteValidValue(String userId,
                             String validValueGUID,
                             String qualifiedName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the valid value form the repository. All links to it are deleted too.

Specified by:

deleteValidValue in interface AssetOnboardingValidValues

Parameters:

userId - calling user

validValueGUID - unique identifier of the value to delete

qualifiedName - unique name of the value to delete. This is used to verify that the correct valid value is being deleted.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

attachValidValueToSet

public void attachValidValueToSet(String userId,
                                  String setGUID,
                                  String validValueGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a link between a valid value set or definition and a set. This means the valid value is a member of the set.

Specified by:

attachValidValueToSet in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

setGUID - unique identifier of the set.

validValueGUID - unique identifier of the valid value to add to the set.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

detachValidValueFromSet

public void detachValidValueFromSet(String userId,
                                    String setGUID,
                                    String validValueGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove the link between a valid value and a set it is a member of.

Specified by:

detachValidValueFromSet in interface AssetOnboardingValidValues

Parameters:

userId - calling user

setGUID - owning set

validValueGUID - unique identifier of the member to be removed.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueByGUID

public ValidValueElement getValidValueByGUID(String userId,
                                             String validValueGUID)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Retrieve a specific valid value from the repository.

Specified by:

getValidValueByGUID in interface AssetOnboardingValidValues

Parameters:

userId - calling user

validValueGUID - unique identifier of the valid value.

Returns:

Valid value bean

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueByName

public List<ValidValueElement> getValidValueByName(String userId,
                                                   String validValueName,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve a specific valid value from the repository. Duplicates may be returned if multiple valid values have been assigned the same qualified name.

Specified by:

getValidValueByName in interface AssetOnboardingValidValues

Parameters:

userId - calling user

validValueName - qualified name of the valid value.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

Valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

findValidValues

public List<ValidValueElement> findValidValues(String userId,
                                               String searchString,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.

Specified by:

findValidValues in interface AssetOnboardingValidValues

Parameters:

userId - calling user

searchString - string value to look for - may contain RegEx characters.

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueSetMembers

public List<ValidValueElement> getValidValueSetMembers(String userId,
                                                       String validValueSetGUID,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Page through the members of a valid value set.

Specified by:

getValidValueSetMembers in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

validValueSetGUID - unique identifier of the valid value set.

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getSetsForValidValue

public List<ValidValueElement> getSetsForValidValue(String userId,
                                                    String validValueGUID,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Page through the list of valid value sets that a valid value definition/set belongs to.

Specified by:

getSetsForValidValue in interface AssetOnboardingValidValues

Parameters:

userId - calling user.

validValueGUID - unique identifier of valid value to query

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.