org.wso2.carbon.ml.integration.common.utils

Class MLHttpClient

java.lang.Object

org.wso2.carbon.ml.integration.common.utils.MLHttpClient

public class MLHttpClient
extends Object

This is a http client to call ML services through the REST API.

Constructor Summary

Constructors

Constructor and Description
MLHttpClient(org.wso2.carbon.automation.engine.context.beans.Instance mlInstance, org.wso2.carbon.automation.engine.context.beans.User userInfo)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkDatasetStatus(int versionSetId, long timeout, int frequency) Check the status of a dataset.
org.apache.http.client.methods.CloseableHttpResponse	createAnalysis(String AnalysisName, int ProjectId) Create an Analysis
org.apache.http.client.methods.CloseableHttpResponse	createAnalysisCrossOrigin(String AnalysisName, int ProjectId) Create an Analysis with CORS
org.apache.http.client.methods.CloseableHttpResponse	createFileModelStorage(int modelId, String folderName) Create the file storage for a model
org.apache.http.client.methods.CloseableHttpResponse	createModel(int analysisId, int versionSetId) Create a Model
org.apache.http.client.methods.CloseableHttpResponse	createProject(String ProjectName, String datasetName) Create a project
org.apache.http.client.methods.CloseableHttpResponse	doHttpDelete(String resourcePath)
org.apache.http.client.methods.CloseableHttpResponse	doHttpGet(String resourcePath) Send a HTTP GET request to the given URI and return the response.
org.apache.http.client.methods.CloseableHttpResponse	doHttpPost(String resourcePath) Send a HTTP POST request to the given URI with null parameters and return the response.
org.apache.http.client.methods.CloseableHttpResponse	doHttpPost(String resourcePath, String parametersJson) Send a HTTP POST request to the given URI and return the response.
org.apache.http.client.methods.CloseableHttpResponse	doHttpPostCrossOrigin(String resourcePath, String parametersJson) Send a cross origin HTTP POST request to the given URI and return the response.
org.apache.http.client.methods.CloseableHttpResponse	exportAsPMML(int modelId) Download an existing serialized model in PMML format
int	getAnalysisId(int projectId, String analysisName) Get the ID of an analysis from the name
int	getAVersionSetIdOfDataset(int datasetId) Get a ID of the first version-set of a dataset
String	getBasicAuthKey() Get the Encoded Key for Basic auth header
int	getModelId(String modelName) Get the model ID using the name of the model
String	getModelName(org.apache.http.client.methods.CloseableHttpResponse response) Extract the model name from the response
int	getProjectId(String projectName) Get the ID of the project from the name
String	getResourceAbsolutePath(String resourceRelativePath) Retrieves the absolute path of a test resource.
org.json.JSONObject	getResponseAsJSONObject(org.apache.http.client.methods.CloseableHttpResponse response)
String	getResponseAsString(org.apache.http.client.methods.CloseableHttpResponse response)
protected String	getServerUrlHttp() Get the Server URL.
protected String	getServerUrlHttps() Get the secured URL of the ml Server.
int	getVersionSetIdOfDataset(int datasetId, String version) Get the ID of the version set with the given version and of a given dataset
org.apache.http.client.methods.CloseableHttpResponse	predictFromCSV(long modelId, String resourcePath)
org.apache.http.client.methods.CloseableHttpResponse	setFeatureCustomized(int analysisId, String customizedFeatures) Set feature customized for an analysis.
org.apache.http.client.methods.CloseableHttpResponse	setFeatureDefaults(int analysisId) Set feature defaults for an analysis.
org.apache.http.client.methods.CloseableHttpResponse	setModelConfiguration(int analysisId, Map<String,String> configurations) Set Model Configurations of an analysis
org.apache.http.client.methods.CloseableHttpResponse	uploadDatasetFromCSV(String datasetName, String version, String resourcePath) Upload a sample datatset from resources
org.apache.http.client.methods.CloseableHttpResponse	uploadDatasetFromDAS(String datasetName, String version, String tableName) Upload a sample datatset from resources

Methods inherited from class java.lang.Object

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

Constructor Detail

MLHttpClient

public MLHttpClient(org.wso2.carbon.automation.engine.context.beans.Instance mlInstance,
            org.wso2.carbon.automation.engine.context.beans.User userInfo)

Method Detail

getServerUrlHttps

protected String getServerUrlHttps()

Get the secured URL of the ml Server.

Returns:

Secured URL of the service.

Throws:

MLIntegrationBaseTestException

getServerUrlHttp

protected String getServerUrlHttp()

Get the Server URL.

Returns:

Non-secured URL of the service.

Throws:

MLIntegrationBaseTestException

doHttpGet

public org.apache.http.client.methods.CloseableHttpResponse doHttpGet(String resourcePath)
                                                               throws MLHttpClientException

Send a HTTP GET request to the given URI and return the response.

Returns:

Response from the endpoint

Throws:

MLHttpClientException

doHttpPost

public org.apache.http.client.methods.CloseableHttpResponse doHttpPost(String resourcePath,
                                                              String parametersJson)
                                                                throws MLHttpClientException

Send a HTTP POST request to the given URI and return the response.

Parameters:

parametersJson - Payload JSON string

Returns:

Response from the endpoint

Throws:

MLHttpClientException

doHttpPostCrossOrigin

public org.apache.http.client.methods.CloseableHttpResponse doHttpPostCrossOrigin(String resourcePath,
                                                                         String parametersJson)
                                                                           throws MLHttpClientException

Send a cross origin HTTP POST request to the given URI and return the response.

Parameters:

parametersJson - Payload JSON string

Returns:

Response from the endpoint

Throws:

MLHttpClientException

doHttpPost

public org.apache.http.client.methods.CloseableHttpResponse doHttpPost(String resourcePath)
                                                                throws MLHttpClientException

Send a HTTP POST request to the given URI with null parameters and return the response.

Parameters:

resourcePath - path of the api resource

Returns:

Response from the endpoint

Throws:

MLHttpClientException

doHttpDelete

public org.apache.http.client.methods.CloseableHttpResponse doHttpDelete(String resourcePath)
                                                                  throws MLHttpClientException

Returns:

Response from the endpoint

Throws:

MLHttpClientException

getBasicAuthKey

public String getBasicAuthKey()

Get the Encoded Key for Basic auth header

Returns:

Encoded Key Basic auth Key

uploadDatasetFromCSV

public org.apache.http.client.methods.CloseableHttpResponse uploadDatasetFromCSV(String datasetName,
                                                                        String version,
                                                                        String resourcePath)
                                                                          throws MLHttpClientException

Upload a sample datatset from resources

Parameters:

datasetName - Name for the dataset

version - Version for the dataset

resourcePath - Relative path the CSV file in resources

Returns:

Response from the backend

Throws:

MLHttpClientException

uploadDatasetFromDAS

public org.apache.http.client.methods.CloseableHttpResponse uploadDatasetFromDAS(String datasetName,
                                                                        String version,
                                                                        String tableName)
                                                                          throws MLHttpClientException

Upload a sample datatset from resources

Parameters:

datasetName - Name for the dataset

version - Version for the dataset

tableName - Relative path the CSV file in resources

Returns:

Response from the backend

Throws:

MLHttpClientException

predictFromCSV

public org.apache.http.client.methods.CloseableHttpResponse predictFromCSV(long modelId,
                                                                  String resourcePath)
                                                                    throws MLHttpClientException

Throws:

MLHttpClientException

createProject

public org.apache.http.client.methods.CloseableHttpResponse createProject(String ProjectName,
                                                                 String datasetName)
                                                                   throws MLHttpClientException

Create a project

Parameters:

ProjectName - Name for the project

Returns:

response from the backend

Throws:

MLHttpClientException

createAnalysis

public org.apache.http.client.methods.CloseableHttpResponse createAnalysis(String AnalysisName,
                                                                  int ProjectId)
                                                                    throws MLHttpClientException

Create an Analysis

Parameters:

AnalysisName - Name for the Analysis

Returns:

response from the backend

Throws:

MLHttpClientException

createAnalysisCrossOrigin

public org.apache.http.client.methods.CloseableHttpResponse createAnalysisCrossOrigin(String AnalysisName,
                                                                             int ProjectId)
                                                                               throws MLHttpClientException

Create an Analysis with CORS

Parameters:

AnalysisName - Name for the Analysis

Returns:

response from the backend

Throws:

MLHttpClientException

setFeatureDefaults

public org.apache.http.client.methods.CloseableHttpResponse setFeatureDefaults(int analysisId)
                                                                        throws MLHttpClientException

Set feature defaults for an analysis.

Parameters:

analysisId - ID of the analysis

Returns:

Response from the back-end

Throws:

MLHttpClientException

checkDatasetStatus

public boolean checkDatasetStatus(int versionSetId,
                         long timeout,
                         int frequency)
                           throws MLHttpClientException,
                                  IOException

Check the status of a dataset.

Parameters:

versionSetId -

timeout -

frequency -

Returns:

true if the status is completed and false if it is not.

Throws:

MLHttpClientException

org.json.JSONException

IOException

setFeatureCustomized

public org.apache.http.client.methods.CloseableHttpResponse setFeatureCustomized(int analysisId,
                                                                        String customizedFeatures)
                                                                          throws MLHttpClientException

Set feature customized for an analysis.

Parameters:

analysisId - ID of the analysis

customizedFeatures - customized features json

Returns:

Response from the back-end

Throws:

MLHttpClientException

setModelConfiguration

public org.apache.http.client.methods.CloseableHttpResponse setModelConfiguration(int analysisId,
                                                                         Map<String,String> configurations)
                                                                           throws MLHttpClientException

Set Model Configurations of an analysis

Parameters:

analysisId - ID of the analysis

configurations - Map of configurations

Returns:

Response from the back-end

Throws:

MLHttpClientException

getProjectId

public int getProjectId(String projectName)
                 throws MLHttpClientException

Get the ID of the project from the name

Parameters:

projectName - Name of the project

Returns:

ID of the project

Throws:

MLHttpClientException

getAnalysisId

public int getAnalysisId(int projectId,
                String analysisName)
                  throws MLHttpClientException

Get the ID of an analysis from the name

Parameters:

analysisName - Name of the analysis

Returns:

ID of the analysis

Throws:

MLHttpClientException

getAVersionSetIdOfDataset

public int getAVersionSetIdOfDataset(int datasetId)
                              throws MLHttpClientException

Get a ID of the first version-set of a dataset

Parameters:

datasetId - ID of the dataset

Returns:

ID of the first versionset of the dataset

Throws:

org.apache.http.client.ClientProtocolException

MLHttpClientException

getVersionSetIdOfDataset

public int getVersionSetIdOfDataset(int datasetId,
                           String version)
                             throws MLHttpClientException

Get the ID of the version set with the given version and of a given dataset

Parameters:

datasetId - ID of the dataset

Returns:

ID of the first versionset of the dataset

Throws:

org.apache.http.client.ClientProtocolException

MLHttpClientException

createModel

public org.apache.http.client.methods.CloseableHttpResponse createModel(int analysisId,
                                                               int versionSetId)
                                                                 throws MLHttpClientException

Create a Model

Parameters:

analysisId - ID of the analysis associated with the model

versionSetId - ID of the version set to be used for the model

Returns:

Response from the back-end

Throws:

MLHttpClientException

getResponseAsString

public String getResponseAsString(org.apache.http.client.methods.CloseableHttpResponse response)
                           throws MLHttpClientException

Parameters:

response - CloseableHttpResponse

Returns:

null if response is invalid. Json as string, if it is a valid response.

Throws:

MLHttpClientException

getResponseAsJSONObject

public org.json.JSONObject getResponseAsJSONObject(org.apache.http.client.methods.CloseableHttpResponse response)
                                            throws MLHttpClientException

Parameters:

response - CloseableHttpResponse

Returns:

null if response is invalid. Json as JSONObject, if it is a valid response.

Throws:

MLHttpClientException

getModelId

public int getModelId(String modelName)
               throws MLHttpClientException

Get the model ID using the name of the model

Parameters:

modelName - Name of the model

Returns:

ID of the model

Throws:

MLHttpClientException

createFileModelStorage

public org.apache.http.client.methods.CloseableHttpResponse createFileModelStorage(int modelId,
                                                                          String folderName)
                                                                            throws MLHttpClientException

Create the file storage for a model

Parameters:

modelId - ID of the model

folderName - Name of the directory/sub-directory

Returns:

Response from the back-end

Throws:

MLHttpClientException

getResourceAbsolutePath

public String getResourceAbsolutePath(String resourceRelativePath)

Retrieves the absolute path of a test resource.

Parameters:

resourceRelativePath - Relative path of the test resource.

Returns:

Absolute path of the test resource

getModelName

public String getModelName(org.apache.http.client.methods.CloseableHttpResponse response)
                    throws MLHttpClientException

Extract the model name from the response

Parameters:

response -

Returns:

Throws:

MLHttpClientException

exportAsPMML

public org.apache.http.client.methods.CloseableHttpResponse exportAsPMML(int modelId)
                                                                  throws MLHttpClientException

Download an existing serialized model in PMML format

Parameters:

modelId -

Returns:

Throws:

MLHttpClientException