Class 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.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • 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 to
        serverPlatformURLRoot - 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 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​(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 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​(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 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​(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 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