Quick Links
Description
The Amadis Configuration Module provides an integrator with easy access to Nexo TMS related functionalities.
How to
Initialise a connection provider
This refers to a different module - a more complete documentation can be found at <insert link to AmadisUnifiedConnectionProvider>
For all usages of the Configuration Module, a Connection Provider must be available. A default implementation with Nexo required capabilities is provided.
// Provide an input stream to the Certificate Authorities allowed on this provider InputStream nexoCAFile = { ... }; // Initiate an instance of an Object implementing the TMSConnectionProvider interface // We are using the Amadis provider here for ease of use AmadisUnifiedConnectionProvider connectionProvider = AmadisUnifiedConnectionProvider.DefaultNexoProvider(nexoCAFile);
Force a Configuration attempt on a specific host
This should be used for the first configuration retrieval, or to force a specific host different from what was specified in the configuration
// Load or initialise an empty configuration - see the [Minimal Configuration Required] section for more information byte[] configuration = { ... }; TMSResult result = AmadisTMSModule.DoConfiguration(connectionProvider, configuration, "hostname:port"); // Inspect and use the result Object if (result.isSuccess()) { Log.d("config", "Configuration attempt was successful"); // Configuration attempt was successful - this is the new valid configuration and should replace the old one. configuration = result.getConfiguration(); // It is important to always keep the Connection Provider up to date with the current configuration connectionProvider.setConfiguration(configuration); } else { // The textual reason for a failure is provided Log.d("config", "Configuration attempt failed: " + result.getError()); }
Execute a configuration attempt, using the system-configured TMS host
This should be used for any subsequent manually triggered configuration retrieval. It uses the configuration content’s host system to identify the active TMS host, then proceeds to retrieve the configuration if required.
// [configuration] must be a previously received valid configuration from the TMS system TMSResult result = AmadisTMSModule.DoConfiguration(connectionProvider, configuration); // Inspect and use the result Object if (result.isSuccess()) { Log.d("config", "Configuration attempt was successful"); // Configuration attempt was successful - this is the new valid configuration and should replace the old one. configuration = result.getConfiguration(); // It is important to always keep the Connection Provider up to date with the current configuration connectionProvider.setConfiguration(configuration); } else { // The textual reason for a failure is provided Log.d("config", "Configuration attempt failed: " + result.getError()); }