Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
A
C
D
E
F
G
I
L
M
N
P
R
S
T
U
V
A
AccessDeniedException
- exception cnrg.itx.ds.
AccessDeniedException
.
This class represents an access-denied exception thrown by the directory service.
AccessDeniedException(String)
- Constructor for class cnrg.itx.ds.
AccessDeniedException
Constructor
add(byte[])
- Method in class cnrg.itx.ds.
ArrayRecords
Add a new element to the end of the list
add(Location)
- Method in class cnrg.itx.ds.
LocationList
Add a new element to the end of the list
add(LocationList)
- Method in class cnrg.itx.ds.
LocationList
Add the given location list to the end of the list
add(String)
- Method in class cnrg.itx.ds.
ArrayRecords
Add a new element to the end of the list
addCustomLocation(CustomLocation)
- Method in class cnrg.itx.ds.
DirectoryService
Adds the custom location list of the user authenticated with this directory service
addRecord(byte[], byte[])
- Method in class cnrg.itx.ds.
DSComm
Add an record associated with the domain entry
addRecord(byte[], byte[])
- Method in class cnrg.itx.ds.
CStub
addUser(UserID, Digits, Password, int, String)
- Method in class cnrg.itx.ds.
DirectoryService
Adds a new user into the directory database based on an input extension number.
addUser(UserID, int, Password, int, String)
- Method in class cnrg.itx.ds.
DirectoryService
Adds a new user into the directory database.
ADM_ACCESS_LEVEL
- Static variable in class cnrg.itx.ds.
DirectoryService
ArrayRecords
- class cnrg.itx.ds.
ArrayRecords
.
This class is used to hold returned record entries from the directory database
ArrayRecords()
- Constructor for class cnrg.itx.ds.
ArrayRecords
Default constructor
AuthenticationException
- exception cnrg.itx.ds.
AuthenticationException
.
This class represents an authentication exception thrown by the directory service.
AuthenticationException(String)
- Constructor for class cnrg.itx.ds.
AuthenticationException
Constructor
C
cnrg.itx.ds
- package cnrg.itx.ds
Provides classes and interfaces for the directory "lookup"services.
count()
- Method in class cnrg.itx.ds.
LocationList
Get the number of elements.
count()
- Method in class cnrg.itx.ds.
Digits
Count the number of digits in this digits object
count()
- Method in class cnrg.itx.ds.
ArrayRecords
Get the number of elements.
CStub
- class cnrg.itx.ds.
CStub
.
This class is an inteface to the java native methods talking to the directory server.
CStub()
- Constructor for class cnrg.itx.ds.
CStub
currentValid()
- Method in class cnrg.itx.ds.
CustomLocation
Check if this custom location object is currently valid for use
CustomLocation
- class cnrg.itx.ds.
CustomLocation
.
This class represents a list of locations with user-specified time interval.
CustomLocation(Calendar, Calendar, LocationList)
- Constructor for class cnrg.itx.ds.
CustomLocation
Constructor
CustomLocation(String)
- Constructor for class cnrg.itx.ds.
CustomLocation
Constructor for formatted entry string retrieved from the directory database.
CustomLocationRecord
- class cnrg.itx.ds.
CustomLocationRecord
.
This class is used to hold customLocationID-customLocation pair retrieved from the directory server.
CustomLocationRecord(String, CustomLocation)
- Constructor for class cnrg.itx.ds.
CustomLocationRecord
Constructor for ID and customLocation
D
declareIdentity(UserID, Password)
- Method in class cnrg.itx.ds.
DirectoryService
Authenticate this directory service with the ID and corresponding PIN of the client BEFORE calling any methods.
Client only needs to call this method once.
DEFAULT
- Static variable in class cnrg.itx.ds.
Location
deleteCustomLocation(String)
- Method in class cnrg.itx.ds.
DirectoryService
Deletes the custom location of the user authenticated with this directory service
deleteRecord(byte[], byte[])
- Method in class cnrg.itx.ds.
DSComm
Delete a record (or all records) associated with the domain entry
deleteRecord(byte[], byte[])
- Method in class cnrg.itx.ds.
CStub
Digits
- class cnrg.itx.ds.
Digits
.
This class provides an abstraction to digits
Digits(int)
- Constructor for class cnrg.itx.ds.
Digits
Constructor for integer.
Digits(int[])
- Constructor for class cnrg.itx.ds.
Digits
Constructor for integer array
Digits(String)
- Constructor for class cnrg.itx.ds.
Digits
Constructor for string of digits.
DirectoryService
- class cnrg.itx.ds.
DirectoryService
.
This class provides clients an interface to communicate with the directory server.
DirectoryService()
- Constructor for class cnrg.itx.ds.
DirectoryService
Default constructor
NOTE: It also sets up where to find the config file.
DirectoryService(DSComm)
- Constructor for class cnrg.itx.ds.
DirectoryService
Constructor for a given DSComm-derived object.
DirectoryService(String)
- Constructor for class cnrg.itx.ds.
DirectoryService
Constructor for a given config file path to locate the config file.
DirectoryService(String, DSComm)
- Constructor for class cnrg.itx.ds.
DirectoryService
Constructor for a given config file path to locate the config file and a given DSComm-derived object.
DirectoryServiceException
- exception cnrg.itx.ds.
DirectoryServiceException
.
This base class represents an exception thrown by the directory service.
DirectoryServiceException(String)
- Constructor for class cnrg.itx.ds.
DirectoryServiceException
Constructor
DSComm
- class cnrg.itx.ds.
DSComm
.
This class is an inteface to the java native methods talking to the directory server.
DSComm()
- Constructor for class cnrg.itx.ds.
DSComm
dumpAllUsers()
- Method in class cnrg.itx.ds.
DirectoryService
Dump all users' records from the directory database to the terminal output.
DYNAMIC
- Static variable in class cnrg.itx.ds.
Location
E
enumerateValue()
- Method in class cnrg.itx.ds.
Location
Parses the value of location into a array of string and returns
e.g.
equals(Digits)
- Method in class cnrg.itx.ds.
Digits
Compare with other digits instance to determine if they are identical
F
first()
- Method in class cnrg.itx.ds.
LocationList
Get the first element (also Reset to the first element position)
first()
- Method in class cnrg.itx.ds.
ArrayRecords
Get the first element (also Reset to the first element position)
G
getAccessLevel()
- Method in class cnrg.itx.ds.
DirectoryService
Get the access level of the user authenticated with this directory service
getArray()
- Method in class cnrg.itx.ds.
Digits
Returns itself represented as an array of int
getAt(int)
- Method in class cnrg.itx.ds.
LocationList
Get the element at a particular position (zero-based index)
getCustomLocation()
- Method in class cnrg.itx.ds.
CustomLocationRecord
Gets the custom location
getCustomLocationByExtension(Digits)
- Method in class cnrg.itx.ds.
DirectoryService
Gets all custom locations of the user authenticated with this directory service
getCustomLocDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing customLocation entries
getCustomMessage()
- Method in class cnrg.itx.ds.
UserProperty
Gets custom message
getCustomMessage()
- Method in class cnrg.itx.ds.
DirectoryService
Get the custom message of the user authenticated with this directory service
getDefaultLocationByExtension(Digits)
- Method in class cnrg.itx.ds.
DirectoryService
Gets all default locations of the user authenticated with this directory service
getEndTime()
- Method in class cnrg.itx.ds.
CustomLocation
Get EndTime
getExt2CustomLocListDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing extension-to-customLocationList entries
getExt2DefaultLocListDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing extension-to-defaultLocationList entries
getExt2DynamicLocListDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing extension-to-dynamicLocationList entries
getExt2RoamLocDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing extension-to-roamingLocation entries
getExt2UserDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing extension-to-userRecord entries
getExtDistribDomain(int)
- Method in class cnrg.itx.ds.
DSComm
Gets directory database doamin for storing extension distribution entries.
getExtension()
- Method in class cnrg.itx.ds.
UserProperty
Gets extension field
getExtension()
- Method in class cnrg.itx.ds.
DirectoryService
Get the Extension of the user authenticated with this directory service
getExtension(UserID)
- Method in class cnrg.itx.ds.
DirectoryService
Get the extension from a given UserID
getGatewayUserID()
- Method in class cnrg.itx.ds.
DSComm
Gets the gatewaysrv username in the ITX network
getID()
- Method in class cnrg.itx.ds.
CustomLocationRecord
Gets the ID of the custom location
getID()
- Method in class cnrg.itx.ds.
DirectoryService
Get the ID of the user authenticated with this directory service
getID(Digits)
- Method in class cnrg.itx.ds.
DirectoryService
Get the UserID from a given extension
getIP()
- Method in class cnrg.itx.ds.
Location
Return the hostname address if this location can be directly dialed.
getLabel()
- Method in class cnrg.itx.ds.
Location
Get the Location (optional) label
getLocationList()
- Method in class cnrg.itx.ds.
CustomLocation
Get Location list
getLocationListByExtension(Digits)
- Method in class cnrg.itx.ds.
DirectoryService
Get the location list from a given extension
getLocationListByID(UserID)
- Method in class cnrg.itx.ds.
DirectoryService
Get the location list from a given UserID.
getMaxSubDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets largest sub-domain index of the extension distribution domain
getMinSubDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets lowest sub-domain index of the extension distribution domain
getPort()
- Method in class cnrg.itx.ds.
Location
Return the port number if this location can be directly dialed.
getRecord(byte[])
- Method in class cnrg.itx.ds.
DSComm
Get record(s) associated with the domain entry.
getRecord(byte[])
- Method in class cnrg.itx.ds.
CStub
getRoamingLocation()
- Method in class cnrg.itx.ds.
UserProperty
Gets roaming location object (if any)
getStartTime()
- Method in class cnrg.itx.ds.
CustomLocation
Get StartTime
getType()
- Method in class cnrg.itx.ds.
Location
Get the Location type
getUID()
- Method in class cnrg.itx.ds.
Location
Return the UID of this user-type location (if this is a internet-type location, returns null).
getUserID()
- Method in class cnrg.itx.ds.
UserProperty
Gets userID field
getUserID2ExtDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing userid-to-extension entries
getUserID2SecDomain()
- Method in class cnrg.itx.ds.
DSComm
Gets directory database domain for storing userid-to-extension entries.
getValue()
- Method in class cnrg.itx.ds.
Digits
Get the digits value
getValue()
- Method in class cnrg.itx.ds.
Location
Get the Location value
I
INTERNET_TYPE
- Static variable in class cnrg.itx.ds.
Location
isDialable()
- Method in class cnrg.itx.ds.
Location
Determine if this location can be directly dialed (connected)
isPhone()
- Method in class cnrg.itx.ds.
Location
Determine if the Location is destined to the telephone end
isSameAs(Location)
- Method in class cnrg.itx.ds.
Location
Compares with other location object to determine if they are identical
L
Location
- class cnrg.itx.ds.
Location
.
This class provides a abstraction of where the application or system is located.
Location(Location)
- Constructor for class cnrg.itx.ds.
Location
Copy constructor
Location(String)
- Constructor for class cnrg.itx.ds.
Location
Constructor for formatted record string retrieved from the directory database.
Location(String, String, String)
- Constructor for class cnrg.itx.ds.
Location
Constructor
For telephone: type = Location.TELEPHONE_TYPE; value = Areacode-PhoneNumber; label = "home"
e.g.
LocationList
- class cnrg.itx.ds.
LocationList
.
This class represents a list of locations.
LocationList()
- Constructor for class cnrg.itx.ds.
LocationList
Default constructor
LocationList(LocationList)
- Constructor for class cnrg.itx.ds.
LocationList
Copy constructor
M
MAX_EXTENSION_SIZE
- Static variable in class cnrg.itx.ds.
DirectoryService
MIN_EXTENSION_SIZE
- Static variable in class cnrg.itx.ds.
DirectoryService
N
next()
- Method in class cnrg.itx.ds.
LocationList
Get the next element.
next()
- Method in class cnrg.itx.ds.
ArrayRecords
Get the next element.
NULL_ACCESS_LEVEL
- Static variable in class cnrg.itx.ds.
DirectoryService
P
Password
- class cnrg.itx.ds.
Password
.
This class provides an encapsulation to store user's password information.
Password(String)
- Constructor for class cnrg.itx.ds.
Password
Constructor for String
R
RecordAlreadyExistsException
- exception cnrg.itx.ds.
RecordAlreadyExistsException
.
This class represents a record-already-exists exception thrown by the directory service.
RecordAlreadyExistsException(String)
- Constructor for class cnrg.itx.ds.
RecordAlreadyExistsException
Constructor
RecordNotFoundException
- exception cnrg.itx.ds.
RecordNotFoundException
.
This class represents a record-not-found exception thrown by the directory service.
RecordNotFoundException(String)
- Constructor for class cnrg.itx.ds.
RecordNotFoundException
Constructor
registerLocation(int, Location)
- Method in class cnrg.itx.ds.
DirectoryService
Register the location of the user (authenticated with this directory service) when he/she starts up an application.
removeAll()
- Method in class cnrg.itx.ds.
LocationList
Remove all the elements from the location list object
removeUser(Digits)
- Method in class cnrg.itx.ds.
DirectoryService
Removes a user from the directory database.
reset()
- Method in class cnrg.itx.ds.
LocationList
Reset to the first element position
reset()
- Method in class cnrg.itx.ds.
ArrayRecords
Reset to the first element position
ROAMING
- Static variable in class cnrg.itx.ds.
Location
S
SERVER_ACCESS_LEVEL
- Static variable in class cnrg.itx.ds.
DirectoryService
setCleanUp(boolean)
- Method in class cnrg.itx.ds.
DirectoryService
Turn off or turn on the cleanup thread.
setConfigPath(byte[])
- Method in class cnrg.itx.ds.
DSComm
Set the config filepath in the DSComm.dll to be able to communicate with the directory server
setConfigPath(byte[])
- Method in class cnrg.itx.ds.
CStub
setCustomMessage(String)
- Method in class cnrg.itx.ds.
DirectoryService
Set the custom message of the user authenticated with this directory service
setEndTime(Calendar)
- Method in class cnrg.itx.ds.
CustomLocation
Set EndTime
setLabel(String)
- Method in class cnrg.itx.ds.
Location
Set the Location (optional) label
setLocationList(LocationList)
- Method in class cnrg.itx.ds.
CustomLocation
Set the Location list to the given new location list
setPIN(UserID, Password, Password)
- Method in class cnrg.itx.ds.
DirectoryService
Change the PIN of the user authenticated with this directory service.
setStartTime(Calendar)
- Method in class cnrg.itx.ds.
CustomLocation
Set StartTime
T
TELEPHONE_TYPE
- Static variable in class cnrg.itx.ds.
Location
toString()
- Method in class cnrg.itx.ds.
Password
toString()
- Method in class cnrg.itx.ds.
Digits
Returns itself represented as a string
toString()
- Method in class cnrg.itx.ds.
CustomLocation
Convert into formatted entry string to be stored in the directory database
toString()
- Method in class cnrg.itx.ds.
Location
Convert into raw location string format.
toString()
- Method in class cnrg.itx.ds.
UserID
Convert to string
U
unregisterLocation(int, Location)
- Method in class cnrg.itx.ds.
DirectoryService
Unregister the location of the user (authenticated with this directory service) when he/she exits from an application
USER_ACCESS_LEVEL
- Static variable in class cnrg.itx.ds.
DirectoryService
USER_TYPE
- Static variable in class cnrg.itx.ds.
Location
UserID
- class cnrg.itx.ds.
UserID
.
This class provides an abstraction to identify a user uniquely
UserID(String)
- Constructor for class cnrg.itx.ds.
UserID
Constructor for string E.g.
UserProperty
- class cnrg.itx.ds.
UserProperty
.
This class stores information on userID, extension, roaming location (if any), and custom message.
UserProperty(UserID, int, Location, String)
- Constructor for class cnrg.itx.ds.
UserProperty
Constructor
V
verified(Password)
- Method in class cnrg.itx.ds.
Password
Verify against a given password object
A
C
D
E
F
G
I
L
M
N
P
R
S
T
U
V
Package
Class
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES