Variable aclConst

acl: {
    ACLToString: ((ac) => string);
    ACLbyCombination: ((ac) => ComboList);
    ACLunion: ((list) => AgentMapUnion);
    adoptACLDefault: ((doc, aclDoc, defaultResource, defaultACLDoc) => Store);
    comboToString: ((byCombo) => string);
    fixIndividualACL: ((item, subjects, log, callbackFunction) => void);
    fixIndividualCardACL: ((person, log, callbackFunction) => void);
    getACL: ((doc, callbackFunction) => void);
    getACLorDefault: ((doc, callbackFunction) => void);
    loadUnionACL: ((subjectList, callbackFunction) => void);
    makeACLGraph: ((kb, x, ac, aclDoc) => void);
    makeACLGraphbyCombo: ((kb, x, byCombo, aclDoc, main?, defa?) => void);
    makeACLString: ((x, ac, aclDoc) => string);
    putACLObject: ((kb, x, ac, aclDoc, callbackFunction) => void);
    putACLbyCombo: ((kb, x, byCombo, aclDoc, callbackFunction) => void);
    readACL: ((doc, aclDoc, kb2?, getDefaults?) => AgentMapMap);
    sameACL: ((a, b) => boolean);
    setACL: ((docURI, aclText, callbackFunction) => void);
} = ...

Type declaration

  • ACLToString: ((ac) => string)
      • (ac): string

      • Debugging short strings for dumping ACL and possibly in the UI

        Parameters

        • ac: AgentMapMap<AgentMap>

        Returns string

  • ACLbyCombination: ((ac) => ComboList)
      • (ac): ComboList

      • Represents these as an RDF graph by combination of modes

        Each agent can only be in one place in this model, one combination of modes. Combos are like full control, read append, read only etc.

        Parameters

        • ac: AgentMapUnion | AgentMapMap<AgentMap>

        Returns ComboList

  • ACLunion: ((list) => AgentMapUnion)
      • (list): AgentMapUnion

      • Union N ACLs

        Parameters

        • list: (AgentMapUnion | AgentMapMap<AgentMap>)[]

        Returns AgentMapUnion

  • adoptACLDefault: ((doc, aclDoc, defaultResource, defaultACLDoc) => Store)
      • (doc, aclDoc, defaultResource, defaultACLDoc): Store

      • Take the "default" ACL and convert it into the equivalent ACL which the resource would have had. Return it as a new separate store. The "defaultForNew" predicate is also accepted, as a deprecated synonym for "default".

        Parameters

        Returns Store

  • comboToString: ((byCombo) => string)
      • (byCombo): string

      • Convert a [[ComboList]] to a string

        Parameters

        • byCombo: ComboList

        Returns string

  • fixIndividualACL: ((item, subjects, log, callbackFunction) => void)
      • (item, subjects, log, callbackFunction): void

      • This function is used by [[fixIndividualCardACL]]

        Parameters

        • item: NamedNode
        • subjects: NamedNode[]
        • log: Function
        • callbackFunction: fixIndividualACLCallback

        Returns void

  • fixIndividualCardACL: ((person, log, callbackFunction) => void)
      • (person, log, callbackFunction): void

      • Fix the ACl for an individual card as a function of the groups it is in

        All group files must be loaded first

        Parameters

        • person: NamedNode
        • log: Function
        • callbackFunction: fixIndividualCardACLCallback

        Returns void

  • getACL: ((doc, callbackFunction) => void)
      • (doc, callbackFunction): void

      • Calls back (ok, status, acldoc, message) as follows

        • (false, 900, errormessage) if no link header
        • (true, 403, documentSymbol, fileaccesserror) if not authorized
        • (true, 404, documentSymbol, fileaccesserror) if does not exist
        • (true, 200, documentSymbol) if file exists and read OK

        Parameters

        • doc: NamedNode
        • callbackFunction: ((ok, messageOrStatus, messageOrDoc?, message?) => void)
            • (ok, messageOrStatus, messageOrDoc?, message?): void

            • Parameters

              • ok: boolean
              • messageOrStatus: string | number
              • Optional messageOrDoc: string | NamedNode
              • Optional message: string

              Returns void

        Returns void

  • getACLorDefault: ((doc, callbackFunction) => void)
      • (doc, callbackFunction): void

      • Get ACL file or default if necessary

        Parameters

        • doc: NamedNode
        • callbackFunction: ((a, b, statusOrMessage, message, c?, d?) => void)

          Will be called in the following ways, in the following cases:

          • callbackFunction(true, true, doc, aclDoc) if the ACL did exist
          • callbackFunction(true, false, doc, aclDoc, defaultHolder, defaultACLDoc) if the ACL file did not exist but a default did
          • callbackFunction(false, false, status, message) when there was an error getting the original
          • callbackFunction(false, true, status, message) when there was an error getting the default
            • (a, b, statusOrMessage, message, c?, d?): void

            • Parameters

              Returns void

        Returns void

  • loadUnionACL: ((subjectList, callbackFunction) => void)
      • (subjectList, callbackFunction): void

      • Merge ACLs lists from things to form union

        Parameters

        • subjectList: NamedNode[]
        • callbackFunction: loadUnionACLCallback

        Returns void

  • makeACLGraph: ((kb, x, ac, aclDoc) => void)
      • (kb, x, ac, aclDoc): void

      • Write ACL graph to store from AC

        Parameters

        Returns void

  • makeACLGraphbyCombo: ((kb, x, byCombo, aclDoc, main?, defa?) => void)
      • (kb, x, byCombo, aclDoc, main?, defa?): void

      • Write ACL graph to store from combo

        Parameters

        Returns void

  • makeACLString: ((x, ac, aclDoc) => string)
      • (x, ac, aclDoc): string

      • Write ACL graph as Turtle

        Parameters

        Returns string

  • putACLObject: ((kb, x, ac, aclDoc, callbackFunction) => void)
      • (kb, x, ac, aclDoc, callbackFunction): void

      • Write ACL graph to web

        Parameters

        • kb: LiveStore
        • x: NamedNode
        • ac: AgentMapUnion | AgentMapMap<AgentMap>
        • aclDoc: NamedNode
        • callbackFunction: ((ok, message?) => void)
            • (ok, message?): void

            • Parameters

              • ok: boolean
              • Optional message: string

              Returns void

        Returns void

  • putACLbyCombo: ((kb, x, byCombo, aclDoc, callbackFunction) => void)
      • (kb, x, byCombo, aclDoc, callbackFunction): void

      • Write ACL graph to web from a [[ComboList]]

        Parameters

        • kb: LiveStore
        • x: NamedNode
        • byCombo: ComboList
        • aclDoc: NamedNode
        • callbackFunction: ((ok, message?) => void)
            • (ok, message?): void

            • Parameters

              • ok: boolean
              • Optional message: string

              Returns void

        Returns void

  • readACL: ((doc, aclDoc, kb2?, getDefaults?) => AgentMapMap)
      • (doc, aclDoc, kb2?, getDefaults?): AgentMapMap

      • Read and canonicalize the ACL for x in aclDoc

        Accumulate the access rights which each agent or class has

        Parameters

        Returns AgentMapMap

  • sameACL: ((a, b) => boolean)
      • (a, b): boolean

      • Compare two ACLs

        Parameters

        • a: AgentMapUnion | AgentMapMap<AgentMap>
        • b: AgentMapUnion | AgentMapMap<AgentMap>

        Returns boolean

  • setACL: ((docURI, aclText, callbackFunction) => void)
      • (docURI, aclText, callbackFunction): void

      • Set an ACL

        Parameters

        • docURI: NamedNode
        • aclText: string
        • callbackFunction: ((ok, message) => void)
            • (ok, message): void

            • Parameters

              • ok: boolean
              • message: string

              Returns void

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc