Interface ConnectorTypeManagerInterface

  • All Known Implementing Classes:
    ConnectorTypeManagerClient

    public interface ConnectorTypeManagerInterface
    ConnectorTypeManagerInterface provides methods to define connector types. The ConnectorType describes a specific connector implementation.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, ConnectorTypeProperties connectorTypeProperties)
      Create a new metadata element to represent the root of a connectorType.
      java.lang.String createConnectorTypeFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a connectorType using an existing metadata element as a template.
      java.util.List<ConnectorTypeElement> findConnectorTypes​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements that contain the search string.
      ConnectorTypeElement getConnectorTypeByGUID​(java.lang.String userId, java.lang.String connectorTypeGUID)
      Retrieve the connectorType metadata element with the supplied unique identifier.
      java.util.List<ConnectorTypeElement> getConnectorTypesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of connectorType metadata elements with a matching qualified or display name.
      void removeConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String connectorTypeGUID)
      Remove the metadata element representing a connectorType.
      void updateConnectorType​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean isMergeUpdate, java.lang.String connectorTypeGUID, ConnectorTypeProperties connectorTypeProperties)
      Update the metadata element representing a connectorType.
    • Method Detail

      • createConnectorType

        java.lang.String createConnectorType​(java.lang.String userId,
                                             java.lang.String infrastructureManagerGUID,
                                             java.lang.String infrastructureManagerName,
                                             ConnectorTypeProperties connectorTypeProperties)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Create a new metadata element to represent the root of a connectorType.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        connectorTypeProperties - properties to store
        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)
      • createConnectorTypeFromTemplate

        java.lang.String createConnectorTypeFromTemplate​(java.lang.String userId,
                                                         java.lang.String infrastructureManagerGUID,
                                                         java.lang.String infrastructureManagerName,
                                                         java.lang.String templateGUID,
                                                         TemplateProperties templateProperties)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Create a new metadata element to represent a connectorType using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new connectorType.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        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)
      • updateConnectorType

        void updateConnectorType​(java.lang.String userId,
                                 java.lang.String infrastructureManagerGUID,
                                 java.lang.String infrastructureManagerName,
                                 boolean isMergeUpdate,
                                 java.lang.String connectorTypeGUID,
                                 ConnectorTypeProperties connectorTypeProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Update the metadata element representing a connectorType.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        connectorTypeGUID - unique identifier of the metadata element to update
        connectorTypeProperties - new properties for this 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)
      • removeConnectorType

        void removeConnectorType​(java.lang.String userId,
                                 java.lang.String infrastructureManagerGUID,
                                 java.lang.String infrastructureManagerName,
                                 java.lang.String connectorTypeGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Remove the metadata element representing a connectorType. This will delete the connectorType and all categories and terms.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        connectorTypeGUID - unique identifier of the metadata element to remove
        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)