72120597 6fa2 1437 26de f3477e705880

HTTPBased Class

[This is preliminary documentation and is subject to change.]

Provides test oriented functionality for interacting with HTTP based protocols

Inheritance Hierarchy

System.Object
  TeamControlium.NonGUI.HTTPBased
Namespace: TeamControlium.NonGUI
Assembly: TeamControlium.NonGUI (in TeamControlium.NonGUI.dll) Version: 2.0.0

Syntax

C#

public class HTTPBased

The HTTPBased type exposes the following members.

Constructors

 

	Name	Description
	HTTPBased	Initialises a new instance of the HTTPBased class. Used for testing an HTTP interface when used for Non-UI interaction (IE. WebServices, JSON etc...)

  Back to Top

Properties

 

	Name	Description
	Body	Gets or sets the HTTP body
	CertificateValidationCallback	Gets or sets Call-back delegate for custom/test-based validations of Server certificates. Can be used for Server Certificate logging, negative testing etc...
	ClientCertificate	Gets or sets X509 Certificate to use with SSL based communications (If required)
	Domain	Gets or sets the HTTP Domain
	HeaderList	Gets or sets the HTTP Header as a List of name/value pairs
	HeaderString	Gets or sets the HTTP Header as a string
	HTTPMethod	Gets or sets the HTTP Method
	QueryList	Gets or sets the HTTP Query list that is used on top line of HTTP Header
	QueryString	Gets or sets the HTTP Query string that is used on top line of HTTP Header
	ResourcePath	Gets or sets the HTTP Resource Path
	ResponseRaw	Gets raw Response text of HTTP Request. Data is raw HTTP response.
	TryException	Gets last exception thrown in a Try... method.
	UseSSL	Gets or sets a value indicating whether a secure SSL (HTTPS) connection is to be used

  Back to Top

Methods

 

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Http(HTTPBased.HTTPMethods, Boolean)	Sends an HTTP Request with the given request method and set properties then returns response.
	Http(HTTPBased.HTTPMethods, String, String, String, String, String, Boolean)	Sends an HTTP Request with the given request method and parameters
	HttpGET()	Performs an HTTP GET to the required Domain/ResourcePath containing given HTTP Query-string Header and Body (if given)
	HttpGET(String, String, String, String, String)	Performs an HTTP GET to the required Domain/ResourcePath containing given HTTP Query-string Header and Body (if given)
	HttpPOST()	Performs an HTTP POST to the required Domain/ResourcePath containing given HTTP Header and Body
	HttpPOST(String, String, String, String, String)	Performs an HTTP POST to the required Domain/ResourcePath containing given HTTP Header and Body
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryHttp(HTTPBased.HTTPMethods, HTTPBased.ItemList, Boolean)	Sends an HTTP Request with the given request method and set properties then returns response.
	TryHttp(HTTPBased.HTTPMethods, String, String, String, String, String, HTTPBased.ItemList, Boolean)	Sends an HTTP Request with the given request method and parameters
	TryHttpPOST(HTTPBased.ItemList)	Performs an HTTP POST to the required Domain/ResourcePath containing given HTTP Header and Body
	TryHttpPOST(String, String, String, String, HTTPBased.ItemList)	Performs an HTTP POST to the required Domain/ResourcePath containing given HTTP Header and Body

  Back to Top

Remarks

 

Category	Item	Type	Default Value	Comments
TeamControlium.HTTP	SSLPort	int ```</td><td>443</td><td>Port used for SSL tunnelled HTTP (HTTPS) communication</td></tr><tr><td>TeamControlium.HTTP</td><td>HTTPPort</td><td> int ## See Also #### Reference <a href="7c8197c9-2a4b-3073-068f-4bdf12fc0e2c">TeamControlium.NonGUI Namespace</a><br />