Interface MetadataSourceInterface
-
- All Known Implementing Classes:
MetadataSourceClient
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addMasterDataManagerClassification(java.lang.String userId, java.lang.String metadataSourceGUID)
Update classification of the metadata source that is a master data manager for user profile information.void
addUserAccessDirectoryClassification(java.lang.String userId, java.lang.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(java.lang.String userId, java.lang.String metadataSourceGUID)
Update classification of the metadata source as being capable if managing user profiles.java.lang.String
createMetadataSource(java.lang.String userId, MetadataSourceProperties properties)
Create information about the metadata source that is providing user profile information.MetadataSourceElement
getMetadataSource(java.lang.String userId, java.lang.String metadataSourceGUID)
Retrieve the properties of the software server capability that describes a metadata source.java.lang.String
getMetadataSourceGUID(java.lang.String userId, java.lang.String qualifiedName)
Retrieve the unique identifier of the software server capability that describes a metadata source.
-
-
-
Method Detail
-
createMetadataSource
java.lang.String createMetadataSource(java.lang.String userId, MetadataSourceProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create information about the metadata source that is providing user profile information.- Parameters:
userId
- calling userproperties
- description of the metadata source- Returns:
- unique identifier of the user profile manager's software server capability
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
getMetadataSourceGUID
java.lang.String getMetadataSourceGUID(java.lang.String userId, java.lang.String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, 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 userqualifiedName
- unique name of the metadata source- Returns:
- unique identifier of the integration daemon's software server capability
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
getMetadataSource
MetadataSourceElement getMetadataSource(java.lang.String userId, java.lang.String metadataSourceGUID) throws InvalidParameterException, UserNotAuthorizedException, 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 usermetadataSourceGUID
- unique identifier of the metadata source- Returns:
- unique identifier of the integration daemon's software server capability
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
addUserProfileManagerClassification
void addUserProfileManagerClassification(java.lang.String userId, java.lang.String metadataSourceGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update classification of the metadata source as being capable if managing user profiles.- Parameters:
userId
- calling usermetadataSourceGUID
- unique identifier of the metadata source- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
addUserAccessDirectoryClassification
void addUserAccessDirectoryClassification(java.lang.String userId, java.lang.String metadataSourceGUID) throws InvalidParameterException, UserNotAuthorizedException, 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 usermetadataSourceGUID
- unique identifier of the metadata source- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
addMasterDataManagerClassification
void addMasterDataManagerClassification(java.lang.String userId, java.lang.String metadataSourceGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update classification of the metadata source that is a master data manager for user profile information.- Parameters:
userId
- calling usermetadataSourceGUID
- unique identifier of the metadata source- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
-