Package org.odpi.openmetadata.commonservices.generichandlers

Class ConnectionHandler<B>

  • public class ConnectionHandler<B>
extends ReferenceableHandler<B>
    ConnectionHandler manages Connection objects. These describe the network addresses where services are running. They are used by connection objects to describe the service that the connector should call. They are linked to servers to show their network address where the services that they are hosting are running. Most OMASs that work with Connection objects use the Open Connector Framework (OCF) Bean since this can be passed to the OCF Connector Broker to create an instance of a connector to the attached asset. Therefore this handler has a default bean and converter which is the one that works with the OCF bean. The call can either use these values or override with their own bean/converter implementations. ConnectionHandler runs server-side in the OMAG Server Platform and retrieves Connection entities through the OMRSRepositoryConnector via the generic handler and repository handler.

    • Constructor Detail

      • ConnectionHandler

        public ConnectionHandler​(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 handler information needed to interact with the repository services
        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 Asset instances from.
        defaultZones - list of zones that the access service should set in all new Asset instances.
        publishZones - list of zones that the access service sets up in published Asset instances.
        auditLog - destination for audit log events.

    • Method Detail

      • saveConnection

        public String saveConnection​(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String anchorGUID,
                             String assetGUID,
                             String assetGUIDParameterName,
                             String assetTypeName,
                             Connection connection,
                             String assetSummary,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
        Determine if the Connection object is stored in the repository and create it if it is not. If the connection is located, there is no check that the connection values are equal to those in the supplied object.
        Parameters:
        userId - calling userId
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        anchorGUID - unique identifier of the anchor to add to the connection
        assetGUID - unique identifier of linked asset (or null)
        assetGUIDParameterName - parameter name supplying assetGUID
        assetTypeName - type of asset
        connection - object to add
        assetSummary - description of the asset for the connection
        methodName - calling method
        Returns:
        unique identifier of the connection in the repository.
        Throws:
        InvalidParameterException - the bean properties are invalid
        UserNotAuthorizedException - user not authorized to issue this request
        PropertyServerException - problem accessing the property server

      • addAssetConnection

        public void addAssetConnection​(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String assetTypeName,
                               String assetQualifiedName,
                               boolean anchorEndpointToAsset,
                               Map<String,​Object> configurationProperties,
                               String connectorProviderClassName,
                               String networkAddress,
                               String protocol,
                               String encryptionMethod,
                               Date effectiveFrom,
                               Date effectiveTo,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        If possible, create a connection for the supplied asset. The new connection is linked to the asset.
        Parameters:
        userId - userId of user making request
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        assetGUID - unique identifier of the asset
        assetGUIDParameterName - parameter name supplying the asset guid
        assetTypeName - type of asset being created
        assetQualifiedName - fully qualified path name of the asset
        anchorEndpointToAsset - set to true if the network address is unique for the asset and should not be reused. False if this is an endpoint that is relevant for multiple assets.
        configurationProperties - configuration properties for the connection
        connectorProviderClassName - Java class name for the connector provider
        networkAddress - the network address (typically the URL but this depends on the protocol)
        protocol - the name of the protocol to use to connect to the endpoint
        encryptionMethod - encryption method to use when passing data to this endpoint
        effectiveFrom - starting time for this relationship (null for all time)
        effectiveTo - ending time for this relationship (null for all time)
        methodName - calling method
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connectorType properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • createConnection

        public String createConnection​(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String assetSummary,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Map<String,​String> additionalProperties,
                               Map<String,​String> securedProperties,
                               Map<String,​Object> configurationProperties,
                               String connectorUserId,
                               String clearPassword,
                               String encryptedPassword,
                               String connectorTypeGUID,
                               String connectorTypeGUIDParameterName,
                               String endpointGUID,
                               String endpointGUIDParameterName,
                               Date effectiveFrom,
                               Date effectiveTo,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Creates a new connection, connects it to the asset and returns the unique identifier for it.
        Parameters:
        userId - userId of user making request
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        assetGUID - the unique identifier for the asset entity (null for stand alone connections)
        assetGUIDParameterName - the parameter supplying assetGUID
        assetSummary - brief description of the asset for the relationship between the asset and the connection
        qualifiedName - unique name
        displayName - new value for the display name.
        description - new description for the connection.
        additionalProperties - additional properties
        securedProperties - protected properties
        configurationProperties - properties passed to configure underlying technologies
        connectorUserId - user identity that the connector should use
        clearPassword - password for the userId in clear text
        encryptedPassword - encrypted password that the connector needs to decrypt before use
        connectorTypeGUID - unique identifier of the connector type to used for this connection
        connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID
        endpointGUID - unique identifier of the endpoint to used for this connection
        endpointGUIDParameterName - the parameter supplying endpointGUID
        effectiveFrom - starting time for this relationship (null for all time)
        effectiveTo - ending time for this relationship (null for all time)
        methodName - calling method
        Returns:
        GUID for new connection
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connection properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • createVirtualConnection

        public String createVirtualConnection​(String userId,
                                      String externalSourceGUID,
                                      String externalSourceName,
                                      String assetGUID,
                                      String assetGUIDParameterName,
                                      String assetSummary,
                                      String qualifiedName,
                                      String displayName,
                                      String description,
                                      Map<String,​String> additionalProperties,
                                      Map<String,​String> securedProperties,
                                      Map<String,​Object> configurationProperties,
                                      String connectorUserId,
                                      String clearPassword,
                                      String encryptedPassword,
                                      String connectorTypeGUID,
                                      String connectorTypeGUIDParameterName,
                                      Date effectiveFrom,
                                      Date effectiveTo,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Creates a new virtual connection and returns the unique identifier for it.
        Parameters:
        userId - userId of user making request
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        assetGUID - the unique identifier for the asset entity (null for stand alone connections)
        assetGUIDParameterName - the parameter supplying assetGUID
        assetSummary - brief description of the asset for the relationship between the asset and the connection
        qualifiedName - unique name
        displayName - new value for the display name.
        description - new description for the connection.
        additionalProperties - additional properties
        securedProperties - protected properties
        configurationProperties - properties passed to configure underlying technologies
        connectorUserId - user identity that the connector should use
        clearPassword - password for the userId in clear text
        encryptedPassword - encrypted password that the connector needs to decrypt before use
        connectorTypeGUID - unique identifier of the connector type to used for this connection
        connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID
        effectiveFrom - starting time for this relationship (null for all time)
        effectiveTo - ending time for this relationship (null for all time)
        methodName - calling method
        Returns:
        GUID for new connection
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connection properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • createConnection

        public String createConnection​(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String assetGUID,
                               String assetGUIDParameterName,
                               String assetSummary,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Map<String,​String> additionalProperties,
                               Map<String,​String> securedProperties,
                               Map<String,​Object> configurationProperties,
                               String connectorUserId,
                               String clearPassword,
                               String encryptedPassword,
                               String connectionTypeName,
                               Map<String,​Object> extendedProperties,
                               String connectorTypeGUID,
                               String connectorTypeGUIDParameterName,
                               String endpointGUID,
                               String endpointGUIDParameterName,
                               Date effectiveFrom,
                               Date effectiveTo,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Creates a new connection and returns the unique identifier for it.
        Parameters:
        userId - userId of user making request
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        assetGUID - the unique identifier for the asset entity (null for stand alone connections)
        assetGUIDParameterName - the parameter supplying assetGUID
        assetSummary - brief description of the asset for the relationship between the asset and the connection
        qualifiedName - unique name
        displayName - new value for the display name.
        description - new description for the connection.
        additionalProperties - additional properties
        securedProperties - protected properties
        configurationProperties - properties passed to configure underlying technologies
        connectorUserId - user identity that the connector should use
        clearPassword - password for the userId in clear text
        encryptedPassword - encrypted password that the connector needs to decrypt before use
        connectionTypeName - type name for the connection
        extendedProperties - parameters from a subtype
        connectorTypeGUID - unique identifier of the connector type to used for this connection
        connectorTypeGUIDParameterName - the parameter supplying connectorTypeGUID
        endpointGUID - unique identifier of the endpoint to used for this connection
        endpointGUIDParameterName - the parameter supplying endpointGUID
        effectiveFrom - starting time for this relationship (null for all time)
        effectiveTo - ending time for this relationship (null for all time)
        methodName - calling method
        Returns:
        GUID for new connection
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connection properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • addEmbeddedConnection

        public void addEmbeddedConnection​(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String virtualConnectionGUID,
                                  String virtualConnectionGUIDParameterName,
                                  int position,
                                  String displayName,
                                  Map<String,​Object> arguments,
                                  String embeddedConnectionGUID,
                                  String embeddedConnectionGUIDParameterName,
                                  String methodName)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
        Link a connection into a virtual connection using the EmbeddedConnection relationship. The properties associated with the EmbeddedConnection relationship are typically used where the connection represents connectors that are part of a dynamic process (such as in an open discovery pipeline).
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        virtualConnectionGUID - unique identifier for the virtual connection
        virtualConnectionGUIDParameterName - parameter supplying virtualConnectionGUID
        position - position in the virtual connection
        displayName - name of the embedded connection
        arguments - arguments to use with the embedded connector when created as part of the virtual connector
        embeddedConnectionGUID - unique identifier for the embedded connection
        embeddedConnectionGUIDParameterName - parameter supplying embeddedConnectionGUID
        methodName - calling method
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connection properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • removeEmbeddedConnection

        public void removeEmbeddedConnection​(String userId,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String connectionGUID,
                                     String connectionGUIDParameterName,
                                     String embeddedConnectionGUID,
                                     String embeddedConnectionGUIDParameterName,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Remove a relationship between a virtual connection and an embedded connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        connectionGUID - unique identifier of the virtual connection in the external data manager
        connectionGUIDParameterName - parameter for connectionGUID
        embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
        embeddedConnectionGUIDParameterName - parameter for embeddedConnectionGUID
        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)

      • createConnectionFromTemplate

        public String createConnectionFromTemplate​(String userId,
                                           String externalSourceGUID,
                                           String externalSourceName,
                                           String templateGUID,
                                           String templateGUIDParameterName,
                                           String qualifiedName,
                                           String qualifiedNameParameterName,
                                           String displayName,
                                           String description,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        templateGUID - unique identifier of the metadata element to copy
        templateGUIDParameterName - parameter name for templateGUID
        qualifiedName - unique name for the element - used in other configuration
        qualifiedNameParameterName - parameter name for qualifiedName
        displayName - short display name for the new element
        description - description of the new element
        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)

      • updateConnection

        public void updateConnection​(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String connectionGUID,
                             String connectionGUIDParameterName,
                             String qualifiedName,
                             String displayName,
                             String description,
                             Map<String,​String> additionalProperties,
                             Map<String,​String> securedProperties,
                             Map<String,​Object> configurationProperties,
                             String connectorUserId,
                             String clearPassword,
                             String encryptedPassword,
                             String typeName,
                             Map<String,​Object> extendedProperties,
                             boolean isMergeUpdate,
                             Date effectiveFrom,
                             Date effectiveTo,
                             String methodName)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
        Updates the properties of an existing connection.
        Parameters:
        userId - userId of user making request.
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        connectionGUID - unique identifier for the connection
        connectionGUIDParameterName - parameter providing connectionGUID
        qualifiedName - unique name
        displayName - new value for the display name.
        description - new description for the connection.
        additionalProperties - additional properties
        securedProperties - protected properties
        configurationProperties - properties passed to configure underlying technologies
        connectorUserId - user identity that the connector should use
        clearPassword - password for the userId in clear text
        encryptedPassword - encrypted password that the connector needs to decrypt before use
        typeName - name of the type that is a subtype of connection - or null to create standard type
        extendedProperties - additional properties for the subtype
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        effectiveFrom - starting time for this relationship (null for all time)
        effectiveTo - ending time for this relationship (null for all time)
        methodName - calling method
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the connection properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.

      • addConnectionConnectorType

        public void addConnectionConnectorType​(String userId,
                                       String externalSourceGUID,
                                       String externalSourceName,
                                       String connectionGUID,
                                       String connectionGUIDParameterName,
                                       String connectorTypeGUID,
                                       String connectorTypeGUIDParameterName,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Create a relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        connectionGUID - unique identifier of the connection
        connectionGUIDParameterName - parameter for connectionGUID
        connectorTypeGUID - unique identifier of the connector type
        connectorTypeGUIDParameterName - parameter for connectorTypeGUID
        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)

      • removeConnectionConnectorType

        public void removeConnectionConnectorType​(String userId,
                                          String externalSourceGUID,
                                          String externalSourceName,
                                          String connectionGUID,
                                          String connectionGUIDParameterName,
                                          String connectorTypeGUID,
                                          String connectorTypeGUIDParameterName,
                                          String methodName)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the relationship between a connection and a connector type.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        connectionGUID - unique identifier of the connection
        connectionGUIDParameterName - parameter for connectionGUID
        connectorTypeGUID - unique identifier of the connector type
        connectorTypeGUIDParameterName - parameter for connectorTypeGUID
        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)

      • addConnectionEndpoint

        public void addConnectionEndpoint​(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String connectionGUID,
                                  String connectionGUIDParameterName,
                                  String endpointGUID,
                                  String endpointGUIDParameterName,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        connectionGUID - unique identifier of the connection
        connectionGUIDParameterName - parameter for connectionGUID
        endpointGUID - unique identifier of the endpoint
        endpointGUIDParameterName - parameter for endpointGUID
        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)

      • removeConnectionEndpoint

        public void removeConnectionEndpoint​(String userId,
                                     String externalSourceGUID,
                                     String externalSourceName,
                                     String connectionGUID,
                                     String connectionGUIDParameterName,
                                     String endpointGUID,
                                     String endpointGUIDParameterName,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Remove the relationship between a connection and an endpoint.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        connectionGUID - unique identifier of the connection in the external data manager
        connectionGUIDParameterName - parameter for connectionGUID
        endpointGUID - unique identifier of the connector type in the external data manager
        endpointGUIDParameterName - parameter for endpointGUID
        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)

      • addConnectionToAsset

        public void addConnectionToAsset​(String userId,
                                 String externalSourceGUID,
                                 String externalSourceName,
                                 String connectionGUID,
                                 String connectionGUIDParameterName,
                                 String assetGUID,
                                 String assetGUIDParameterName,
                                 String assetSummary,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Create a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the asset
        assetGUIDParameterName - parameter for assetGUID
        assetSummary - summary of the asset that is stored in the relationship between the asset and the connection.
        connectionGUID - unique identifier of the connection
        connectionGUIDParameterName - parameter for connectionGUID
        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)

      • removeConnectionToAsset

        public void removeConnectionToAsset​(String userId,
                                    String externalSourceGUID,
                                    String externalSourceName,
                                    String connectionGUID,
                                    String connectionGUIDParameterName,
                                    String assetGUID,
                                    String assetGUIDParameterName,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Remove a relationship between an asset and its connection.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software server capability representing the caller
        externalSourceName - unique name of software server capability representing the caller
        assetGUID - unique identifier of the asset
        assetGUIDParameterName - parameter for assetGUID
        connectionGUID - unique identifier of the connection
        connectionGUIDParameterName - parameter for connectionGUID
        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)

      • removeConnection

        public void removeConnection​(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String guid,
                             String guidParameterName,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
        Remove the metadata element. This will delete all elements anchored to it.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        guid - unique identifier of the metadata element to remove
        guidParameterName - parameter supplying the guid
        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)

      • getConnectionForAsset

        public B getConnectionForAsset​(String userId,
                               String assetGUID,
                               String assetGUIDParameterName,
                               List<String> serviceSupportedZones,
                               Date effectiveTime,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException
        Retrieve the list of connection objects attached to the requested asset object. This includes the endpoint and connector type.
        Parameters:
        userId - calling user
        assetGUID - unique identifier of the asset object
        assetGUIDParameterName - parameter name supplying assetGUID
        serviceSupportedZones - list of supported zones for the calling service
        effectiveTime - the time that the retrieved elements must be effective for
        methodName - calling method
        Returns:
        Connection bean
        Throws:
        InvalidParameterException - the parameters are invalid
        UserNotAuthorizedException - user not authorized to issue this request
        PropertyServerException - problem accessing the property server

      • getConnectionsForAsset

        public List<B> getConnectionsForAsset​(String userId,
                                      String assetGUID,
                                      String assetGUIDParameterName,
                                      List<String> serviceSupportedZones,
                                      int startingFrom,
                                      int pageSize,
                                      Date effectiveTime,
                                      String methodName)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      UserNotAuthorizedException
        Retrieve the list of connection objects attached to the requested asset object.
        Parameters:
        userId - calling user
        assetGUID - unique identifier of the asset object
        assetGUIDParameterName - parameter name supplying assetGUID
        serviceSupportedZones - list of supported zones for the calling service
        startingFrom - start position for results
        pageSize - maximum number of results
        effectiveTime - the time that the retrieved elements must be effective for
        methodName - calling method
        Returns:
        list of Connection beans
        Throws:
        InvalidParameterException - the parameters are invalid
        UserNotAuthorizedException - user not authorized to issue this request
        PropertyServerException - problem accessing the property server

      • findConnections

        public List<B> findConnections​(String userId,
                               String searchString,
                               String searchStringParameterName,
                               int startFrom,
                               int pageSize,
                               Date effectiveTime,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
        Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression. This only retrieves the connection entity.
        Parameters:
        userId - calling user
        searchString - string to find in the properties
        searchStringParameterName - name of parameter supplying the search string
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        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)

      • getConnectionsByName

        public List<B> getConnectionsByName​(String userId,
                                    String name,
                                    String nameParameterName,
                                    int startFrom,
                                    int pageSize,
                                    Date effectiveTime,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Retrieve the list of metadata elements with a matching qualified name or display name. There are no wildcards supported on this request. This only retrieves the connection entity.
        Parameters:
        userId - calling user
        name - name to search for
        nameParameterName - parameter supplying name
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        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)