edu.vt.marian.WebGate
Class request

java.lang.Object
  |
  +--edu.vt.marian.WebGate.request

public class request
extends java.lang.Object

Class name: request Class description: this is a request webgate received from cgi (formit). Author: Jianxin Zhao Finished time: ????, 1998 Known bugs: none Platform: jdk1.1.5 under UNIX


Constructor Summary
request(edu.vt.marian.uip.packet_input_stream pis, edu.vt.marian.common.Debug debug)
          this constructor will create a request object from an input stream, it now use stringpool to do so but maybe changed in the future, the change will bring no effect to other classes as long as this class still provide the same service
 
Method Summary
 java.lang.String contains(java.lang.String name)
          this method will tell wether or not this request object contains the specified string, this is helpful when the request type is the same but different processing are needed for different strings contained int the request
 java.lang.String get_client_name()
          this method will tell us the cgi program name of this request, so we don't need to tell the system this by using command line parameter, also we may support multiple formit simutanulously.
 java.util.Vector get_doc_numbers()
          this method will return the document numbers which are chosen by our client
 java.lang.String get_full_name()
          this method will return the full name of the user when he/she login the first time
 general_query_data get_general_query_data()
          this method will return the general query data of this request, usually this is something filled by our client, general query data can be used to query user manager, query database of a user or log manager.
 java.lang.String get_generate_time()
          this method will return the time when this request is generated, this might be used in logging and performance measurement
 java.lang.String get_last_doc_number()
          this method will return the last document number of the current page, the reason for this method is that we need to know display to which document when user come back by press the cancel button
 java.lang.String get_last_query_number()
          this method will return the last query number associated with this request object
 java.lang.String get_new_password()
          this method will return the new password the user entered, at least this is useful when user want to change password
 java.lang.String get_number_logs()
          this method will return the number of latest requests super use choose to see when doing log file analysis
 java.lang.String get_password_confirm()
          this method will return the confirmation password input by the user, at least we need user to confirm password when he/she first login or change previous password
 java.lang.String get_password()
          this method will return the password of this request, user name and password are used to identify an user
 preference get_preference()
          this method will return the preference contents associated with this request object
 query_data get_query_data()
          this method will return the query data of this request, usually this is something filled by our client
 java.lang.String get_query_number()
          this method will return the query number of this request
 java.lang.String get_type()
          this method will tell us the type of this request, current type include query, circulaton,...
 edu.vt.marian.uip.uip_server get_uip_server()
          this method will return the uip server chose by the user to see full description
 java.lang.String get_user_name()
          this method will return the user name of this request
 java.util.Vector get_user_names()
          this method will return the user login names which are chosen by the super user
 java.lang.String to_stream(java.io.DataOutputStream dos)
          this method will print the content of this object to a stream, this might be useful for remote management in the future .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

request

public request(edu.vt.marian.uip.packet_input_stream pis,
               edu.vt.marian.common.Debug debug)
this constructor will create a request object from an input stream, it now use stringpool to do so but maybe changed in the future, the change will bring no effect to other classes as long as this class still provide the same service
Method Detail

get_client_name

public java.lang.String get_client_name()
this method will tell us the cgi program name of this request, so we don't need to tell the system this by using command line parameter, also we may support multiple formit simutanulously.

get_user_name

public java.lang.String get_user_name()
this method will return the user name of this request

get_full_name

public java.lang.String get_full_name()
this method will return the full name of the user when he/she login the first time

get_password

public java.lang.String get_password()
this method will return the password of this request, user name and password are used to identify an user

get_new_password

public java.lang.String get_new_password()
this method will return the new password the user entered, at least this is useful when user want to change password

get_password_confirm

public java.lang.String get_password_confirm()
this method will return the confirmation password input by the user, at least we need user to confirm password when he/she first login or change previous password

get_type

public java.lang.String get_type()
this method will tell us the type of this request, current type include query, circulaton,...

contains

public java.lang.String contains(java.lang.String name)
this method will tell wether or not this request object contains the specified string, this is helpful when the request type is the same but different processing are needed for different strings contained int the request

get_query_number

public java.lang.String get_query_number()
this method will return the query number of this request

get_query_data

public query_data get_query_data()
this method will return the query data of this request, usually this is something filled by our client

get_general_query_data

public general_query_data get_general_query_data()
this method will return the general query data of this request, usually this is something filled by our client, general query data can be used to query user manager, query database of a user or log manager. (not implemented yet)

get_uip_server

public edu.vt.marian.uip.uip_server get_uip_server()
this method will return the uip server chose by the user to see full description

get_doc_numbers

public java.util.Vector get_doc_numbers()
this method will return the document numbers which are chosen by our client

get_user_names

public java.util.Vector get_user_names()
this method will return the user login names which are chosen by the super user

get_preference

public preference get_preference()
this method will return the preference contents associated with this request object

get_last_doc_number

public java.lang.String get_last_doc_number()
this method will return the last document number of the current page, the reason for this method is that we need to know display to which document when user come back by press the cancel button

get_last_query_number

public java.lang.String get_last_query_number()
this method will return the last query number associated with this request object

get_number_logs

public java.lang.String get_number_logs()
this method will return the number of latest requests super use choose to see when doing log file analysis

get_generate_time

public java.lang.String get_generate_time()
this method will return the time when this request is generated, this might be used in logging and performance measurement

to_stream

public java.lang.String to_stream(java.io.DataOutputStream dos)
this method will print the content of this object to a stream, this might be useful for remote management in the future . (not implemented yet)