Class MetadataAccessServerConfigurationClient

    • Constructor Detail

      • MetadataAccessServerConfigurationClient

        public MetadataAccessServerConfigurationClient​(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.
      • MetadataAccessServerConfigurationClient

        public MetadataAccessServerConfigurationClient​(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

      • getRegisteredAccessServices

        public java.util.List<RegisteredOMAGService> getRegisteredAccessServices()
                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of access services for this server.
        Returns:
        list of access service descriptions
        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.
      • getConfiguredAccessServices

        public java.util.List<RegisteredOMAGService> getConfiguredAccessServices()
                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of access services that are configured for this server.
        Returns:
        list of access service descriptions
        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.
      • getAccessServicesConfiguration

        public java.util.List<AccessServiceConfig> getAccessServicesConfiguration()
                                                                           throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                  org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the access services in this server.
        Returns:
        list of access service configuration
        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.
      • configureAccessService

        public void configureAccessService​(java.lang.String serviceURLMarker)
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single access service.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        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.
      • disableAccessService

        public void disableAccessService​(java.lang.String serviceURLMarker)
                                  throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                         org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable a single access service.
        Parameters:
        serviceURLMarker - string indicating which access service it is disabling
        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.
      • configureAccessService

        public void configureAccessService​(java.lang.String serviceURLMarker,
                                           java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single access service.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        accessServiceOptions - property name/value pairs used to configure the access service
        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.
      • configureAccessServiceNoTopics

        public void configureAccessServiceNoTopics​(java.lang.String serviceURLMarker)
                                            throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single access service without the In and Out topic.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        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.
      • configureAccessServiceNoTopics

        public void configureAccessServiceNoTopics​(java.lang.String serviceURLMarker,
                                                   java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
                                            throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                   org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single access service without the In and Out topic.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        accessServiceOptions - property name/value pairs used to configure the access service
        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.
      • configureAllAccessServices

        public void configureAllAccessServices​(java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
                                        throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                               org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable all access services that are registered into this server. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.
        Parameters:
        accessServiceOptions - property name/value pairs used to configure the access services
        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.
      • configureAllAccessServicesNoTopics

        public void configureAllAccessServicesNoTopics​(java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
                                                throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                       org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable all access services that are registered into this server without the in and out topics activated. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.
        Parameters:
        accessServiceOptions - property name/value pairs used to configure the access services
        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.
      • getAccessServiceTopicNames

        public java.util.Map<java.lang.String,​java.lang.String> getAccessServiceTopicNames​(java.lang.String serviceURLMarker)
                                                                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Retrieve the topic names for this access service
        Parameters:
        serviceURLMarker - string indicating which access service it requested
        Returns:
        map of topic names to descriptions
        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.
      • getAllAccessServiceTopicNames

        public java.util.Map<java.lang.String,​java.lang.String> getAllAccessServiceTopicNames()
                                                                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                                    org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Retrieve the topic names for all configured access service
        Returns:
        map of topic names to descriptions
        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.
      • overrideAccessServiceInTopic

        public void overrideAccessServiceInTopic​(java.lang.String serviceURLMarker,
                                                 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 topic name for the in topic of a single access service.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        topicName - new 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.
      • overrideAccessServiceOutTopic

        public void overrideAccessServiceOutTopic​(java.lang.String serviceURLMarker,
                                                  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 topic name for the in topic of a single access service.
        Parameters:
        serviceURLMarker - string indicating which access service it is configuring
        topicName - new 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.
      • clearAllAccessServices

        public void clearAllAccessServices()
                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.
        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.
      • setAccessServicesConfig

        public void setAccessServicesConfig​(java.util.List<AccessServiceConfig> accessServicesConfig)
                                     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 all the open metadata access services (OMASs). This overrides the current values.
        Parameters:
        accessServicesConfig - - list of configuration properties for each access service.
        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.
      • addRemoteEnterpriseTopic

        public void addRemoteEnterpriseTopic​(java.util.Map<java.lang.String,​java.lang.Object> configurationProperties)
                                      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 default remote enterprise topic. This allows a remote process to monitor enterprise topic events.
        Parameters:
        configurationProperties - additional properties 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.
      • setEnterpriseAccessConfig

        public void setEnterpriseAccessConfig​(EnterpriseAccessConfig enterpriseAccessConfig)
                                       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 that controls the enterprise repository services. These services are part of the Open Metadata Repository Services (OMRS). They provide federated queries and federated event notifications that cover metadata from the local repository plus any repositories connected via open metadata repository cohorts. These services are configured automatically when the access services are enabled and so this call is not normally needed unless the default settings for the enterprise access services are not sufficient.
        Parameters:
        enterpriseAccessConfig - - enterprise repository services configuration properties.
        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.