Class CohortMemberConfigurationClient

    • Constructor Detail

      • CohortMemberConfigurationClient

        public CohortMemberConfigurationClient​(java.lang.String adminUserId,
                                               java.lang.String serverName,
                                               java.lang.String serverPlatformRootURL)
                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • CohortMemberConfigurationClient

        public CohortMemberConfigurationClient​(java.lang.String adminUserId,
                                               java.lang.String serverName,
                                               java.lang.String serverPlatformRootURL,
                                               java.lang.String connectionUserId,
                                               java.lang.String connectionPassword)
                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        connectionUserId - caller's system userId embedded in all HTTP requests
        connectionPassword - caller's system password embedded in all HTTP requests
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • addCohortRegistration

        public void addCohortRegistration​(java.lang.String cohortName,
                                          java.util.Map<java.lang.String,​java.lang.Object> additionalProperties)
                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable registration of server to an open metadata repository cohort using the default topic structure (SINGLE_TOPIC). A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.
        Parameters:
        cohortName - name of the cohort.
        additionalProperties - additional properties for the event bus connection
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • addCohortRegistration

        public void addCohortRegistration​(java.lang.String cohortName,
                                          CohortTopicStructure cohortTopicStructure,
                                          java.util.Map<java.lang.String,​java.lang.Object> additionalProperties)
                                   throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                          org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable registration of server to an open metadata repository cohort using the topic pattern specified by cohortTopicStructure. A cohort is a group of open metadata repositories that are sharing metadata. An OMAG server can connect to zero, one or more cohorts. Each cohort needs a unique name. The members of the cohort use a shared topic to exchange registration information and events related to changes in their supported metadata types and instances. They are also able to query each other's metadata directly through REST calls.
        Parameters:
        cohortName - name of the cohort
        cohortTopicStructure - the style of cohort topic set up to use
        additionalProperties - additional properties for the event bus connection
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server
      • getCohortTopicName

        public java.lang.String getCohortTopicName​(java.lang.String cohortName)
                                            throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Retrieve the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        Returns:
        string topic name
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getDedicatedCohortTopicNames

        public DedicatedTopicList getDedicatedCohortTopicNames​(java.lang.String cohortName)
                                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Retrieve the current topic names for the three dedicated topics of the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        Returns:
        List of topic names - registration first, then types and then instances
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • overrideCohortTopicName

        public void overrideCohortTopicName​(java.lang.String cohortName,
                                            java.lang.String topicName)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Override the current topic name for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        topicName - new name for the topic.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • overrideRegistrationCohortTopicName

        public void overrideRegistrationCohortTopicName​(java.lang.String cohortName,
                                                        java.lang.String topicName)
                                                 throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        topicName - new name for the topic.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • overrideTypesCohortTopicName

        public void overrideTypesCohortTopicName​(java.lang.String cohortName,
                                                 java.lang.String topicName)
                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        topicName - new name for the topic.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • overrideInstancesCohortTopicName

        public void overrideInstancesCohortTopicName​(java.lang.String cohortName,
                                                     java.lang.String topicName)
                                              throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                     org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                     org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Override the current topic name for the registration topic for the cohort. This call can only be made once the cohort is set up with addCohortRegistration().
        Parameters:
        cohortName - name of the cohort.
        topicName - new name for the topic.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setCohortConfig

        public void setCohortConfig​(java.lang.String cohortName,
                                    CohortConfig cohortConfig)
                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration properties for a cohort. This may reconfigure an existing cohort or create a cohort. Use setCohortMode to delete a cohort.
        Parameters:
        cohortName - name of the cohort
        cohortConfig - configuration for the cohort
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearCohortRegistration

        public void clearCohortRegistration​(java.lang.String cohortName)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Unregister this server from an open metadata repository cohort.
        Parameters:
        cohortName - name of the cohort.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • addStartUpOpenMetadataArchiveFile

        public void addStartUpOpenMetadataArchiveFile​(java.lang.String fileName)
                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Add a new open metadata archive file to load at startup.
        Parameters:
        fileName - name of the open metadata archive file.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • addStartUpOpenMetadataArchiveList

        public void addStartUpOpenMetadataArchiveList​(java.util.List<Connection> connections)
                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Add a list of connections to connectors that can access an open metadata archive file.
        Parameters:
        connections - list of connections to open metadata archive connectors
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearOpenMetadataArchives

        public void clearOpenMetadataArchives()
                                       throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Clear the list of open metadata archives for loading at server startup.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setLocalRepositoryConfig

        protected void setLocalRepositoryConfig​(LocalRepositoryConfig localRepositoryConfig)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration for the local repository in one operation. This overrides the current values.
        Parameters:
        localRepositoryConfig - - configuration properties for the local repository.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • clearLocalRepository

        public void clearLocalRepository()
                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Remove all configuration for a local repository. The default is no local repository. This call can be used to remove subsequent local repository configuration. This call effectively sets the type of a metadata server back to a metadata access point.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setLocalMetadataCollectionName

        public void setLocalMetadataCollectionName​(java.lang.String name)
                                            throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the local metadata collection name. If a null is passed, the connection name is cleared to null. If this is not set then the default value is the local server name.
        Parameters:
        name - metadata collection name.
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • getLocalMetadataCollectionId

        public java.lang.String getLocalMetadataCollectionId()
                                                      throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                             org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                             org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.
        Returns:
        string guid
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • setLocalMetadataCollectionId

        public void setLocalMetadataCollectionId​(java.lang.String metadataCollectionId)
                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the local metadata collection id. If the local repository is not configured then the invalid parameter exception is returned.
        Parameters:
        metadataCollectionId - unique identifier for the metadata collection
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.