Configuring a service. In the sections above we have explained how to implement different components into a service plugin. However, service plugins need to be configured with some configuration parameters such as API credentials. These configuration parameters need to be defined in a configuration file and are automatically loaded by the service manager of the Audio Commons Mediator and made available to the service plugins. Different third party services might require different configuration parameters. The different components of service plugins can implement a conf_XXX method which is given the configuration parameters from the configuration file and can store them as required. The typical use case is the loading of third party services’ API credentials. These credentials (typically CLIENT_ID and CLIENT_SECRET), are stored in the configuration file, loaded by the mediator and passed to the authentication component by calling the conf_auth method with the configuration as parameter. The default implementation of the authentication component expects client ids and secrets to be in the configuration parameters, its conf_auth method is implemented as: def conf_auth(self, config): if 'client_id' not in config: raise ImproperlyConfiguredACService('Missing item \'client_id\'') if 'client_secret' not in config: raise ImproperlyConfiguredACService('Missing item \'client_secret\'') self.set_credentials(config['client_id'], config['client_secret']) The other typical use case is the loading of service IDs provided by Audio Commons. Each service is provided a unique ID which is loaded in the service plugin base component. In this file: xxxxx://xxxxxx.xxx/AudioCommons/ac-mediator/blob/master/services/services_conf.example.cfg you can see an example configuration file which stores all configuration parameters from third party services.
