Parent topic: The HTTPRequest class
HTTP classes / The HTTPRequest class

com.HTTPRequest methods

Methods for the com.HTTPRequest class.

Table 1. Class methods
Name Description 
com.HTTPRequest.Create(
   url STRING )
  RETURNING result com.HTTPRequest
 Creates an new HTTPRequest object from a URL.
Table 2. Object methods: Configuration methods
Name Description 
clearAuthentication()
 Removes user-defined authentication. 
clearHeaders()
 Removes all user-defined HTTP request headers. 
removeHeader(
   name STRING )
 Removes an HTTP header for the request according to a name. 
setAuthentication(
   login STRING,
   pass STRING,
   scheme STRING,
   realm STRING )
 Defines the user login and password to authenticate to the server. 
setAutoReply(
   reply BOOLEAN )
 Defines the auto reply option for response methods. 
setCharset(
   charset STRING )
 Defines the charset used when sending text or XML. 
setConnectionTimeOut(
   timeout INTEGER )
 Defines the timeout for the establishment of the connection. 
setHeader(
   name STRING,
   value STRING )
 Sets an HTTP header for the request. 
setMethod(
   method STRING )
 Sets the HTTP method of the request. 
setKeepConnection(
   keep BOOLEAN )
 Defines if connection is kept open if a new request occurs. 
setMaximumResponseLength(
   length INTEGER )
 Defines the maximum size in Kbyte of a response. 
setTimeOut(
   timeout INTEGER )
 Defines the timeout for a reading or writing operation. 
setVersion(
   version STRING )
 Sets the HTTP version of the request.
Table 3. Object methods: Sending methods
Name Description 
beginXmlRequest()
  RETURNING writer xml.StaxWriter
 Starts a streaming HTTP request. 
endXmlRequest(
   writer xml.StaxWriter )
 Terminates a streaming HTTP request. 
doDataRequest(
   data BYTE )
 Performs the request by sending binary data. 
doFileRequest(
   filepath STRING )
 Performs the request by sending data contained in a file. 
doFormEncodedRequest(
   query STRING,
   utf8 BOOLEAN )
 Performs an "application/x-www-form-urlencoded forms" encoded query. 
doRequest()
 Performs the HTTP request. 
doTextRequest(
   data STRING )
 Performs the request by sending an entire string at once. 
doXmlRequest(
   data xml.DomDocument )
 Performs the request by sending an entire XML document at once.
Table 4. Object methods : Response methods
Name Description 
getAsyncResponse()
  RETURNING result com.HTTPResponse
 When available, returns the response produced by one of request methods. 
getResponse()
  RETURNING result com.HTTPResponse
 Waits and returns the response produced by one of request methods.
Table 5. Object methods of com.HTTPRequest : Multipart methods
Name Description 
addPart( p com.HTTPPart )
 Adds a new part to the HTTP root part request. 
setMultipartType(
   type STRING,
   start STRING,
   boundary STRING )
 Switch HTTPRequest in multipart mode of given type.
Parent topic: The HTTPRequest class