com.ibm.tivoli.maximo.watson.analytics.util

Class PublicRESTAPIRequests

java.lang.Object

com.ibm.tivoli.maximo.watson.analytics.util.PublicRESTAPIRequests

public class PublicRESTAPIRequests
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PublicRESTAPIRequests()

Method Summary

Modifier and Type	Method and Description
static com.ibm.json.java.JSONObject	accessToken(org.apache.http.client.HttpClient client, CloudEnv env, java.lang.String authCode) With a valid authentication code, get an access token.
static boolean	deleteDatasetPublicApi(org.apache.http.client.HttpClient httpClient, CloudEnv env, java.lang.String id)
static void	dumpErrorFile(java.lang.Exception ex, org.apache.http.client.methods.HttpRequestBase req, RESTAPIResponse resp)
static RESTAPIResponse	execute(org.apache.http.client.HttpClient client, org.apache.http.client.methods.HttpRequestBase method)
static boolean	getDatasetCSVPublicApi(org.apache.http.client.HttpClient httpClient, CloudEnv env, java.lang.String id)
static boolean	getDatasetsPublicApi(org.apache.http.client.HttpClient httpClient, CloudEnv env)
static com.ibm.json.java.JSONObject	me(org.apache.http.client.HttpClient client, CloudEnv env) Get information about the logged in user.
static java.lang.String	uploadDatasetPublicAPI(org.apache.http.client.HttpClient client, CloudEnv env, java.lang.String datasetID, java.io.File file, java.lang.String datasetName, UploadProgressIndicator uploadIndicator) Upload a sample CSV dataset in a single operation.
static java.lang.String	uploadDatasetPublicAPIUsingSegments(org.apache.http.client.HttpClient client, CloudEnv env, java.lang.String datasetID, java.io.File file, java.lang.String datasetName) Upload a sample CSV dataset using multiple segment operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PublicRESTAPIRequests

public PublicRESTAPIRequests()

Method Detail

accessToken

public static com.ibm.json.java.JSONObject accessToken(org.apache.http.client.HttpClient client,
                                                       CloudEnv env,
                                                       java.lang.String authCode)

With a valid authentication code, get an access token.

Parameters:

client -

oauth2URL -

authCode -

Returns:

me

public static com.ibm.json.java.JSONObject me(org.apache.http.client.HttpClient client,
                                              CloudEnv env)

Get information about the logged in user.

Parameters:

client -

env -

Returns:

uploadDatasetPublicAPI

public static java.lang.String uploadDatasetPublicAPI(org.apache.http.client.HttpClient client,
                                                      CloudEnv env,
                                                      java.lang.String datasetID,
                                                      java.io.File file,
                                                      java.lang.String datasetName,
                                                      UploadProgressIndicator uploadIndicator)

Upload a sample CSV dataset in a single operation. This can have problems if the dataset is very large or the network connection isn't solid.

Parameters:

client -

env -

datasetID -

Returns:

uploadDatasetPublicAPIUsingSegments

public static java.lang.String uploadDatasetPublicAPIUsingSegments(org.apache.http.client.HttpClient client,
                                                                   CloudEnv env,
                                                                   java.lang.String datasetID,
                                                                   java.io.File file,
                                                                   java.lang.String datasetName)

Upload a sample CSV dataset using multiple segment operation. This is more reliable than the single upload operation since the size of the data segments can be made smaller. In addition, this allows segments to be resent if there is some type of failure.

Parameters:

client -

env -

datasetID -

Returns:

deleteDatasetPublicApi

public static boolean deleteDatasetPublicApi(org.apache.http.client.HttpClient httpClient,
                                             CloudEnv env,
                                             java.lang.String id)

getDatasetCSVPublicApi

public static boolean getDatasetCSVPublicApi(org.apache.http.client.HttpClient httpClient,
                                             CloudEnv env,
                                             java.lang.String id)

getDatasetsPublicApi

public static boolean getDatasetsPublicApi(org.apache.http.client.HttpClient httpClient,
                                           CloudEnv env)

execute

public static RESTAPIResponse execute(org.apache.http.client.HttpClient client,
                                      org.apache.http.client.methods.HttpRequestBase method)

dumpErrorFile

public static void dumpErrorFile(java.lang.Exception ex,
                                 org.apache.http.client.methods.HttpRequestBase req,
                                 RESTAPIResponse resp)