collection-broker-set

Set the Collection Broker configuration. The SOAP name of this function is: CollectionBrokerSet

Synopsis

void collection-broker-set(configuration);
collection-broker-configuration nodeset configuration;

Parameters

collection-broker-configuration nodeset configuration

Exceptions

collection-broker-set-name

Authentication

Like all Watson Explorer Engine API functions except for ping, the collection-broker-set function requires authentication.

When using REST, you can simply pass v.username and v.password as CGI parameters via HTTP or HTTPS to authenticate the REST call to the collection-broker-set function.

When using the SOAP API, you can pass credentials as parameters on an endpoint, or you can leverage the authentication method that is supported by all Watson Explorer Engine functions. Each provides a setAuthentication method that can be passed an authentication object to provide the user name and password under which a function runs. An example of this in Java for a SOAP call to the collection-broker-set function is the following:


    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    CollectionBrokerSet foo = new CollectionBrokerSet();
    foo.setAuthentication(authentication);

A single authentication object would typically be reused throughout each individual application.