Component documentation of model acs.cfc

Home » acs.cfc


hierarchy: WEB-INF.cftags.component
      mgrnd.doc.acs.awt.model.acs
path: /opt/apache2/htdocs/mgrnd/doc/acs/awt/model/acs.cfc
properties:  
methods: AddGroup, AddUser, CullACS, DeleteEvent, DeleteGroup, DeleteUser, EditGroup, EditUser, GetACSEventList, GetEventList, getGroupNameByID, getGroups, GetIgnoreList, getUserByID, getUsers, GroupDependencyCheck, init, isAllowed, JReadByLine, Link, login, logout, PutBack, reload, SanitizeGroup, SanitizeUser, SetEvents, SetPrivileges
* - private method

AddGroup
boolean AddGroup ( required struct formdata )

add a new group

Output: enabled
Parameters:
   formdata: struct, required, formdata - structure containing form data

AddUser
boolean AddUser ( required struct formdata )

add a user

Output: enabled
Parameters:
   formdata: struct, required, formdata - structure containing form data

CullACS
boolean CullACS ( )

culls deleted events from access control list

Output: enabled

DeleteEvent
boolean DeleteEvent ( required string event )

removes an event from the privilege list(make public)

Output: enabled
Parameters:
   event: string, required, event - name of event to delete

DeleteGroup
boolean DeleteGroup ( required numeric id )

Delete a group

Output: enabled
Parameters:
   id: numeric, required, id - id of group to delete

DeleteUser
boolean DeleteUser ( required numeric id )

Delete a user

Output: enabled
Parameters:
   id: numeric, required, id - id of user to delete

EditGroup
boolean EditGroup ( required struct formdata )

edit group details

Output: enabled
Parameters:
   formdata: struct, required, formdata - formdata of group to edit

EditUser
boolean EditUser ( required struct formdata )

edit user details

Output: enabled
Parameters:
   formdata: struct, required, formdata - formdata of user to edit

GetACSEventList
array GetACSEventList ( )

gets a list of ACS controlled events and their group privileges

Output: enabled

GetEventList
Array GetEventList ( )

get events from ModelGlue.xml NOT covered by ACS map

Output: enabled

getGroupNameByID
String getGroupNameByID ( required string id )

gets a group

Output: enabled
Parameters:
   id: string, required, id - ID of group

getGroups
Array getGroups ( )

gets a list of all groups

Output: enabled

GetIgnoreList
string GetIgnoreList ( )

accessor method for event list to bypass access control

Output: enabled

getUserByID
String getUserByID ( required string id )

gets a user

Output: enabled
Parameters:
   id: string, required, id - ID of user

getUsers
Array getUsers ( )

gets a list of all users

Output: enabled

GroupDependencyCheck
array GroupDependencyCheck ( required numeric id )

check to if a group has dependencies

Output: enabled
Parameters:
   id: numeric, required, id - id of group to check

init
Any init ( required string mapfile="/opt/bitnami/apache2/htdocs/awt/model/data/map.cfg", required string userfile="/opt/bitnami/apache2/htdocs/awt/model/data/users.cfg", required string groupfile="/opt/bitnami/apache2/htdocs/awt/model/data/groups.cfg" )

Initialises access control and returns an access map object

Output: enabled
Parameters:
   mapfile: string, required, mapfile
   userfile: string, required, userfile
   groupfile: string, required, groupfile

isAllowed
boolean isAllowed ( required string event_handler, string group="-1" )

Checks to see if requesting group can access function

Output: enabled
Parameters:
   event_handler: string, required, event_handler - name of event handler to check
   group: string, optional, group - group id to check

JReadByLine
package Any JReadByLine ( required string filename )

java based line by line file reader utility

Output: enabled
Parameters:
   filename: string, required, filename - file to read

Link
string Link ( required string event_name, required string text, required numeric gid, string class="", string baselink="index.cfm?event=" )

renders a styled link to destination if ACL permits

Output: enabled
Parameters:
   event_name: string, required, event_name - Name of event to link to
   text: string, required, text - Text description of link
   gid: numeric, required, gid - Group ID of logged in user
   class: string, optional, class - Optional CSS decorator class
   baselink: string, optional, baselink - base default MG index page

login
any login ( required string username, required string userpass, boolean passtype="false" )

process login credentials

Output: enabled
Parameters:
   username: string, required, username - User name
   userpass: string, required, userpass - Password
   passtype: boolean, optional, passtype - Password is pre-encrypted?

logout
void logout ( )

delete current login session

Output: enabled

PutBack
package boolean PutBack ( required string filename, required array filedata, required string fileschema )

re-creates file after array management

Output: enabled
Parameters:
   filename: string, required, filename - filename of file to rebuild
   filedata: array, required, filedata - data from which to rebuild file
   fileschema: string, required, fileschema - comma delimited list of data column names

reload
void reload ( )

reload ACL into application scope

Output: enabled

SanitizeGroup
string SanitizeGroup ( any event )

error check group object

Output: enabled
Parameters:
   event: any, optional, event

SanitizeUser
string SanitizeUser ( any event )

error check user object

Output: enabled
Parameters:
   event: any, optional, event

SetEvents
boolean SetEvents ( boolean allgroups="false" )

sets new events in ACL

Output: enabled
Parameters:
   allgroups: boolean, optional, allgroups - set true to set privileges for ALL groups

SetPrivileges
boolean SetPrivileges ( required struct formdata )

sets privileges for group

Output: enabled
Parameters:
   formdata: struct, required, formdata - reference to current event data