HTTP class

Constructs a new HTTP object. The connection type (HTTP or HTTPS) is automatically detected based on the URL scheme.

var theHTTP = new HTTP();

Contains the URL to be used for request. The URL must be URI-encoded. The method HTTP.encodeURI() can be used to encode the URL.

theHTTP.url = “https://api.dropbox.com/1/fileops/delete”;

The URL must specify the protocol to be used (http:// or https://).

This property specifies if MIME encoding should be used (as specified in RFC1867).

This property will tell the class which type of authorization to perform when the user and password properties are set.

theHTTP.authScheme = HTTP.OauthAuth;

If the authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys authorization information to the server. A common use for this property is to specify the OAuth authorization string.

The authScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), the user and password are automatically Base64 encoded by Switch, and the result in the form "Basic [encoded-user-password]" is used for authorization.

theHTTP.authorization = “authorization string”;              

This property contains a password if authentication is to be used.

theHTTP.password = “password1”;         

The path to a local file that the server response is written to. This can be the file or document being downloaded, JSON or XML data or whatever the server has responded with. If the server responded with an error, the file will not be created or it will be empty.

If this property is not specified, the server response can be obtained as byte array using the getServerResponse() method.

theHTTP.localFilePath = job.createPathWithExtension( ”pdf”, false );       

If the timeOut property is set to "0", all operations will run uninterrupted until successful completion or until an error condition is encountered.

If timeOut is set to a positive value, the class will wait for the operation to complete and if timeOut expires before the operation is complete, the class fails with an error.

The default value for the timeOut property is "60" (seconds).

This property specifies if a proxy server should be used.

If a proxy proxyServer is given, the HTTP request is sent to the proxy instead of the server specified in the url property.

If the proxyServer property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the corresponding address is used for sending the HTTP request. If the search is not successful, an error is returned.

This property contains the TCP port for the proxy server (default: 80).

This property contains a password if authentication is to be used for the proxy.

This property contains the HTTP version from the first line of the last server response. The HTTP protocol specifies the structure of this line as: [HTTP version] [Status Code] [Description].

This property is read-only and becomes available after the HTTP request is finished.

This property contains the Status Code from the first line of the last server response. The HTTP protocol specifies the structure of this line as: [HTTP version] [Status Code] [Description]. For the list of HTTP status codes, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.

This property is read-only and becomes available after the HTTP request is finished.

This property contains the Description from the first line of the last server response. The HTTP protocol specifies the structure of this line as: [HTTP version] [Status Code] [Description].

This property is read-only and becomes available after the HTTP request is finished.

This property contains the last error string.

This property is read-only and becomes available after the HTTP request is finished.

Note that when finishedStatus returns “Ok” it does not automatically mean that the request yielded the desired result. The URL provided could have been redirected to another URL. In such a case the HTTP exchange with the server was successful, but nothing happened. It is therefore advisable to also read the properties statusCode and statusDescription to get more details about the completed request. In case of failed status, the lastError property should provide more details about the problem.

if( theHTTP.finishedStatus == HTTP.Failed )
{      
      job.fail( ”The request failed: %1”, theHTTP.lastError );
      return;
}

Relevant only for GET request. If set to true, Switch will try to resume the interrupted/broken download if possible. The files containing not finished downloads are stored in the folder defined by the tempFolderPath property.

Relevant only for GET request. This property defines a folder where not finished downloads are stored.

By default this property is empty. In case resumeEnabled is set to true, this property must be set as well. It should contain a folder path pointing to an existing writable folder. Switch does not clean up this folder automatically; it removes the files containing not finished downloads after they are completed by some future request.

Relevant only for HEAD and GET requests. This property determines what happens when the server issues a redirect. If this property is set to false, the HTTP call returns an error if the server responds with an "Object Moved" message (HTTP status codes in the 300 range). If this property is set to true (default), the new URL for the object is retrieved automatically.

This function encodes inURI by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character. It assumes that the URI is a complete URI, so it does not encode reserved characters that have special meaning in the URI. It replaces all characters except the following: alphabetic, decimal digits, - _ . ! ~ * ' ( ) ; , / ? : @ & = + $ #

This function decodes inURI by replacing each escape sequence in the encoded URI with the character that it represents.

This function encodes inURIComponent by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.

It replaces all characters except the following: alphabetic, decimal digits, - _ . ! ~ * ' ( )

This function decodes inURIcomponent by replacing each escape sequence in the encoded URI component with the character that it represents.

Sets the path to the file that is appended to the HTTP request, if the HTTP POST or PUT methods are used (through the post() or put() methods). The second argument is optional. It is taken into account only when POST request is sent and MIME encoding is enabled. It specifies the name of the HTTP form data variable that is used by the receiving HTTP server to identify the correct file part of the uploaded MIME package. If this argument is omitted, the default value "file" will be used.

theHTTP.setAttachedFile( job.getPath() );

Warning:

In case of a POST request with MIME encoding enabled, this call identifies the MIME part by adding the following MIME part header:

Content-Disposition: form-data; filename=“name of the file that is being attached”; name=“second parameter”

var tmpFile = job.createPathWithName(job.getName());
if(!s.copy(job.getPath(), tmpFile))
{
   job.fail( "Could not copy the job to the temporary location: %1", tmpFile );
   return;
}
theHTTP.setAttachedFile(tmpFile);

Adds parameters to the HTTP request.

• For the POST and PUT requests, the parameters are included into the HTTP request after the HTTP headers.
• For the HEAD and GET requests, the parameters are appended to the URL after ‘?’; when calling a REST API it is common to use URLs that look like this: http://www.xyz.com/updatedatabase?key1=value1&key2=value2. The HTTPS protocol encrypts everything after the ‘?’.
• For DELETE requests, the parameters are ignored.

theHTTP.resetParameters();

• If there are no addParameter() calls in the script, the "Content-Type" is missing. In this case addHeader( "Content-Type",... ) adds the required header in the request.
• If there is an addParameter() call in the script, the "Content-Type" is automatically set to "application/x-www-form-urlencoded". Calling addHeader( "Content-Type",... ) does not change it.

theHTTP.post();

theHTTP.put();

theHTTP.head();

theHTTP.get();

theHTTP.del();

Returns the progress (in percent) of the current request. This method should be used in combination with the waitForFinished() method.

var theNames = theHTTP.getHeaderNames();

Returns the byte array containing the HTTP header content. If the header is missing, the empty byte array is returned.

var theValue = theHTTP.getHeaderValue( HTTP.ContentDisposition );
job.log( 1, "Content-Disposition: %1", theValue.toString("ISO 8859-1") );
theValue = theHTTP.getHeaderValue( “Cache-Control” );
job.log( 1, "Cache-Control: %1", theValue.toString("ISO 8859-1") );

theHTTP.addHeader( ”x-metadata”, ”size=12345; path=/” );
theHTTP.addHeader( ”userlogin”, ”OK” );

Interrupts the current request to the server.

theHTTP.interrupt();

Appends a body to the HTTP Post and Put requests after the HTTP headers.

function jobArrived( s : Switch, job : Job )
{
  var theHTTP = new HTTP( HTTP.NoSSL );
  theHTTP.url = "http://httpbin.org/post";

  var postBody = new ByteArray("{\"key\":\"value\"}", "UTF-8");
  theHTTP.setPostData( postBody,"application/json" );

  var theResponseFilePath = job.createPathWithName( job.getNameProper(), false );
  theHTTP.localFilePath = theResponseFilePath;
  theHTTP.post();
  while( !theHTTP.waitForFinished( 3 ) ) { }
  job.log( 1, "Request finish status: %1", theHTTP.finishedStatus );
  job.sendToSingle(theResponseFilePath) ;
}

function jobArrived( s : Switch, job : Job )
{
  var theHTTP = new HTTP( HTTP.SSL ); 

  theHTTP.authScheme = HTTP.OauthAuth;
  theHTTP.authorization = "authorization string";
  theHTTP.setAttachedFile( job.getPath() );
  theHTTP.url = "https://api-content.dropbox.com/1/files_put/auto/Test.pdf"; 

  theHTTP.post(); 

  job.log( 4, "Upload started", 100);
  while( !theHTTP.waitForFinished( 3 ) )
  {
  job.log( 5, "Uploading...", theHTTP.progress() );
  }
  job.log( 6, "Upload finished" ); 
  job.log( 1, "Server response: %1", theHTTP.getServerResponse().toString( "UTF-8" ) );
  if( theHTTP.finishedStatus == HTTP.Ok && theHTTP.statusCode == 200 )
  {
      job.log( 1, "Upload completed successfully" );
  }
  else
  {
      job.fail( "Upload failed with the status code %1", theHTTP.statusCode );
      return;
  }
  job.sendToSingle( job.getPath() );
}

function jobArrived( s : Switch, job : Job )
{
  var theHTTP = new HTTP( HTTP.SSL ); 

  theHTTP.authScheme = HTTP.OauthAuth;
  theHTTP.authorization = "authorization string";
  theHTTP.url = "https://api-content.dropbox.com/1/files/auto/Test.pdf";
  theHTTP.localFilePath = job.createPathWithExtension( "pdf", false ); 

  theHTTP.get(); 

  job.log( 4, "Download started", 100 );
  while( !theHTTP.waitForFinished( 3 ) )
  {
      job.log( 5, "Downloading...", theHTTP.progress() );
  }
  job.log( 6, "Download finished" ); 

  if( theHTTP.finishedStatus == HTTP.Ok && theHTTP.statusCode == 200
          && File.exists( theHTTP.localFilePath ) )
  {
      job.log( 1, "Download completed successfully" );
      job.sendToSingle( theHTTP.localFilePath );
  }
  else
  {
      job.fail( "Download failed with the status code %1", theHTTP.statusCode );
      return;
   }
   job.sendToNull( job.getPath() );
}

function jobArrived( s : Switch, job : Job )
{
  var theHTTP = new HTTP( HTTP.SSL ); 

  theHTTP.authScheme = HTTP.OauthAuth;
  theHTTP.authorization = "authorization string";
  theHTTP.url = "https://api.dropbox.com/1/fileops/delete";
  theHTTP.addParameter( "root", "auto" );
  theHTTP.addParameter( "path", "Test.pdf" );

  theHTTP.get(); 

  while( !theHTTP.waitForFinished( 3 ) )
  {
        job.log( 1, "Delete in progress" );
  } 

  job.log( 1, "Server response: %1", theHTTP.getServerResponse().toString( "UTF-8" ) );

  if( theHTTP.finishedStatus == HTTP.Ok && theHTTP.statusCode == 200 )
  {
        job.log( 1, "Delete completed successfully" );
  }
  else
  {     job.fail( "Delete failed with the status code %1", theHTTP.statusCode );
        return;
  }
  job.sendToSingle( job.getPath() );
}

function jobArrived( s : Switch, job : Job )
{
  var theHTTP = new HTTP( HTTP.NoSSL );
  theHTTP.url = "http://httpbin.org/put";
  theHTTP.authScheme = HTTP.NoneAuth;
  theHTTP.setAttachedFile( job.getPath() );
  var theResponseFilePath = job.createPathWithName( job.getNameProper(), false );
  theHTTP.localFilePath =	theResponseFilePath;
  theHTTP.addHeader( "Content-Type", "application/json" );
	
  theHTTP.put();
  while( !theHTTP.waitForFinished( 3 ) ) { }

  job.log( 1, "Request finish status: %1", theHTTP.finishedStatus );

  job.sendToSingle( theResponseFilePath );
}        

theHTTP.authScheme = HTTP.OauthAuth; 
theHTTP.authorization = "Bearer " + theAccessToken; 

This is the full example of the script code to upload and then delete from Google Drive:

function ErrorExists( inMessage : String ) : bool
{
	var theError = inMessage.find( "error" );
	
	return theError >= 0;
}

function RefreshToken( job : Job ) : String
{
	var theHTTP = new HTTP( HTTP.SSL );
	
	theHTTP.addParameter( "refresh_token", "REFRESH_TOKEN" );
	theHTTP.addParameter( "client_id", "CLIENT_ID" );
	theHTTP.addParameter( "client_secret", "CLIENT_SECRET" );
	theHTTP.addParameter( "grant_type", "refresh_token" );
	
	theHTTP.url = "https://accounts.google.com/o/oauth2/token";
	
	theHTTP.post();
	
	while( !theHTTP.waitForFinished( 3 ) )
	{
		job.log( 1, "Refresh token in progress" );
	}
	
	var theFinishedStatus = theHTTP.finishedStatus; // Statuses: Ok, Failed, Interrupted
	var theServerResponse = theHTTP.getServerResponse().toString();
	
	if( theFinishedStatus == HTTP.Ok && !ErrorExists( theServerResponse ) )
	{		
		var theNewTokenWithQuotes = theServerResponse.split( "," )[0].split( ":" )[1];
		var theNewToken = theNewTokenWithQuotes.substring( 2, theNewTokenWithQuotes.length - 1 );
		
		job.log( 1, "The new token with quotes: %1", theNewTokenWithQuotes );
		job.log( 1, "The new token: %1", theNewToken );
		job.log( 1, "Refresh token is successfully" );
		
		return theNewToken;
	}
	else if( theFinishedStatus == HTTP.Failed || ErrorExists( theServerResponse ) )
	{	
		job.log( 1, "Server response: %1", theServerResponse );
		job.log( 3, "Refresh token failed with the error: %1", theHTTP.lastError );
	}
	else
	{
		job.log( 2, "Unknown error" );
	}
}

function jobArrived( s : Switch, job : Job )
{
	var NewAccessToken = RefreshToken( job );
	
	var theHTTP = new HTTP( HTTP.SSL );
	
	theHTTP.authScheme = HTTP.OauthAuth;
	theHTTP.authorization = "Bearer " + NewAccessToken;	
	theHTTP.setAttachedFile( job.getPath() );
	theHTTP.url = "https://www.googleapis.com/upload/drive/v2/files";
	
	// send file to Google Drive
	theHTTP.post();
	
	while( !theHTTP.waitForFinished( 3 ) )
	{
		job.log( 1, "Upload file to Google Drive in progress" );
	}
	
	var theFinishedStatus = theHTTP.finishedStatus;
	var theServerResponse = theHTTP.getServerResponse().toString();
	
	if( theFinishedStatus == HTTP.Ok && !ErrorExists( theServerResponse ) )
	{
		job.log( 1, "Server response: %1", theServerResponse );
		job.log( 1, "Upload file to Google Drive completed successfully" );
	}
	else if( theFinishedStatus == HTTP.Failed || ErrorExists( theServerResponse ) )
	{	
		job.log( 1, "Server response: %1", theServerResponse );
		job.log( 3, "Upload file to Google Drive failed with the error: %1", theHTTP.lastError );
	}
	else
	{
		job.log( 2, "Unknown error" );
	}
	
	// get file ID
	var theFileIdWithQuotes = theServerResponse.split( "," )[1].split( ":" )[1];
	var theFileId = theFileIdWithQuotes.substring( 2, theFileIdWithQuotes.length - 1 );
	
	theHTTP.url = "https://www.googleapis.com/drive/v2/files/" + theFileId;
	
	// delete file from Google Drive by fileId
	theHTTP.del();
	
	while( !theHTTP.waitForFinished( 3 ) )
	{
		job.log( 1, "Delete file from Google Drive in progress" );
	}
	
	theFinishedStatus = theHTTP.finishedStatus;
	theServerResponse = theHTTP.getServerResponse().toString();
	
	if( theFinishedStatus == HTTP.Ok && !ErrorExists( theServerResponse ) )
	{
		job.log( 1, "Delete file from Google Drive is successfully" );
		
		job.sendToSingle( job.getPath() );
	}
	else if( theFinishedStatus == HTTP.Failed || ErrorExists( theServerResponse ) )
	{	
		job.log( 1, "Server response: %1", theServerResponse );
		job.log( 3, "Delete file from Google Drive failed with the error: %1", theHTTP.lastError );
	}
	else
	{
		job.log( 2, "Unknown error" );
	}
}