Package org.odpi.openmetadata.accessservices.communityprofile.api

Interface MetadataSourceInterface

public interface MetadataSourceInterface
MetadataSourceInterface is the interface used to define information about the third party technologies that an integration daemon is extracting metadata from. These technologies are represented by a software server capability in open metadata with an appropriate classification.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMasterDataManagerClassification(String userId, String metadataSourceGUID)
    Update classification of the metadata source that is a master data manager for user profile information.
    void
    addUserAccessDirectoryClassification(String userId, String metadataSourceGUID)
    Update classification of the metadata source that is providing a user access directory information such as the groups and access rights of a user Id.
    void
    addUserProfileManagerClassification(String userId, String metadataSourceGUID)
    Update classification of the metadata source as being capable if managing user profiles.
    String
    createMetadataSource(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.MetadataSourceProperties properties)
    Create information about the metadata source that is providing user profile information.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataSourceElement
    getMetadataSource(String userId, String metadataSourceGUID)
    Retrieve the properties of the software server capability that describes a metadata source.
    String
    getMetadataSourceGUID(String userId, String qualifiedName)
    Retrieve the unique identifier of the software server capability that describes a metadata source.

  • Method Details

    • createMetadataSource

      String createMetadataSource(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.softwarecapabilities.MetadataSourceProperties properties) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Create information about the metadata source that is providing user profile information.
      Parameters:
      userId - calling user
      properties - description of the metadata source
      Returns:
      unique identifier of the user profile manager's software server capability
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • getMetadataSourceGUID

      String getMetadataSourceGUID(String userId, String qualifiedName) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the unique identifier of the software server capability that describes a metadata source. This could be a user profile manager, user access directory and/or a master data manager.
      Parameters:
      userId - calling user
      qualifiedName - unique name of the metadata source
      Returns:
      unique identifier of the integration daemon's software server capability
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • getMetadataSource

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataSourceElement getMetadataSource(String userId, String metadataSourceGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Retrieve the properties of the software server capability that describes a metadata source. This could be a user profile manager, user access directory and/or a master data manager.
      Parameters:
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      Returns:
      unique identifier of the integration daemon's software server capability
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • addUserProfileManagerClassification

      void addUserProfileManagerClassification(String userId, String metadataSourceGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update classification of the metadata source as being capable if managing user profiles.
      Parameters:
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • addUserAccessDirectoryClassification

      void addUserAccessDirectoryClassification(String userId, String metadataSourceGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update classification of the metadata source that is providing a user access directory information such as the groups and access rights of a user Id.
      Parameters:
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server

    • addMasterDataManagerClassification

      void addMasterDataManagerClassification(String userId, String metadataSourceGUID) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException
      Update classification of the metadata source that is a master data manager for user profile information.
      Parameters:
      userId - calling user
      metadataSourceGUID - unique identifier of the metadata source
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the bean properties are invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - problem accessing the property server