|
DistView
Home
User
Guide
Overview
DistView
Tools
Related
Services
Installing and Running CBE
servers
Compiling the
package
Running Session Manager
Running DistView-Based Applets
Developer
Docs
Javadoc
Registry
Server
Sample
Clients
How
to ...
Known
Problems
Licensing
Information
Download
DistView
People
DistView
Publications
Frequently
Asked Questions
Acknowledgments
|
|
Registry Server Developer
Documentation
The registry server
(umich.cbe.distview.sessionManager.registry) package provides
serveral functions for administering the registry datbase and several
features for creating and forwarding electronic mail between DistView
users. These functions are available through RegistryInfo class
iterfaces. Below is a decription of the public interface to these
features.
- public RegistryInfo(String uname, String em, String pd)
| Description: |
This is the constructor for the RegistryInfo (account) object.
Note that this does not create an entry in the registry database.
Use clientSaveRegistration() to save the account information to
the registry database.
|
| Arguments: |
String uname - unique name for the account
String em - email address for the account
String pd - password of the account
|
- public String toString()
| Description: |
This method converts the RegistryInfo account
object into a readable string. This overrides the
Object.toString() method.
|
| Arguments: |
none
|
- public void displayInfo(PrintWriter ps)
| Description: |
Writes a human-readble description of the
RegistryInfo object to the PrintWriter passed into the function.
|
| Arguments: |
PrintWriter ps - the print writer to write the object data to
|
- public String Username()
| Description: |
This method returns the username asssociated with
RegistryInfo (account) object.
|
| Arguments: |
none
|
- public void setUsername(String uname)
| Description: |
This access method provides an interface for
changing the username associated with the RegistryInfo object.
Note that a change to the username and subsequent save of the
object will result in the creation of a new account. Currently,
there is no interface for changing the username after creation
(saving to the registry database).
|
| Arguments: |
String uname - the new username
|
- public String EMail()
| Description: |
This method returns the email address asssociated
with RegistryInfo (account) object.
|
| Arguments: |
none
|
- public String Password()
| Description: |
This method returns the hashed value of the
password asssociated with RegistryInfo (account) object.
|
| Arguments: |
none
|
- public static Hashtable clientGetAllInfo()
| Description: |
This method returns a java.util.Hashtable
containing RegistryInfo objects for all accounts in the registry
database. The hashtable is indexed by the username associated
with each account. A client application retrieves this
information from the Registry Server via a standard network
socket.
|
| Arguments: |
none
|
- public static RegistryInfo clientGetInfo(String user)
| Description: |
This method returns the RegistryInfo object of the
account with the username passed in. In the event the account
cannot be found a NULL object is returned. A client application
retrieves this information from the Registry Server via a standard
network socket.
|
| Arguments: |
String user - the username of the account to retrieve
|
- public static boolean clientSaveRegistration(RegistryInfo reg)
| Description: |
This method saves the RegistryInfo object passed in
to the registry database. Note that if the username has been
changed (after a RegistryInfo object was previously retrieved),
this operation will result in the creation of a new account.
Currently, there is no interface for changing the username after
creation (saving to the registry database). A client application
saves the RegistryInfo object to the registry by communicating
with the Registry Server over a standard network socket.
|
| Arguments: |
RegistryInfo reg - the account to be saved to the
registry database
|
- public static boolean clientForwardEmail(String from,
String to,
String subject,
String ccList,
String body)
| Description: |
This method forwards electronic mail to the
recipients specified by the argmements passed in. The mail is
sent by the Registry Server. Because of this, the "From:" field
in the received mail will be from the account of the user which
initiated the Registry Server. We suggest that a new user is
created for this purpose. A client application communicates with
the Registry Server over a standard network socket to request the
forwarding of the email.
|
| Arguments: |
String from - the name of the user who is initiating
the email
String to - a comma (",") seperated list of email
accounts to which the email is forwarded
String subject - the subject of the email
String ccList - a comma (",") seperated list of email
accounts to which the email is copied (CC:)
String body - The one or more lines of text that is the
body of the email message. Newline ("\n") characters should be
inserted into the text to create line breaks.
|
- public static int clientGetUsers()
| Description: |
This method returns the maximum number of users
threshold for the DistView installation. A client application
retrieves this information from the Registry Server via a standard
network socket.
|
| Arguments: |
none
|
- public static boolean clientSetUsers(int users)
| Description: |
This method sets the maximum number of users
threshold for the DistView installation. A client application
saves the threshold to the registry database by communicating with
the Registry Server over a standard network socket.
|
| Arguments: |
int users - the new maximum users threshold value
|
- public static int clientGetGuests()
| Description: | This method
returns the maximum number of guest users threshold for the
DistView installation. A client application retrieves this
information from the Registry Server via a standard network
socket.
|
| Arguments: |
none
|
- public static boolean clientSetGuests(int guests)
| Description: |
This method sets the maximum number of guest users
threshold for the DistView installation. A client application
saves the threshold to the registry database by communicating with
the Registry Server over a standard network socket.
|
| Arguments: |
int guests - the new maximum guest users threshold value
|
|