jsdav-ext/lib/DAV/file.js

jsDAV allows you to easily add WebDAV support to a NodeJS application. jsDAV is meant to cover the entire standard, and attempts to allow integration using an easy to understand API.

/*
 * @package jsDAV
 * @subpackage DAV
 * @copyright Copyright(c) 2011 Ajax.org B.V. <info AT ajax DOT org>
 * @author Mike de Boer <info AT mikedeboer DOT nl>
 * @license http://github.com/mikedeboer/jsDAV/blob/master/LICENSE MIT License
 */

"use strict";

var jsDAV_Node = require("./node");
var jsDAV_iFile = require("./interfaces/iFile");

var Exc = require("./../shared/exceptions");

/**
 * File class
 *
 * This is a helper class, that should aid in getting file classes setup.
 * Most of its methods are implemented, and throw permission denied exceptions
 */
var jsDAV_File = module.exports = jsDAV_Node.extend(jsDAV_iFile, {
    /**
     * Updates the data
     *
     * data is a readable stream resource.
     *
     * @param resource data
     * @return void
     */
    put: function(data, cbfileputabs) {
        cbfileputabs(
            new Exc.Forbidden("Permission denied to change data")
        );
    },

    /**
     * Returns the data
     *
     * This method may either return a string or a readable stream resource
     *
     * @return mixed
     */
    get: function(cbfilegetabs) {
        cbfilegetabs(
            new Exc.Forbidden("Permission denied to read this file")
        );
    },

    /**
     * Returns the size of the file, in bytes.
     *
     * @return int
     */
    getSize: function(cbfilegetsizeabs) {
        cbfilegetsizeabs(null, 0);
    },

    /**
     * Returns the ETag for a file
     *
     * An ETag is a unique identifier representing the current version of the file. If the file changes, the ETag MUST change.
     *
     * Return null if the ETag can not effectively be determined
     */
    getETag: function(cbfilegetetagabs) {
        cbfilegetetagabs(null, null);
    },

    /**
     * Returns the mime-type for a file
     *
     * If null is returned, we'll assume application/octet-stream
     */
    getContentType: function(cbfilegetctabs) {
        cbfilegetctabs(null, null);
    }
});