collection-broker-enqueue-xml

Synopsis

collection-broker-enqueue-responsenodeset collection-broker-enqueue-xml(collection, crawl-nodes, exception-on-failure);
nmtoken collection;
crawl-urlsnodeset crawl-nodes;
boolean exception-on-failure;

Parameters

• nmtoken collection (Required)
• crawl-urls crawl-nodes - Any combination of crawl-url and crawl-delete. (Required)
• boolean exception-on-failure - If false then the search-collection-enqueue exception will be thrown only for problems related to communicating with the crawler. If true, the exception will be thrown if any URL was not successfully enqueued. Default value: false.

Return Value

• collection-broker-enqueue-response nodeset

Exceptions

• search-collection-invalid-name
• search-collection-service-communication-missing-result
• search-collection-service-communication-terminating
• search-collection-service-communication-not-running
• search-collection-enqueue
• search-collection-enqueue-read-only
• search-collection-enqueue-invalid-node
• search-collection-enqueue-invalid-attr
• search-collection-enqueue-malformed-crawl-url
• search-collection-enqueue-malformed-crawl-delete
• search-collection-enqueue-malformed-index-atomic
• search-collection-enqueue-malformed-crawl-state
• search-collection-enqueue-audit-log-disabled
• search-collection-enqueue-terminating
• search-collection-enqueue-database
• collection-broker-enqueue-xml

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the collection-broker-enqueue-xml 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-enqueue-xml 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-enqueue-xml function is the following:

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

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

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