testoptimal.api

Class Server

java.lang.Object

testoptimal.api.Server

public class Server
extends Object

Copyright 2020 TestOptimal LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author:

Yaxiong Lin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.Protocol

Constructor Summary

Constructors

Constructor and Description
Server(Server.Protocol protocol_p, String svrHost_p, int svrPort_p, String username_p, String password_p) Provides a set of APIs to access TestOptimal server.

Method Summary

Modifier and Type	Method and Description
AgentAPI	getAgentAPI()
DataSetAPI	getDataSetAPI()
protected String	getGraph(String modelName_p, String graphType_p, String outFilePath_p)
ModelAPI	getModelAPI()
protected String	sendGet(String facilityName_p, String cmd_p, String param_p, int expectedStatusCode_p)
protected String	sendPost(String facilityName_p, String cmd_p, String body_p, int expectedStatusCode_p)
protected String	sendPut(String facilityName_p, String cmd_p, String body_p, int expectedStatusCode_p)

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(Server.Protocol protocol_p,
              String svrHost_p,
              int svrPort_p,
              String username_p,
              String password_p)

Provides a set of APIs to access TestOptimal server.

Parameters:

protocol_p - http or https

svrHost_p - TestOptimal server host name

svrPort_p - TestOptimal server port number

username_p - user id to login to TestOptimal server (same user id you would use to open TestOptimal IDE)

password_p - password

Method Detail

sendGet

protected String sendGet(String facilityName_p,
                         String cmd_p,
                         String param_p,
                         int expectedStatusCode_p)
                  throws APIError

Throws:

APIError

sendPost

protected String sendPost(String facilityName_p,
                          String cmd_p,
                          String body_p,
                          int expectedStatusCode_p)
                   throws APIError

Throws:

APIError

sendPut

protected String sendPut(String facilityName_p,
                         String cmd_p,
                         String body_p,
                         int expectedStatusCode_p)
                  throws APIError

Throws:

APIError

getGraph

protected String getGraph(String modelName_p,
                          String graphType_p,
                          String outFilePath_p)
                   throws APIError

Throws:

APIError

getDataSetAPI

public DataSetAPI getDataSetAPI()

getModelAPI

public ModelAPI getModelAPI()

getAgentAPI

public AgentAPI getAgentAPI()