org.odpi.openmetadata.commonservices.generichandlers

Class SchemaTypeHandler<B>

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler<B>

org.odpi.openmetadata.commonservices.generichandlers.SchemaTypeHandler<B>

public class SchemaTypeHandler<B>
extends ReferenceableHandler<B>

SchemaTypeHandler manages SchemaType objects. It runs server-side in the OMAG Server Platform and retrieves SchemaElement entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors

Constructor and Description

SchemaTypeHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog) Construct the asset handler with information needed to work with B objects.

Method Summary

Modifier and Type	Method and Description
String	addSchemaType(String userId, String externalSourceGUID, String externalSourceName, SchemaTypeBuilder schemaTypeBuilder, String methodName) Store a new schema type (and optional attributes) in the repository and return its unique identifier (GUID).
String	createSchemaTypeFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String displayName, String description, String methodName) Create a new metadata element to represent a schema type using an existing metadata element as a template.
List<B>	findSchemaTypes(String userId, String searchString, int startFrom, int pageSize, String methodName) Retrieve the list of schema type metadata elements that contain the search string.
B	getSchemaType(String userId, String schemaTypeGUID, String guidParameterName, String methodName) Retrieve a specific schema type based on its unique identifier (GUID).
List<B>	getSchemaTypeByName(String userId, String name, int startFrom, int pageSize, String methodName) Retrieve the list of schema type metadata elements with a matching qualified or display name.
B	getSchemaTypeForAsset(String userId, String assetGUID, String assetGUIDParameterName, String methodName) Is there an attached schema for the Asset?
B	getSchemaTypeForParent(String userId, String parentGUID, String parentGUIDParameterName, String parentTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName) Is there an attached schema for the parent entity? This is either an asset or a port entity.
B	getSchemaTypeForPort(String userId, String portGUID, String portGUIDParameterName, String methodName) Is there an attached schema for the Port?
B	getSchemaTypeFromInstance(String userId, InstanceHeader schemaRootHeader, String schemaRootTypeName, InstanceProperties instanceProperties, List<Classification> entityClassifications, String methodName) Transform the schema type information stored either as a schema type entity or in the TypeClassifiedAttribute classification into a schema type bean.
void	removeSchemaType(String userId, String externalSourceGUID, String externalSourceName, String schemaTypeGUID) Remove the requested schemaType if it is no longer connected to any other entity.
void	updateSchemaType(String userId, String externalSourceGUID, String externalSourceName, String existingSchemaTypeGUID, String existingSchemaTypeGUIDParameterName, SchemaTypeBuilder builder) Update a stored schemaType.
void	updateSchemaType(String userId, String externalSourceGUID, String externalSourceName, String existingSchemaTypeGUID, String existingSchemaTypeGUIDParameterName, SchemaTypeBuilder builder, boolean isMergeUpdate, String methodName) Update a stored schemaType.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler

addSecurityTags, addTemplateClassification, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveSemanticAssignment, saveSemanticAssignment, unlinkElementsAsDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler

archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaTypeHandler

public SchemaTypeHandler(OpenMetadataAPIGenericConverter<B> converter,
                         Class<B> beanClass,
                         String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper,
                         String localServerUserId,
                         OpenMetadataServerSecurityVerifier securityVerifier,
                         List<String> supportedZones,
                         List<String> defaultZones,
                         List<String> publishZones,
                         AuditLog auditLog)

Construct the asset handler with information needed to work with B objects.

Parameters:

converter - specific converter for this bean class

beanClass - name of bean class that is represented by the generic class B

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

localServerUserId - userId for this server

securityVerifier - open metadata security services verifier

supportedZones - list of zones that the access service is allowed to serve B instances from.

defaultZones - list of zones that the access service should set in all new B instances.

publishZones - list of zones that the access service sets up in published B instances.

auditLog - destination for audit log events.

Method Detail

addSchemaType

public String addSchemaType(String userId,
                            String externalSourceGUID,
                            String externalSourceName,
                            SchemaTypeBuilder schemaTypeBuilder,
                            String methodName)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Store a new schema type (and optional attributes) in the repository and return its unique identifier (GUID).

Parameters:

userId - calling userId

externalSourceGUID - unique identifier of software server capability representing the caller - null for local cohort

externalSourceName - unique name of software server capability representing the caller

schemaTypeBuilder - properties for new schemaType

methodName - calling method

Returns:

unique identifier of the schemaType in the repository.

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createSchemaTypeFromTemplate

public String createSchemaTypeFromTemplate(String userId,
                                           String externalSourceGUID,
                                           String externalSourceName,
                                           String templateGUID,
                                           String qualifiedName,
                                           String displayName,
                                           String description,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a new metadata element to represent a schema type using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new schema type.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the schema type - used in other configuration

displayName - short display name for the schema type

description - description of the schema type

methodName - calling method

Returns:

unique identifier of the new metadata element

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)

updateSchemaType

public void updateSchemaType(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String existingSchemaTypeGUID,
                             String existingSchemaTypeGUIDParameterName,
                             SchemaTypeBuilder builder)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Update a stored schemaType.

Parameters:

userId - userId

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

existingSchemaTypeGUID - unique identifier of the existing schemaType entity

existingSchemaTypeGUIDParameterName - name of parameter for existingSchemaTypeGUID

builder - new schemaType values

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

updateSchemaType

public void updateSchemaType(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String existingSchemaTypeGUID,
                             String existingSchemaTypeGUIDParameterName,
                             SchemaTypeBuilder builder,
                             boolean isMergeUpdate,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Update a stored schemaType. Note - this only updates the main schema - it does not travel through the nested schemas.

Parameters:

userId - userId

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

existingSchemaTypeGUID - unique identifier of the existing schemaType entity

existingSchemaTypeGUIDParameterName - name of parameter for existingSchemaTypeGUID

builder - new schemaType values

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

removeSchemaType

public void removeSchemaType(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String schemaTypeGUID)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Remove the requested schemaType if it is no longer connected to any other entity.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software server capability representing the caller - null for local cohort

externalSourceName - unique name of software server capability representing the caller

schemaTypeGUID - object to delete

Throws:

InvalidParameterException - the entity guid is not known

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaTypeForAsset

public B getSchemaTypeForAsset(String userId,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Is there an attached schema for the Asset?

Parameters:

userId - calling user

assetGUID - identifier for the entity that the object is attached to

assetGUIDParameterName - name of parameter for assetGUID

methodName - calling method

Returns:

schemaType object or null

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaTypeForPort

public B getSchemaTypeForPort(String userId,
                              String portGUID,
                              String portGUIDParameterName,
                              String methodName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Is there an attached schema for the Port?

Parameters:

userId - calling user

portGUID - identifier for the entity that the object is attached to

portGUIDParameterName - name of parameter for portGUID

methodName - calling method

Returns:

schemaType object or null

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaTypeForParent

public B getSchemaTypeForParent(String userId,
                                String parentGUID,
                                String parentGUIDParameterName,
                                String parentTypeName,
                                String relationshipTypeGUID,
                                String relationshipTypeName,
                                String methodName)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Is there an attached schema for the parent entity? This is either an asset or a port entity. This method should not be used to get the schema type for a schema attribute.

Parameters:

userId - calling user

parentGUID - identifier for the entity that the object is attached to

parentGUIDParameterName - parameter supplying parentGUID

parentTypeName - type name of anchor

relationshipTypeGUID - unique identifier of the relationship type to search along

relationshipTypeName - unique name of the relationship type to search along

methodName - calling method

Returns:

schemaType object or null

Throws:

InvalidParameterException - the schemaType bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaType

public B getSchemaType(String userId,
                       String schemaTypeGUID,
                       String guidParameterName,
                       String methodName)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

Retrieve a specific schema type based on its unique identifier (GUID). This is use to do updates and to retrieve a linked schema.

Parameters:

userId - calling user

schemaTypeGUID - guid of schema type to retrieve.

guidParameterName - parameter describing where the guid came from

methodName - calling method

Returns:

schema type or null depending on whether the object is found

Throws:

InvalidParameterException - the guid is null

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

findSchemaTypes

public List<B> findSchemaTypes(String userId,
                               String searchString,
                               int startFrom,
                               int pageSize,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

methodName - calling method

Returns:

list of matching metadata 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)

getSchemaTypeByName

public List<B> getSchemaTypeByName(String userId,
                                   String name,
                                   int startFrom,
                                   int pageSize,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

methodName - calling method

Returns:

list of matching metadata 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)

getSchemaTypeFromInstance

public B getSchemaTypeFromInstance(String userId,
                                   InstanceHeader schemaRootHeader,
                                   String schemaRootTypeName,
                                   InstanceProperties instanceProperties,
                                   List<Classification> entityClassifications,
                                   String methodName)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   UserNotAuthorizedException

Transform the schema type information stored either as a schema type entity or in the TypeClassifiedAttribute classification into a schema type bean. To completely fill out the schema type it may be necessary to retrieve additional entities. For example, a map schema type includes links to the two types that are being mapped together.

Parameters:

userId - calling user

schemaRootHeader - header of the schema element that holds the root information

schemaRootTypeName - name of type of the schema element that holds the root information

instanceProperties - properties describing the schema type

entityClassifications - classifications from the root entity

methodName - calling method

Returns:

schema type bean

Throws:

InvalidParameterException - problem with the entity

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server