Synergy source documentation: Class BUserDB

Overview

Package

Class

Tree

Deprecated

Index

Synergy Documentation

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

au.edu.swin.synergy.plugin.userdb
Class BUserDB

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.userdb.BUserDB

public class BUserDB
extends BPlugin

User database.

Field Summary
`protected static String`	`kGroupDBFileName` The file name of the group database
`protected static Long`	`kMinimumID` This is the minimum id for users and groups
`protected static String`	`kUserDBFileName` The file name of the user database

Fields inherited from class au.edu.swin.synergy.kernel.BPlugin

kernel

Constructor Summary
`BUserDB()`

Method Summary
`protected Long`	`getNewID(Hashtable itemHashtable)` This will run through the given hashtable of BPrivileged items and determine the next available unique id assuming that the minimum is kMinimumID Please complete the missing tags for getNewID
`protected Vector`	`getPrivilegedItems(Hashtable database)` Gets all the users in the database and returns them in a Vector
`protected BPrivileged`	`locateItem(Long uniqueID, Hashtable database)` This will run through the user database looking for the user with the given id.
`void`	`onBCommandEvent(Object source, BCommandEvent event)` Any events dispatched by the local kernel will be received through here.
`void`	`setup(BStringList params)` Please complete the missing tags for setup

Methods inherited from class au.edu.swin.synergy.kernel.BPlugin

dispatchEvent, 
dispatchEventAndWait, 
dispatchEventServer, 
dispatchEventServerAndWait, 
dispatchEventTo, 
dispatchEventToAndWait, 
getDependancies, 
getKernel, 
setKernel, 
setup, 
unload

Methods inherited from class java.lang.Object

clone, 
equals, 
finalize, 
getClass, 
hashCode, 
notify, 
notifyAll, 
toString, 
wait, 
wait, 
wait

Field Detail

kGroupDBFileName

protected static final String kGroupDBFileName

The file name of the group database

kUserDBFileName

protected static final String kUserDBFileName

The file name of the user database

kMinimumID

protected static final Long kMinimumID

This is the minimum id for users and groups

Constructor Detail

BUserDB

public BUserDB()

Method Detail

getPrivilegedItems

protected Vector getPrivilegedItems(Hashtable database)

Gets all the users in the database and returns them in a Vector

Returns:: A Vector of BPrivileged objects

setup

public void setup(BStringList params)

Please complete the missing tags for setup

Parameters:: -
Returns:
Throws:: -
Overrides:: setup in class BPlugin
Pre Condition:
Post Condition:

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

Any events dispatched by the local kernel will be received through here. The user database only handles events that extend BUserDBCE.

Parameters:: source - The source of the event; event - The event to handle
Overrides:: onBCommandEvent in class BPlugin

getNewID

protected Long getNewID(Hashtable itemHashtable)

This will run through the given hashtable of BPrivileged items and determine the next available unique id assuming that the minimum is kMinimumID Please complete the missing tags for getNewID

Parameters:: -
Returns:
Pre Condition:
Post Condition:

locateItem

protected BPrivileged locateItem(Long uniqueID,
                                 Hashtable database)

This will run through the user database looking for the user with the given id. When it finds it, it will return it.

Parameters:: userID - The id of the user to locate
Returns:: The user with the given id if they exist, null otherwise Please complete the missing tags for locateItem
Pre Condition:
Post Condition: