Package com.nettoolkit.internal

Class NetToolKitClient

java.lang.Object

com.nettoolkit.internal.NetToolKitClient

Direct Known Subclasses:

CaseCollectorClient, DashboardsClient, GatekeeperClient, ShibbolethClient

public abstract class NetToolKitClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	mbUseHttps
protected HttpClient	mHttpClient
protected int	miTimeout
protected String	mstrApiKey

Constructor Summary

Constructors

Constructor	Description
NetToolKitClient(String strApiKey)
NetToolKitClient(String strApiKey, boolean bUseHttps)

Method Summary

Modifier and Type	Method	Description
protected String	buildUrl(String strPath)
String	getApiKey()
String	getBaseUrl()
protected JSONObject	getFirstResult(String strResponse)
protected String	getHostname()
protected String	getProtocol()
protected JSONArray	getResults(String strResponse)
int	getTimeout()
boolean	getUseHttps()
protected JSONObject	parseResponse(String strResponse)
ApiResponse	send(BaseApiRequest request)
protected String	sendDelete(String strPath)
protected String	sendDelete(String strPath, String strQuery)
protected String	sendGet(String strPath)
protected String	sendGet(String strPath, String strQuery)
protected String	sendHttpRequest(HttpMethod method, String strPath, String strQueryString, String strBody, HttpContentType contentType)
protected String	sendPost(String strPath, JSONObject jsonBody)
protected String	sendPost(String strPath, String strBody)
protected String	sendPost(String strPath, String strBody, HttpContentType contentType)
protected String	sendPut(String strPath, JSONObject jsonBody)
protected String	sendPut(String strPath, String strBody)
protected String	sendPut(String strPath, String strBody, HttpContentType contentType)
void	setApiKey(String strApiKey)
void	setTimeout(int iTimeout)
void	setUseHttps(boolean bUseHttps)

Methods inherited from class java.lang.Object

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

Field Details

mstrApiKey

protected String mstrApiKey

mbUseHttps

protected boolean mbUseHttps

miTimeout

protected int miTimeout

mHttpClient

protected HttpClient mHttpClient

Constructor Details

NetToolKitClient

public NetToolKitClient(String strApiKey)

NetToolKitClient

public NetToolKitClient(String strApiKey,
 boolean bUseHttps)

Method Details

getApiKey

public String getApiKey()

setApiKey

public void setApiKey(String strApiKey)

getUseHttps

public boolean getUseHttps()

setUseHttps

public void setUseHttps(boolean bUseHttps)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int iTimeout)

getBaseUrl

public String getBaseUrl()

getProtocol

protected String getProtocol()

getHostname

protected String getHostname()

send

public ApiResponse send(BaseApiRequest request)
                 throws ParsingException,
ApiConnectionException,
ApiException

Throws:

ParsingException

ApiConnectionException

ApiException

sendPost

protected String sendPost(String strPath,
 String strBody)
                   throws ApiConnectionException

Throws:

ApiConnectionException

sendPost

protected String sendPost(String strPath,
 JSONObject jsonBody)
                   throws ApiConnectionException

Throws:

ApiConnectionException

sendPost

protected String sendPost(String strPath,
 String strBody,
 HttpContentType contentType)
                   throws ApiConnectionException

Throws:

ApiConnectionException

sendGet

protected String sendGet(String strPath)
                  throws ApiConnectionException

Throws:

ApiConnectionException

sendGet

protected String sendGet(String strPath,
 String strQuery)
                  throws ApiConnectionException

Throws:

ApiConnectionException

sendPut

protected String sendPut(String strPath,
 String strBody)
                  throws ApiConnectionException

Throws:

ApiConnectionException

sendPut

protected String sendPut(String strPath,
 JSONObject jsonBody)
                  throws ApiConnectionException

Throws:

ApiConnectionException

sendPut

protected String sendPut(String strPath,
 String strBody,
 HttpContentType contentType)
                  throws ApiConnectionException

Throws:

ApiConnectionException

sendDelete

protected String sendDelete(String strPath)
                     throws ApiConnectionException

Throws:

ApiConnectionException

sendDelete

protected String sendDelete(String strPath,
 String strQuery)
                     throws ApiConnectionException

Throws:

ApiConnectionException

sendHttpRequest

protected String sendHttpRequest(HttpMethod method,
 String strPath,
 String strQueryString,
 String strBody,
 HttpContentType contentType)
                          throws ApiConnectionException

Throws:

ApiConnectionException

buildUrl

protected String buildUrl(String strPath)

parseResponse

protected JSONObject parseResponse(String strResponse)
                            throws ParsingException,
ApiException

Throws:

ParsingException

ApiException

getResults

protected JSONArray getResults(String strResponse)
                        throws ParsingException,
ApiException

Throws:

ParsingException

ApiException

getFirstResult

protected JSONObject getFirstResult(String strResponse)
                             throws ParsingException,
ApiException

Throws:

ParsingException

ApiException