Skip to end of metadata
Go to start of metadata



Return Types
Cookie DeleteRequest GetRequest HTTP_STATUS HeadRequest HttpClient OptionsRequest PostRequest PutRequest Response TraceRequest



Method Summary
HttpClient createNewHttpClient()
Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.
byte[] getMediaData(url)
Get media (binary data) such as images in a variable.
String getPageData(url)
Get all page html in a variable, if this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)



Method Details

createNewHttpClient

HttpClient createNewHttpClient ()
Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.

Returns

Sample

var client = plugins.http.createNewHttpClient();
 

getMediaData

byte[] getMediaData (url)
Get media (binary data) such as images in a variable. It also supports gzip-ed content.
If this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)

Parameters

{String} url

Returns

byte[]

Sample

var image_byte_array = plugins.http.getMediaData('http://www.cnn.com/cnn.gif');
 

getPageData

String getPageData (url)
Get all page html in a variable, if this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)

Parameters

{String} url

Returns

Sample

// get data using a default connection
var pageData = plugins.http.getPageData('http://www.cnn.com');
 



  • No labels

1 Comment

  1. Anonymous

    no info about the setting: setTimeout //Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).
    plugins.http.setTimeout(1000,'client_name')
    //Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).

    plugins.http.setTimeout(1000,'client_name')