org.hpccsystems.ws.client.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wsclient Show documentation

This project allows a user to interact with ESP services in a controlled manner. The API calls available under org.hpccsystems.ws.client.platform allow for a user to target ESP's across multiple environments running a range of hpccsystems-platform versions. There is no guarantee that if a user utilizes org.hpccsystems.ws.client.gen generated stub code from wsdl, that the calls will be backwards compatible with older hpccsystems-platform versions.

There is a newer version: 9.8.0-1

Show newest version

/**
 *  * Provides several HPCC Systems client libraries used to actuate a variety of actions on
 * a target HPCC Systems instance.
 *
 * These clients abstract connectivity, soap, and proprietary web service details away from
 * the caller. Allowing the caller to focus on higher level logic without the need to account
 * for web service details and interface version changes.
 *
 * Each of the HPCC Systems web service clients expose specialized HPCC-centric actions, and the caller
 * can choose to interact with individual clients directly, or can interact with the multi-purpose HPCCWsClient.
 * The caller must provide connection information including target HPCC Systems address, ECLWatch port (typically 8010 or 18010),
 * and user credentials.
 *
 * Create connection:
 * org.hpccsystems.ws.client.utils.Connection connection = new Connection("http://myhpcc:8010");
 *
 * Provide HPCC Systems user credentials:
 * connection.setCredentials(hpccUser, hpccPass);
 *
 * Get HPCCWsXYZClient:
 * HPCCWsWorkUnitsClient mywswuclient = HPCCWsWorkUnitsClient.get(connection);
 *
 * Execute action of your choice:
 * mywswuclient.ping()
 *
 */
package org.hpccsystems.ws.client;