HttpClient Class A Sandcastle Documented Class Library
This will execute the queries.
Inheritance Hierarchy

SystemObject
  Ontotext.S4.clientHttpClient

Namespace: Ontotext.S4.client
Assembly: S4ClientLibrary (in S4ClientLibrary.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public class HttpClient

The HttpClient type exposes the following members.

Constructors

  NameDescription
Public methodHttpClient(String, String)
Create a client that uses the {@link #DEFAULT_BASE_URL default base URL}.
Public methodHttpClient(Uri, String, String)
Create a client using a specified base URL (for advanced use only - the default URL will work for all normal cases).
Top
Methods

  NameDescription
Public methoddelete
Perform an HTTP DELETE request for the given resource.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodgetT
Perform an HTTP GET request, parsing the JSON response to create a new object.
Public methodgetBaseUrl
Public methodgetForUpdate
Perform an HTTP GET request, parsing the JSON response to update the state of an existing object.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodgetRedirect
Perform an HTTP GET request on a URL whose response is expected to be a 3xx redirection, and return the target redirection URL.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodpostT
Public methodpostForUpdate
Perform an HTTP POST request, parsing the JSON response to update the state of an existing object.
Private methodreadError
Read an error response from the given connection and throw a suitable {@link HttpClientException}. This method always throws an exception, it will never return normally.
Private methodreadResponseOrErrorT(HttpWebResponse, T)
Read a response or error message from the given connection, handling any 303 redirect responses.
Private methodreadResponseOrErrorT(HttpWebResponse, T, Boolean)
Read a response or error message from the given connection, handling any 303 redirect responses if
followRedirects
is true.
Private methodreadResponseOrErrorForUpdateT
Read a response or error message from the given connection, and update the state of the given object.
Public methodrequestT
Make an API request and parse the JSON response into a new object.
Public methodrequestForStream
Make an API request and return the raw data from the response as an InputStream.
Public methodrequestForUpdate
Make an API request and parse the JSON response, using the response to update the state of an existing object.
Private methodsendRequest
Handles the sending side of an HTTP request, returning a connection from which the response (or error) can be read.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields

  NameDescription
Private fieldbaseUrl
The base URL that will be used to resolve any relative request URIs.
Public fieldStatic memberDEFAULT_BASE_URL
The standard base URI for the S4 API.
Private fieldStatic membernc
The HTTP basic authentication header that will be appended to all requests.
Top
See Also

Reference