jsdav-ext/lib/DAVACL/interfaces/iPrincipal.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) 2013 Mike de Boer. <info AT mikedeboer DOT nl>
 * @author Mike de Boer <info AT mikedeboer DOT nl>
 * @license http://github.com/mikedeboer/jsDAV/blob/master/LICENSE MIT License
 */

"use strict";

var jsDAV_iNode = require("./../../DAV/interfaces/iNode");

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

/**
 * IPrincipal interface
 *
 * Implement this interface to define your own principals
 */
var jsDAVACL_iPrincipal = module.exports = Base.extend(jsDAV_iNode, {
    /**
     * Returns a list of alternative urls for a principal
     *
     * This can for example be an email address, or ldap url.
     *
     * @return array
     */
    getAlternateUriSet: function() { throw Exc.notImplementedYet(); },

    /**
     * Returns the full principal url
     *
     * @return string
     */
    getPrincipalUrl: function() { throw Exc.notImplementedYet(); },

    /**
     * Returns the list of group members
     *
     * If this principal is a group, this function should return
     * all member principal uri's for the group.
     *
     * @return array
     */
    getGroupMemberSet: function(callback) { callback(Exc.notImplementedYet()); },

    /**
     * Returns the list of groups this principal is member of
     *
     * If this principal is a member of a (list of) groups, this function
     * should return a list of principal uri's for it's members.
     *
     * @return array
     */
    getGroupMembership: function(callback) { callback(Exc.notImplementedYet()); },

    /**
     * Sets a list of group members
     *
     * If this principal is a group, this method sets all the group members.
     * The list of members is always overwritten, never appended to.
     *
     * This method should throw an exception if the members could not be set.
     *
     * @param {Array} principals
     * @return void
     */
    setGroupMemberSet: function(principals, callback) { callback(Exc.notImplementedYet()); },

    /**
     * Returns the displayname
     *
     * This should be a human readable name for the principal.
     * If none is available, return the nodename.
     *
     * @return string
     */
    getDisplayName: function() { throw Exc.notImplementedYet(); }
});