org.odpi.openmetadata.commonservices.generichandlers

Class SchemaAttributeHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE>

java.lang.Object

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

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

org.odpi.openmetadata.commonservices.generichandlers.SchemaAttributeHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE>

public class SchemaAttributeHandler<SCHEMA_ATTRIBUTE,SCHEMA_TYPE>
extends ReferenceableHandler<B>

SchemaAttributeHandler manages Schema Attribute 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

SchemaAttributeHandler(OpenMetadataAPIGenericConverter<SCHEMA_ATTRIBUTE> schemaAttributeConverter, Class<SCHEMA_ATTRIBUTE> schemaAttributeBeanClass, OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter, Class<SCHEMA_TYPE> schemaTypeBeanClass, 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	createNestedSchemaAttribute(String userId, String externalSourceGUID, String externalSourceName, String parentAttributeGUID, String parentAttributeGUIDParameterName, String parentAttributeTypeName, String parentAttributeRelationshipTypeGUID, String parentAttributeRelationshipTypeName, String qualifiedName, String qualifiedNameParameterName, SchemaAttributeBuilder schemaAttributeBuilder, String methodName) Create a new schema attribute with its type attached.
List<SCHEMA_ATTRIBUTE>	findSchemaAttributes(String userId, String searchString, String searchStringParameterName, String resultTypeGUID, String resultTypeName, String requiredClassificationName, String omittedClassificationName, int startFrom, int pageSize, String methodName) Retrieve the list of database table metadata elements that contain the search string.
SCHEMA_ATTRIBUTE	getSchemaAttribute(String userId, String schemaAttributeGUID, String schemaAttributeGUIDParameterName, String expectedTypeName, String requiredClassificationName, String omittedClassificationName, String methodName) Retrieve a specific schema attribute by GUID.
List<SCHEMA_ATTRIBUTE>	getSchemaAttributesByName(String userId, String typeGUID, String typeName, String name, String requiredClassificationName, String omittedClassificationName, int elementStart, int maxElements, String methodName) Returns a list of specifically typed schema attributes with matching names - either display names or qualified names
List<SCHEMA_ATTRIBUTE>	getSchemaAttributesByName(String userId, String typeGUID, String typeName, String name, String requiredClassificationName, String omittedClassificationName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Returns a list of specifically typed schema attributes with matching names - either display names or qualified names
List<SCHEMA_ATTRIBUTE>	getSchemaAttributesForComplexSchemaType(String userId, String schemaTypeGUID, String guidParameterName, String requiredClassificationName, String omittedClassificationName, int startFrom, int pageSize, String methodName) Returns a list of schema attributes that are linked to a ComplexSchemaType via the AttributeForSchema relationship.
List<SCHEMA_ATTRIBUTE>	getSchemaAttributesForComplexSchemaType(String userId, String schemaTypeGUID, String schemaTypeGUIDParameterName, String requiredClassificationName, String omittedClassificationName, List<String> serviceSupportedZones, int startFrom, int pageSize, String methodName) Returns a list of schema attributes that are linked to a ComplexSchemaType via the AttributeForSchema relationship.

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

addSecurityTags, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, removeSecurityTags, removeSemanticAssignment, saveSemanticAssignment, saveSemanticAssignment

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

countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findBeanGUIDs, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, relinkElementToNewElement, relinkElementToNewElement, setSecurityVerifier, unlinkAllElements, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaAttributeHandler

public SchemaAttributeHandler(OpenMetadataAPIGenericConverter<SCHEMA_ATTRIBUTE> schemaAttributeConverter,
                              Class<SCHEMA_ATTRIBUTE> schemaAttributeBeanClass,
                              OpenMetadataAPIGenericConverter<SCHEMA_TYPE> schemaTypeConverter,
                              Class<SCHEMA_TYPE> schemaTypeBeanClass,
                              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:

schemaAttributeConverter - specific converter for the SCHEMA_ATTRIBUTE bean class

schemaAttributeBeanClass - name of bean class that is represented by the generic class SCHEMA_ATTRIBUTE

schemaTypeConverter - specific converter for the SCHEMA_TYPE bean class

schemaTypeBeanClass - name of bean class that is represented by the generic class SCHEMA_TYPE

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

createNestedSchemaAttribute

public String createNestedSchemaAttribute(String userId,
                                          String externalSourceGUID,
                                          String externalSourceName,
                                          String parentAttributeGUID,
                                          String parentAttributeGUIDParameterName,
                                          String parentAttributeTypeName,
                                          String parentAttributeRelationshipTypeGUID,
                                          String parentAttributeRelationshipTypeName,
                                          String qualifiedName,
                                          String qualifiedNameParameterName,
                                          SchemaAttributeBuilder schemaAttributeBuilder,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create a new schema attribute with its type attached.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software server capability representing the caller

externalSourceName - unique name of software server capability representing the caller

parentAttributeGUID - unique identifier of the metadata element to connect the new schema attribute to

parentAttributeGUIDParameterName - parameter name supplying parentAttributeGUID

parentAttributeTypeName - type of the parent element - may be a schema attribute or a schema type

parentAttributeRelationshipTypeGUID - unique identifier of the relationship from the new schema type to the parent

parentAttributeRelationshipTypeName - unique name of the relationship from the new schema type to the parent

qualifiedName - unique identifier for this schema type

qualifiedNameParameterName - name of parameter supplying the qualified name

schemaAttributeBuilder - builder containing the properties of the schema type

methodName - calling method

Returns:

unique identifier of the new schema attribute already linked to its parent

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)

getSchemaAttributesForComplexSchemaType

public List<SCHEMA_ATTRIBUTE> getSchemaAttributesForComplexSchemaType(String userId,
                                                                      String schemaTypeGUID,
                                                                      String guidParameterName,
                                                                      String requiredClassificationName,
                                                                      String omittedClassificationName,
                                                                      int startFrom,
                                                                      int pageSize,
                                                                      String methodName)
                                                               throws InvalidParameterException,
                                                                      PropertyServerException,
                                                                      UserNotAuthorizedException

Returns a list of schema attributes that are linked to a ComplexSchemaType via the AttributeForSchema relationship. It validates the unique identifier of the complex schema type, and the visibility/security of any attached asset using the supported zones for this component. Then begins to extract the schema attributes. Exceptions occur if a schema attribute does not have a type.

Parameters:

userId - String userId of user making request.

schemaTypeGUID - String unique id for containing schema type.

guidParameterName - String name of the parameter supplying the guid.

requiredClassificationName - String the name of the classification that must be on the schema attribute or linked schema type entity.

omittedClassificationName - String the name of a classification that must not be on the schema attribute or linked schema type entity.

startFrom - int starting position for first returned element.

pageSize - int maximum number of elements to return on the call.

methodName - calling method

Returns:

a schema attributes response

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

getSchemaAttributesForComplexSchemaType

public List<SCHEMA_ATTRIBUTE> getSchemaAttributesForComplexSchemaType(String userId,
                                                                      String schemaTypeGUID,
                                                                      String schemaTypeGUIDParameterName,
                                                                      String requiredClassificationName,
                                                                      String omittedClassificationName,
                                                                      List<String> serviceSupportedZones,
                                                                      int startFrom,
                                                                      int pageSize,
                                                                      String methodName)
                                                               throws InvalidParameterException,
                                                                      PropertyServerException,
                                                                      UserNotAuthorizedException

Returns a list of schema attributes that are linked to a ComplexSchemaType via the AttributeForSchema relationship. It validates the unique identifier of the complex schema type, and the visibility/security of any attached asset using the supplied supported zones (needed for the calls from the OCF Metadata REST Services). Then it begins to extract the schema attributes. Exceptions occur if a schema attribute does not have a type.

Parameters:

userId - String userId of user making request.

schemaTypeGUID - String unique id for containing schema type.

schemaTypeGUIDParameterName - String name of the parameter supplying the guid.

requiredClassificationName - String the name of the classification that must be on the schema attribute or linked schema type entity.

omittedClassificationName - String the name of a classification that must not be on the schema attribute or linked schema type entity.

serviceSupportedZones - list of zone names for calling service

startFrom - int starting position for first returned element.

pageSize - int maximum number of elements to return on the call.

methodName - calling method

Returns:

a schema attributes response

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

getSchemaAttribute

public SCHEMA_ATTRIBUTE getSchemaAttribute(String userId,
                                           String schemaAttributeGUID,
                                           String schemaAttributeGUIDParameterName,
                                           String expectedTypeName,
                                           String requiredClassificationName,
                                           String omittedClassificationName,
                                           String methodName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Retrieve a specific schema attribute by GUID. It is only returned if the guid is known, the entity is of the correct type, the classifications are as expected and any asset it is connected to is both visible via the zones setting and the security verifier allows the update.

Parameters:

userId - calling userId

schemaAttributeGUID - unique identifier of schema attribute

schemaAttributeGUIDParameterName - parameter passing the schemaAttributeGUID

expectedTypeName - type or subtype of schema attribute

requiredClassificationName - a classification that must be either on the schema attribute or its type.

omittedClassificationName - a classification that must NOT be on either the schema attribute or its type.

methodName - calling method

Returns:

guid of new schema

Throws:

InvalidParameterException - the guid or bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getSchemaAttributesByName

public List<SCHEMA_ATTRIBUTE> getSchemaAttributesByName(String userId,
                                                        String typeGUID,
                                                        String typeName,
                                                        String name,
                                                        String requiredClassificationName,
                                                        String omittedClassificationName,
                                                        int elementStart,
                                                        int maxElements,
                                                        String methodName)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException

Returns a list of specifically typed schema attributes with matching names - either display names or qualified names

Parameters:

userId - String userId of user making request.

typeGUID - String unique identifier of type of schema attribute required.

typeName - String unique name of type of schema attribute required.

name - String name (qualified or display name) of schema attribute.

requiredClassificationName - String name of classification that must be present

omittedClassificationName - String name of classification that must not be present

elementStart - int starting position for first returned element.

maxElements - int maximum number of elements to return on the call.

methodName - calling method

Returns:

a schema attributes response

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

getSchemaAttributesByName

public List<SCHEMA_ATTRIBUTE> getSchemaAttributesByName(String userId,
                                                        String typeGUID,
                                                        String typeName,
                                                        String name,
                                                        String requiredClassificationName,
                                                        String omittedClassificationName,
                                                        List<String> serviceSupportedZones,
                                                        int startFrom,
                                                        int pageSize,
                                                        String methodName)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException

Returns a list of specifically typed schema attributes with matching names - either display names or qualified names

Parameters:

userId - String userId of user making request

typeGUID - String unique identifier of type of schema attribute required

typeName - String unique name of type of schema attribute required

name - String name (qualified or display name) of schema attribute

requiredClassificationName - String name of classification that must be present

omittedClassificationName - String name of classification that must not be present

serviceSupportedZones - zones that assets must be;ong in to be visible

startFrom - int starting position for first returned element

pageSize - int maximum number of elements to return on the call

methodName - calling method

Returns:

a schema attributes response

Throws:

InvalidParameterException - - the GUID is not recognized or the paging values are invalid or

PropertyServerException - - there is a problem retrieving the asset properties from the property server or

UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

findSchemaAttributes

public List<SCHEMA_ATTRIBUTE> findSchemaAttributes(String userId,
                                                   String searchString,
                                                   String searchStringParameterName,
                                                   String resultTypeGUID,
                                                   String resultTypeName,
                                                   String requiredClassificationName,
                                                   String omittedClassificationName,
                                                   int startFrom,
                                                   int pageSize,
                                                   String methodName)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

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

Parameters:

userId - the searchString of the calling user.

searchString - searchString of endpoint. This may include wild card characters.

searchStringParameterName - name of parameter providing search string

resultTypeGUID - unique identifier of the type that the results should match with

resultTypeName - unique value of the type that the results should match with

requiredClassificationName - String the name of the classification that must be on the entity.

omittedClassificationName - String the name of a classification that must not be on the entity.

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

pageSize - maximum number of elements to return.

methodName - calling method

Returns:

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