collection-broker-stop

Stops the Collection Broker. The SOAP name of this function is: CollectionBrokerStop

Synopsis

void collection-broker-stop

Parameters

Function takes no parameters.

Exceptions

There are no exceptions specific to this function.

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the collection-broker-stop 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-stop 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 username and password under which a function executes. An example of this in Java for a SOAP call to the collection-broker-stop function is the following:

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

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

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