Class OMAGServerAdminForAccessServices


  • public class OMAGServerAdminForAccessServices
    extends java.lang.Object
    OMAGServerAdminForAccessServices provides the server-side support for the services that add access services configuration to an OMAG Server.
    • Constructor Detail

      • OMAGServerAdminForAccessServices

        public OMAGServerAdminForAccessServices()
        Default constructor
    • Method Detail

      • getConfiguredAccessServices

        public RegisteredOMAGServicesResponse getConfiguredAccessServices​(java.lang.String userId,
                                                                          java.lang.String serverName)
        Return the list of access services that are configured for this server.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of access service descriptions
      • getAccessServicesConfiguration

        public AccessServicesResponse getAccessServicesConfiguration​(java.lang.String userId,
                                                                     java.lang.String serverName)
        Return the list of access services that are configured for this server.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of access service configurations
      • configureAccessService

        public VoidResponse configureAccessService​(java.lang.String userId,
                                                   java.lang.String serverName,
                                                   java.lang.String serviceURLMarker,
                                                   java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
        Enable a single access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - access service name used in URL
        accessServiceOptions - property name/value pairs used to configure the access services
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • configureAllAccessServices

        public VoidResponse configureAllAccessServices​(java.lang.String userId,
                                                       java.lang.String serverName,
                                                       java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
        Enable all access services that are registered with this server platform. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • configureAccessServiceNoTopics

        public VoidResponse configureAccessServiceNoTopics​(java.lang.String userId,
                                                           java.lang.String serverName,
                                                           java.lang.String serviceURLMarker,
                                                           java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
        Enable a single access service. This version of the call does not set up the InTopic nor the OutTopic.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - access service name used in URL
        accessServiceOptions - property name/value pairs used to configure the access services
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • configureAllAccessServicesNoTopics

        public VoidResponse configureAllAccessServicesNoTopics​(java.lang.String userId,
                                                               java.lang.String serverName,
                                                               java.util.Map<java.lang.String,​java.lang.Object> accessServiceOptions)
        Enable all access services that are registered with this server platform. The configuration properties for each access service can be changed from their default using setAccessServicesConfig operation. This version of the call does not set up the InTopic nor the OutTopic.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServiceOptions - property name/value pairs used to configure the access services
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • clearAllAccessServices

        public VoidResponse clearAllAccessServices​(java.lang.String userId,
                                                   java.lang.String serverName)
        Disable the access services. This removes all configuration for the access services and disables the enterprise repository services.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.
      • getAccessServiceConfig

        public AccessServiceConfigResponse getAccessServiceConfig​(java.lang.String userId,
                                                                  java.lang.String serverName,
                                                                  java.lang.String serviceURLMarker)
        Retrieve the config for an access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - access service name used in URL
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.
      • clearAccessService

        public VoidResponse clearAccessService​(java.lang.String userId,
                                               java.lang.String serverName,
                                               java.lang.String serviceURLMarker)
        Remove an access service. This removes all configuration for the access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - access service name used in URL
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.
      • getAccessServiceTopicNames

        public StringMapResponse getAccessServiceTopicNames​(java.lang.String userId,
                                                            java.lang.String serverName,
                                                            java.lang.String serviceURLMarker)
        Retrieve the topic names for this access service
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.
      • getAllAccessServiceTopicNames

        public StringMapResponse getAllAccessServiceTopicNames​(java.lang.String userId,
                                                               java.lang.String serverName)
        Retrieve the topic names for all configured access services
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.
      • overrideAccessServiceInTopicName

        public VoidResponse overrideAccessServiceInTopicName​(java.lang.String userId,
                                                             java.lang.String serverName,
                                                             java.lang.String serviceURLMarker,
                                                             java.lang.String topicName)
        Update the in topic name for a specific access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        topicName - string for new topic name
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.
      • overrideAccessServiceOutTopicName

        public VoidResponse overrideAccessServiceOutTopicName​(java.lang.String userId,
                                                              java.lang.String serverName,
                                                              java.lang.String serviceURLMarker,
                                                              java.lang.String topicName)
        Update the out topic name for a specific access service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - string indicating which access service it requested
        topicName - string for new topic name
        Returns:
        map of topic names or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.
      • setAccessServicesConfig

        public VoidResponse setAccessServicesConfig​(java.lang.String userId,
                                                    java.lang.String serverName,
                                                    java.util.List<AccessServiceConfig> accessServicesConfig)
        Set up the configuration for all the open metadata access services (OMASs). This overrides the current values.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        accessServicesConfig - list of configuration properties for each access service.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or accessServicesConfig parameter.
      • addRemoteEnterpriseTopic

        public VoidResponse addRemoteEnterpriseTopic​(java.lang.String userId,
                                                     java.lang.String serverName,
                                                     java.util.Map<java.lang.String,​java.lang.Object> configurationProperties)
        Set up the default remote enterprise topic. This allows a remote process to monitor enterprise topic events.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        configurationProperties - additional properties for the cohort
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or null userId parameter.
      • setEnterpriseAccessConfig

        public VoidResponse setEnterpriseAccessConfig​(java.lang.String userId,
                                                      java.lang.String serverName,
                                                      EnterpriseAccessConfig enterpriseAccessConfig)
        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.
        Parameters:
        userId - user that is issuing the request
        serverName - local server name
        enterpriseAccessConfig - enterprise repository services configuration properties.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or enterpriseAccessConfig parameter.