Package org.odpi.openmetadata.accessservices.assetmanager.handlers

Class SchemaExchangeHandler

  • public class SchemaExchangeHandler
extends ExchangeHandlerBase
    SchemaExchangeHandler is the server side handler for managing schema types and attributes.

    • Constructor Detail

      • SchemaExchangeHandler

        public SchemaExchangeHandler​(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 schema exchange handler with information needed to work with schema related objects for Asset Manager OMAS.
        Parameters:
        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 instances from.
        defaultZones - list of zones that the access service should set in all new instances.
        publishZones - list of zones that the access service sets up in published instances.
        auditLog - destination for audit log events.

    • Method Detail

      • createSchemaTypeFromTemplate

        public String createSchemaTypeFromTemplate​(String userId,
                                           MetadataCorrelationProperties correlationProperties,
                                           boolean assetManagerIsHome,
                                           String templateGUID,
                                           TemplateProperties templateProperties,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a new metadata element to represent a schema type using an existing metadata element as a template.
        Parameters:
        userId - calling user
        correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata
        assetManagerIsHome - ensure that only the asset manager can update this schema element
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        methodName - calling method
        Returns:
        unique identifier of the new schema type
        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)

      • setupSchemaTypeParent

        public void setupSchemaTypeParent​(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  boolean assetManagerIsHome,
                                  String schemaTypeGUID,
                                  String parentElementGUID,
                                  String parentElementTypeName,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Connect a schema type to a data asset, process or port.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        schemaTypeGUID - unique identifier of the schema type to connect
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        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)

      • clearSchemaTypeParent

        public void clearSchemaTypeParent​(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String schemaTypeGUID,
                                  String parentElementGUID,
                                  String parentElementTypeName,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove the relationship between a schema type and its parent data asset, process or port.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        schemaTypeGUID - unique identifier of the schema type to connect
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        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)

      • findSchemaType

        public List<SchemaTypeElement> findSchemaType​(String userId,
                                              String assetManagerGUID,
                                              String assetManagerName,
                                              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
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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)

      • getSchemaTypeForElement

        public SchemaTypeElement getSchemaTypeForElement​(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String parentElementGUID,
                                                 String parentElementTypeName,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Return the schema type associated with a specific open metadata element (data asset, process or port).
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
        parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
        methodName - calling method
        Returns:
        metadata element describing the schema type associated with the requested parent 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)

      • getSchemaTypeByName

        public List<SchemaTypeElement> getSchemaTypeByName​(String userId,
                                                   String assetManagerGUID,
                                                   String assetManagerName,
                                                   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
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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)

      • createSchemaAttribute

        public String createSchemaAttribute​(String userId,
                                    MetadataCorrelationProperties correlationProperties,
                                    boolean assetManagerIsHome,
                                    String schemaElementGUID,
                                    SchemaAttributeProperties schemaAttributeProperties,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Create a new metadata element to represent a schema attribute.
        Parameters:
        userId - calling user
        correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata
        assetManagerIsHome - ensure that only the asset manager can update this schema attribute
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
        schemaAttributeProperties - properties for the schema attribute
        methodName - calling method
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)

      • createSchemaAttributeFromTemplate

        public String createSchemaAttributeFromTemplate​(String userId,
                                                MetadataCorrelationProperties correlationProperties,
                                                boolean assetManagerIsHome,
                                                String schemaElementGUID,
                                                String templateGUID,
                                                TemplateProperties templateProperties,
                                                String methodName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
        Parameters:
        userId - calling user
        correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata
        assetManagerIsHome - ensure that only the asset manager can update this schema attribute
        schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        methodName - calling method
        Returns:
        unique identifier of the new metadata element for the schema attribute
        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)

      • updateSchemaAttribute

        public void updateSchemaAttribute​(String userId,
                                  MetadataCorrelationProperties correlationProperties,
                                  String schemaAttributeGUID,
                                  boolean isMergeUpdate,
                                  SchemaAttributeProperties schemaAttributeProperties,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Update the properties of the metadata element representing a schema attribute.
        Parameters:
        userId - calling user
        correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata
        schemaAttributeGUID - unique identifier of the schema attribute to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        schemaAttributeProperties - new properties for the schema attribute
        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)

      • setSchemaElementAsCalculatedValue

        public void setSchemaElementAsCalculatedValue​(String userId,
                                              String assetManagerGUID,
                                              String assetManagerName,
                                              boolean assetManagerIsHome,
                                              String schemaElementGUID,
                                              String formula,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the metadata element to update
        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)

      • clearSchemaElementAsCalculatedValue

        public void clearSchemaElementAsCalculatedValue​(String userId,
                                                String assetManagerGUID,
                                                String assetManagerName,
                                                String schemaElementGUID,
                                                String methodName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Remove the calculated value designation from the schema element.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        schemaElementGUID - unique identifier of the metadata element to update
        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)

      • setupColumnAsPrimaryKey

        public void setupColumnAsPrimaryKey​(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    boolean assetManagerIsHome,
                                    String schemaAttributeGUID,
                                    String primaryKeyName,
                                    KeyPattern primaryKeyPattern,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Classify the column schema attribute to indicate that it describes a primary key.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this classification
        schemaAttributeGUID - unique identifier of the metadata element to update
        primaryKeyName - name of the primary key (if different from the column name)
        primaryKeyPattern - key pattern used to maintain the primary key
        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)

      • setupForeignKeyRelationship

        public void setupForeignKeyRelationship​(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        boolean assetManagerIsHome,
                                        String primaryKeyGUID,
                                        String foreignKeyGUID,
                                        ForeignKeyProperties foreignKeyProperties,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Link two schema attributes together to show a foreign key relationship.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        assetManagerIsHome - ensure that only the asset manager can update this relationship
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        foreignKeyProperties - properties for the foreign key relationship
        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)

      • updateForeignKeyRelationship

        public void updateForeignKeyRelationship​(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String primaryKeyGUID,
                                         String foreignKeyGUID,
                                         ForeignKeyProperties foreignKeyProperties,
                                         String methodName)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Update the relationship properties for the query target.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        foreignKeyProperties - properties for the foreign key relationship
        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)

      • clearForeignKeyRelationship

        public void clearForeignKeyRelationship​(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String primaryKeyGUID,
                                        String foreignKeyGUID,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Remove the foreign key relationship between two schema elements.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        primaryKeyGUID - unique identifier of the derived schema element
        foreignKeyGUID - unique identifier of the query target schema element
        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)

      • findSchemaAttributes

        public List<SchemaAttributeElement> findSchemaAttributes​(String userId,
                                                         String assetManagerGUID,
                                                         String assetManagerName,
                                                         String searchString,
                                                         int startFrom,
                                                         int pageSize,
                                                         String methodName)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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)

      • getAttributesForSchemaType

        public List<SchemaAttributeElement> getAttributesForSchemaType​(String userId,
                                                               String assetManagerGUID,
                                                               String assetManagerName,
                                                               String schemaTypeGUID,
                                                               int startFrom,
                                                               int pageSize,
                                                               String methodName)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException
        Retrieve the list of schema attributes associated with a schemaType.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        schemaTypeGUID - unique identifier of the schemaType of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        methodName - calling method
        Returns:
        list of associated 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)

      • getSchemaAttributesByName

        public List<SchemaAttributeElement> getSchemaAttributesByName​(String userId,
                                                              String assetManagerGUID,
                                                              String assetManagerName,
                                                              String name,
                                                              int startFrom,
                                                              int pageSize,
                                                              String methodName)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        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)