Oracle Cloud Object Storage
This snippet provides a function to send IoT data to an Oracle Cloud Object Storage bucket.
Resources used: HTTPS x 1
Details
The send_oracle
function can be used to PUT the passed string 'payload' in a specified 'object' on an Oracle Object Storage bucket using pre-authenticated requests, over HTTPS. The result (error/response) is then passed to the callback function.
To start using this snippet, PAR_URL
(pre-authenticated request URL from the bucket), and CA
are required to be configured by the user.
NOTE: The provided function can handle data sizes up to 4KB. To handle larger data sizes, please refer to divided writing for https objects in the neqto.js documentation.
Click here to learn how to get a CA.
var CA = "-----BEGIN CERTIFICATE-----\n...<CA>...\n-----END CERTIFICATE-----"
//=================================================================
// ORACLE SNIPPET
//=================================================================
//=================================================================
// The following configuration are MANDATORY. Set by user.
//=================================================================
// The address of the Pre-Authenticated Request (PAR) URL from the bucket.
// eg. 'objectstorage.us-phoenix-1.oraclecloud.com/p/j3DoSvgQHbUaw6ADzHkDlnaqMuXWef_lhTxCiS9ngCw/n/docs/b/par-bucket/o/'
var PAR_URL = '<YOUR_PAR-URL>';
// Public certificate of the certificate authority that signed the Oracle server certificate for SSL/TLS handshake.
// eg. '-----BEGIN CERTIFICATE-----\n...<CA>...\n-----END CERTIFICATE-----'
var CA = '<YOUR_CA>';
//=================================================================
/**
* Post data to Oracle Object Storage Bucket using PAR (Pre-Authenticated Request).
* https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm
* @function send_oracle
* @param {string} object - Name of the object/file to be put, as a String.
* @param {string} payload - Data to be sent to Oracle server, as a String.
* @param {function} callback - User callback to return the result (error/response).
* @returns {undefined}
*/
var send_oracle = function (object, payload, callback) {
var body = payload.toString();
var host = PAR_URL.split(/\/(.+)/)[0];
var path = PAR_URL.split(/\/(.+)/)[1];
var options = {
"method": 'PUT',
"host": host,
"path": `/${path}${object}`,
"headers": {
"Content-Length": body.length.toString()
},
"ca": CA
};
var request = https.request(options, function (response) {
response.on('end', function () {
callback(null, { "statusCode": response.statusCode, "statusMessage": response.statusMessage, "body": response.read() });
});
});
request.on('error', function () {
callback({ "errCode": request.errCode }, null);
});
request.end(body.toString(), function () {
print("[request] SUCCESS");
});
}
Function Usage Example
/*
<INSERT ABOVE SNIPPET HERE WITH SET CONFIGURATIONS>
*/
//=================================================================
log.setLevel(-1); //-1:NONE 0:ERROR 1:WARNING 2:DEBUG 3:TRACE
log.printLevel(2); //0:DISABLE 1:LOG 2:CONSOLE 3:BOTH
//=================================================================
// MAIN SCENARIO
//=================================================================
/**
* Callback to fetch error/response from the request.
* @function callback
* @param {object} err - Error returned if the request failed. Has one property - `errCode`.
* @param {object} data - Response returned by a successfully completed request. Has three properties - `statusCode`, `statusMessage`, and `body`.
*/
var callback = function (err, data) {
if (err) {
print("[error]", err.errCode);
} else {
print("[status]", data.statusCode, data.statusMessage);
print("[response]", data.body);
}
}
var object = "folder/file.txt";
var payload = "Hello from NEQTO Device";
send_oracle(object, payload, callback);
The company names and product names mentioned above are registered trademarks or trademarks of their respective companies.
Updated: 2023-04-14