org.odpi.openmetadata.accessservices.communityprofile.client

Class MetadataSourceClient

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.client.MetadataSourceClient

All Implemented Interfaces:

MetadataSourceInterface

public class MetadataSourceClient
extends 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 and Description
MetadataSourceClient(String serverName, String serverPlatformURLRoot) Create a new client with no authentication embedded in the HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Create a new client with no authentication embedded in the HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize) Create a new client that passes userId and password in each HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, String userId, String password) Create a new client that passes userId and password in each HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) Create a new client that passes userId and password in each HTTP request.

Method Summary

Modifier and Type	Method and 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, MetadataSourceProperties properties) Create information about the metadata source that is providing user profile information.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataSourceClient

public MetadataSourceClient(String serverName,
                            String serverPlatformURLRoot)
                     throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - bad input parameters

MetadataSourceClient

public MetadataSourceClient(String serverName,
                            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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

MetadataSourceClient

public MetadataSourceClient(String serverName,
                            String serverPlatformURLRoot,
                            String userId,
                            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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - bad input parameters

MetadataSourceClient

public MetadataSourceClient(String serverName,
                            String serverPlatformURLRoot,
                            String userId,
                            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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - bad input parameters

MetadataSourceClient

public MetadataSourceClient(String serverName,
                            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 to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Detail

createMetadataSource

public String createMetadataSource(String userId,
                                   MetadataSourceProperties properties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create information about the metadata source that is providing user profile information.

Specified by:

createMetadataSource in interface MetadataSourceInterface

Parameters:

userId - calling user

properties - description of the metadata source

Returns:

unique identifier of the user profile manager's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getMetadataSourceGUID

public String getMetadataSourceGUID(String userId,
                                    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 interface MetadataSourceInterface

Parameters:

userId - calling user

qualifiedName - unique name of the metadata source

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getMetadataSource

public MetadataSourceElement getMetadataSource(String userId,
                                               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 interface MetadataSourceInterface

Parameters:

userId - calling user

metadataSourceGUID - unique identifier of the metadata source

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addUserProfileManagerClassification

public void addUserProfileManagerClassification(String userId,
                                                String metadataSourceGUID)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Update classification of the metadata source as being capable if managing user profiles.

Specified by:

addUserProfileManagerClassification in interface MetadataSourceInterface

Parameters:

userId - calling user

metadataSourceGUID - unique identifier of the metadata source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addUserAccessDirectoryClassification

public void addUserAccessDirectoryClassification(String userId,
                                                 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 interface MetadataSourceInterface

Parameters:

userId - calling user

metadataSourceGUID - unique identifier of the metadata source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addMasterDataManagerClassification

public void addMasterDataManagerClassification(String userId,
                                               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 interface MetadataSourceInterface

Parameters:

userId - calling user

metadataSourceGUID - unique identifier of the metadata source

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server