Class MetadataSourceClient
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.communityprofile.client.MetadataSourceClient
-
- All Implemented Interfaces:
MetadataSourceInterface
public class MetadataSourceClient extends java.lang.Object implements MetadataSourceInterface
MetadataSourceClient is the client for setting up the SoftwareServerCapabilities that represent metadata sources that supply information relating to people and organizations. It is used by the Organization Integrator OMIS to create the metadata source. It can also be used to properly classify the metadata source entity to clarify whether it is a:- User Profile Manager - authoritative source of profile (people and organizations) information.
- User Access Directory - authoritative source of user identity information.
- Master Data Manager - authoritative source of profile (people and organizations) information aggregated and managed from many systems.
-
-
Constructor Summary
Constructors Constructor Description MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
Create a new client with no authentication embedded in the HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
Create a new client that passes userId and password in each HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
Create a new client that passes userId and password in each HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)
Create a new client that passes userId and password in each HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
Create a new client with no authentication embedded in the HTTP request.
-
Method Summary
All Methods Instance Methods Concrete 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.
-
-
-
Constructor Detail
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servers- Throws:
InvalidParameterException
- bad input parameters
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password) throws InvalidParameterException
Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requests- Throws:
InvalidParameterException
- bad input parameters
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog) throws InvalidParameterException
Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requestsauditLog
- logging destination- Throws:
InvalidParameterException
- bad input parameters
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize) throws InvalidParameterException
Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversrestClient
- pre-initialized REST clientmaxPageSize
- pre-initialized parameter limit- Throws:
InvalidParameterException
- there is a problem with the information about the remote OMAS
-
-
Method Detail
-
createMetadataSource
public 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.- Specified by:
createMetadataSource
in interfaceMetadataSourceInterface
- 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
public 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.- Specified by:
getMetadataSourceGUID
in interfaceMetadataSourceInterface
- 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
public 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.- Specified by:
getMetadataSource
in interfaceMetadataSourceInterface
- 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
public 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.- Specified by:
addUserProfileManagerClassification
in interfaceMetadataSourceInterface
- 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
public 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.- Specified by:
addUserAccessDirectoryClassification
in interfaceMetadataSourceInterface
- 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
public 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.- Specified by:
addMasterDataManagerClassification
in interfaceMetadataSourceInterface
- 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
-
-