OSCAR Documentation ) Developers For developer registration the java and jsp files involved are the following

Transcription

1 OSCAR Documentation Contents 1) Technical documentation of back end process. 2) Data Dictionary of OSCAR2005 database. 3) Directory Structure of Project OSCAR. 1) Technical documentation Technical documentation contains the registration process of developers and mentors, suggesting simulation ideas and links, submitting developed animations, allocation of animation idea to developers, mentoring animation to developer groups and animation ideas, automatic mail sending process, uploading documents related to animation and source code of the animations. 1.1) Registration 1.1.1) Developers For developer registration the java and jsp files involved are the following inside directory: oscar/web INF/classes/oscarBeans/ registerdeveloperform.java registerdeveloperaction.java confirmform.java confirmaction.java inside directory: oscar/pages/ registerdeveloper.jsp registerdeveloperconfirm.jsp Formwith developer details from registerdeveloper.jsp are submitted to registerdeveloperfrom.java. The corresponding getter and setter method for each field in the jsp file are written in the registerdeveloperform.java file. When the form is submitted in the jsp file the values for each property is set in the form bean. The object of this form bean is obtained in registerdeveloperaction.java and using that object values are obtained in the action and corresponding action is performed. When a developer group registers the submit buttons value will be 'Save'. When this value is obtained in the execute method of the registerdeveloperaction.java bean, two methods insertlogindetails() and insertdeveloperdetails() are called. The first method insert the details of the developer group in the login table with values for userid, username, password, usertype, registration time and last login time. The method creates an id by adding one to the maximum value of already present login_id from the login table. The login_id is the primary key of login table. After inserting these values into the login table, the second method is executed which inserts

2 the personnal details which the developer has filled in the registerdeloper.jsp file into the developers table. Along with the filled in details it also associates the foreign key of login_id to dev_login_id to the developers table and also creates a primary key by name dev_pri_key in the developers table. After inserting values into login table and developer table the control is returned to registerdeveloperconfirm.jsp. There the username which is created for that developer group is displayed and asked for a password. The developer group notes their userid and provides a password. When submitted, the password is set in confirmform.java whose values are obtained in confirmaction.java. The execute method of confirmaction.java updates the provided passowrd to the login table corresponding to the userid. The password before updation is encrypted using md5 encryption algorithm implememnted using the HashUtil.java bean. After updating the password a mail is send to all the devlopers in registered group using the sendmail() in the SendMail.java bean confirming them about the registration and along with that their userid and password is also send ) Mentors Files involved in mentor registration are as follows inside directory: oscar/web INF/classes/oscarbeans registermentorform.java registermentroformactio.java mentorregdetailsform.java metorregdetailsfromaction.java inside directory: oscar/pages registermentor.jsp mentorregdetails.jsp Form with mentor details from registermentor.jsp are submitted to registermentorform.java. The corresponding getter and setter method for each field in the jsp file are written in the registermentorform.java file. When the form is submitted in the jsp file the values for each property is set in the form bean. The object of this form bean is obtained in registermentorformaction.java and using that object values are obtained in the action and corresponding action is performed. For a mentor to register the first page is registermentor.jsp. One has to enter the username and password in the first page. Then the method checklogin() in the registermentorformaction.java will check whether the username is already taken by some other user or not. If it is not taken then only it will allow the user to go to the next page ie mentorregdetails.jsp. Then the username and password is inserted into the table using the method insertmentorlogin(). The loginid, username,passwod and usertype(here it is mentor) are inserted into the login table. The password before insertion is encrypted using md5 encryption algorithm implememnted using the HashUtil.java bean. The loginid is created by a method called makeid().

3 In this method id is created by adding one to the maximum value of the loginid already present in the login table. This is the primary key of the login table. Then the mentor has to enter the details like name, address, phone, , organization name, organization address and designation in the MentorRegDetails.jsp file. The values entered in this jsp file are inserted in to the mentors table using the two java files mentorregdetailsform.java and mentorregdetailsformaction.java. Here the getter and setter functions are written in the mentorregdetailsform.java file and the functions which inserts the values in to table are written in the mentorregdetailsformaction.java file. The method used is insertmentorlogin(). Here id is also inserted in to the mentors table along with the details collected from the user. id is the login id which was generated in the registermentorformaction.java file and which was inserted in to the login table. Here this id is a foreign key in the mentors table which is the primary key of the login table. After the registration a mail is send to the mentor using the sendmail() in the SendMail.java bean confirming about the registration and along with the userid and password. 1.2) Animation Idea Submission Java and jsp files involved in submitting an animation idea are inside directory: oscar/web INF/classes/oscarBeans suggestsimulationform.java suggestsimulationaction.java inside directory: oscar/pages suggestanimations.jsp Details regarding an idea for suggesting an animation development is filled in the form given in suggestanimations.jsp. The filled in values are set to suggestsimulationform.java using the respective settermethods. The getter methods fro retriveing the animations are also written in the form bean. The values entered by the user are obtained in the suggestsimulationaction.java bean. In the execute method of the action bean insertsimulationdata() is called after checking that the process is not accepting, rejecting or editing of any previously suggested animation idea. This verification is obtained by checking the value of the submit button coming to the action bean for suggesting animation ideas. The values of the suggested animation idea are obtained using the getter methods in the suggestsimulationform.java bean and the values are inserted into the suggest_simulation table. If the user wants to be a developer or a mentor of the suggested animnation idea corresponding submit values are obtained from the suggestsimulation.jsp page. A session variable is set for

4 identifying the simulation idea that has been suggested. The control is send to either developer or mentor registration page as per the value of the submit button. After the user is registered their userid is stored corresponding to the animation record in the suggest_simulation table in the datebase. This process is done in the registerdeveloperaction.java file inside the insertlogindetails() method. The action bean of suggesting idea for animation also has methods updatesimlulationdata() and getusersuggestedanimations(). The first method is used to update the edited values of already suggested animation idea. The editing can be either done by administrator, who has the facility to edit all the suggested animation idea. The ideas can also be edited by registered users if the corresponding idea is suggested by that user. The editsuggestedanimation.jsp file is used as the interface which shows the administartor or other users the values of a suggested animation idea which was submitted when freshly suggesting it. The value for populating the fields in the edit form is obtained using the showsuggestedsimulation() method in simulationdata.java bean. If the user who has logged in is administrator the button for accepting or rejecting the animation is shown along with the edit button. If the logged in user is either a developer or mentor the edit button is only shown for editing the animations suggested by them. 1.3) Animation Link submission Java and jsp files involved are inside directory: oscar/web INF/classes/oscarBeans suggestsimulationlinkform.java suggestsimulationlinkaction.java inside directory: oscar/pages suggestsimulationlink.jsp Users are provided with the option to suggest any animation related link through oscar. The form to suggest animation link are provided in the suggestsimulationlink.jsp. The values filled in the form are set using the setter method in the suggestsimulationlinkform.java. The values are stored using the insertsimulationlink() method in the suggestsimulationlinkaction.java bean. A method by name getarray() creates array of suggested animation links, associated text and the category values entered in the jsp form. These values are stored in the suggest_simulation_link table. 1.4) Search Java and jsp files involved are

5 inside directory: oscar/web INF/classes/oscarBeans searchform.java searchaction.java inside directory: oscar/pages oscarhomebody.jsp search.jsp searchresults.jsp The request for animation related items in oscar comes from any one of the two jsp pages. The first jsp page is the oscarhomebody.jsp which is the main oscar home page. A form for search has been included in the jsp file. The values from that form are set in corresponding variables in searchform.java. These values are obtained in the searchaction.java file using the searchform.java object created in the execute method of searchaction.java. The execute method in the action bean calls three methods for searching three different animations related items. The methods are searchsuggestedsimulations(), searchavailablesimulations(), searchotherlinks(). These three methods an arraylist object of the search result found. These arraylist objects are set in the session and is obtained in the searchresults.jsp file. The three methods searches in suggested_simulations, submitted_simulations, suggested_simulation_links table respectively according to the values entered by the user. The sql search query differs according to the search criteria. 1.5) Allocating Animations to registered Developer groups Java and jsp files involved are inside directory: oscar/web INF/classes/oscarBeans allocateanimationform.java allocateanimationaction.java inside directory: oscar/pages chooseanimationidea.jsp chooseanimationidea.jsp page serves three purposes. It lists all the available animation idea for development. It allows registered developer groups to take up animation idea. It also lists all the taken up animations by a developer group. The available animation list is obtained from the simulaiondata.java bean. The method getanimationstochoose() in simlationdata.java bean returns an array list object of all the accepted animation idea which has not been yet been taken up by the logged in developer group. These animation idea titles are displayed in the chooseanimationidea.jsp page with a link on it to

6 show the details and a form to take up that animation. It will also be shown whether the animation ideas have a mentor or not. The details regarding a particular animation idea is showed as a result of the array list object returned by the showsuggestedsimulation() method of simulationdata.java bean. It returns the details of a particular animation idea of respective id passed to the method as a parameter. A button is provided after the details of the animation idea to take up the animation. When thei button is clicked action goes to the allocateanimationaction.java where the id of the animation along with the groupid who took up the animation is stored. If there is a mentor alloted for that animation that entry in the table will be updated so that the mentor will be assigned to the group. The table which contains these details is the animation_allocations table. Automatic mail goes to group when they take up an animation idea for development confirming about the operation. If the animation idea taken up by the group already has a mentor then the automatic mail will go to both the mentor and the group informing the group about the mentorship and the mentor about the group which took the animation. 1.6) Taking up mentorship java and jsp files involved are inside directory: oscar/web INF/classes/oscarBeans MentorshipAllocationAction.java MentorshipAllocationForm.java inside directory: oscar/pages mentorship.jsp ongoingprojects.jsp animationpool.jsp A registered mentor can take up mentorship for two categories of projects. One category is the ongoing projects which contains the animation ideas taken up by one or more developer groups for developing. Another category contains all the animation ideas which have not yet been taken up by any developer group for development. Mentoring ongoing projects will be done by selecting the developer groups from the ongoingprojects.jsp file. The mentorship will be alloted to that group when the mentor clicks on the mentor groups button on which action takes place in the MentorshipAllocationAction.java file in allocatementotoongoing() function. The function will update the animation_allocations table in the database where the mentor will be added against the group which they have selected for mentoring in the ongoingprojects.jsp files. Mentors can also take up animation ideas for mentoring from the animationpool.jsp file. These

7 animations won't be taken up by any developer group. When a mentor takes up an animation idea for mentoring an entry in the table animation_allocations will be added for which the developer group field for that animation will be empty. The developers can see whether there is a mentor available for an animation or not on the basis of this entry. So when the developer takes up an animation with mentor availablity the table will be updated with the group id. Automatic mail goes to mentor confirming about the mentorship when the mentor takes animation from the pool or agrees to mentor a group from the ongoing projects list. In the later case mail will go to both mentor and the group informing about the process. 1.7) Sending Mails inside directory: oscar/web INF/oscarBeans SendMail.java This java bean is used to send mails to users registered in oscar. The send() method accepts 7 parameters. They are to address, from address, cc, bcc, subject of the mail, message of the mail and the smtp server. For oscar we are using smtp.iitb.ac.in as the smtp server to send mails. The cc and bcc fields are optional fields 1.8) Uploading files inside directory: oscar/web INF/oscarBeans uploadoscardocs.java The uploaddocument() method in the java bean uploads files to the server with the help of java beans in oscar/web INF/oscarBeans/upload directory. Uploading of ducuments comes in oscar while a fully developed animation is submitted by a user. The user is given option to upload a background reading file and an experiments listed file which are in.html format. User also has to upload the source code file of an animation. These files when uploaded goes to the oscar/uploadanimationdocments directory. When administrator accepts the animation the respective files of that animation is copied to oscar/onsitedocumentsdirectory. This is done by executing the copydirectory.sh shell script in the oscar/web INF/oscarBeans directory. 1.9) Simulation Data bean inside directory: oscar/web INF/classes simulationdata.java This bean contains 7 methods. This bean is mainly responsible for retrieving animation related data from the database. Alll the methods in this bean returns an array list object. The methods in the bean are as follows.

8 showsuggestedsimulation() showavailablesimulation() getallsugidandtitle() getavailidandtitle() getsuggestedlinks() getanimationstochoose() animationstakenby() showsuggestedsimulation() This method retrieves the details about a suggested animation idea from the database on the basis of the suggested animation idea id. First an Sql query is fired to select all the vaues of a particular animation idea. The links and associated text specified along with the animation idea when entered for the first time is obtained and assigned to the variables of suggestsimulationform.java bean using the setter methods. The value is obtained as an array. The array is split accordingly and the values are assigned to the form bean. Other data fields which are not of array data type are asssigned directly to the form bean variable. showavailablesimulation() This method gets the details of a particular submitted animation from the database. Before setting the variables in the submitanimationform any values, a checking is done in the method to find out whether the user has uploaded any background reading or experiment file or both along with the animation source code. If there are files the variables in the submitanimationform.java bean is set correspondingly. Rest of the details about the submitted animation like the title and description are also set to th submianimationform.java bean. getsugidandtitle() This method retrieves all the suggested simulation id and title. This helps to give a link to the title displayed. The id of the animation idea is given as a parameter to the method which is padded along with the url when clicked on the title link. According to the value of this id the showsuggestedsimulation method gets the details about a suggested animation idea as explained above. getavailidandtitle() This method is used to retrieve all the submitted animation title and id. The id is associated with the title.. The details regarding the animation is obtained using the id passed as the parameter to the method. 1.10) Domain Data bean This java bean has a method getareadata() which returns an array list object which contains all the category data in oscar. The data is obtained from the are_domain table. This method is generally used to populate the drop down menus in various jsp files where the area has to be chosen by the user. The method is accessed using an object of domaindatabean.java file. 2) Data Dictionary

9 Table name >available_simulations This table is for storing the available simulation details. + av_id integer (not null) > unique id for each available simulation av_title character varying(100) > available simulation title av_category character varying(75) > available simulation category av_authors text > authors of the available simulation av_advisor character varying(100) > advisor of the available simulation av_summary text > summary of the simulation av_animationdirectory text > directory in which available simulation is stored av_rating integer > rating for available simulation av_status character varying(30) > status of available simulation av_submitted_by av_keywords character varying(30) > the person who submits the simulation character varying(150) > keywords in the simulation which can be used while searching Table name > area_domain This table is for storing the area domain for each simulation id integer(not null) > unique id for different areas for simulation areaname character varying(50) > name of each area Indexes: "area_domain_pkey" primary key, btree (id) Table name > communications This table is for storing the communication details + sentmail_id integer (not null) >unique id for each mail sentmail_to character varying(30) > to address of mails sentmail_date timestamp without time zone > date of each sent mail sentmail_subject text > subject of each mail sent sentmail_message text > message sent sentmail_read boolean > flag for mail read receipt Indexes: "communications_pkey" primary key, btree (sentmail_id)

10 Table name > developers This table is for storing the developer details + dev_login_id integer > login id of the developer group after removing the 'OSCAR100'.This is a foreign key for the login_id in the login table dev_name character varying(75) > name of each developer dev_address text > address of each developer dev_city character varying(75) > city of each develoer dev_state character varying(75) > state of each developer dev_pin character varying(10) > pincode of each developer dev_phone character varying(75) > phone number of each develoer dev_ character varying(75) > id of each developer dev_cname character varying(75) > college name of each developer dev_caddress text > college address of each develoer dev_prikey integer (not null) > unique id for each developer dev_competition character varying(25) > whether the developer wish to join the competition or not. Indexes: "dev_pkey" primary key, btree (dev_prikey) Foreign key constraints: "fk_dev_login_id" FOREIGN KEY (dev_login_id) REFERENCES login(login_id) ON UPDATE CASCADE ON DELETE CASCADE Table name > discussion_forum This table is for storing the discussion forum details + post_id integer(not null) > unique id for each posting post_userid text[] > array to store the user id's of the persons who post the first message and its replies post_scheme character varying(100) > scheme for each posting(oscar) post_category character varying(150) > category for each posting post_question text > each question in the discussion forum postings post_response text[] > array to store the responses for a particular postiing post_time text[] > array to store the time for a particular posting and its replies Indexes: "discussion_forum_pkey" primary key, btree (post_id)

11 Table name > feedback This table is for storing the feedback details + name character varying(50) > name of the person who sends feedback character varying(50) > id of the person who sends feedback comment text > feedback Table name > login This table is for storing the login details + login_id integer ( not null ) > id of each person or group who all are able to login to OSCAR login_name character varying(75) > login name of each person or group who logs in login_password character varying(75) > password for each person or group who logs in login_user_type character varying(75) > type of user (mentor or developer or admin) login_reg_time timestamp without time zone > time of registration login_lastlogin timestamp without time zone > last login time login_count integer > total number of login Indexes: "login_pkey" primary key, btree (login_id) Table name > mentors This table is for storing the mentor details + men_login_id integer login id for the mentors > This is a foreign key for the login_id in the login table men_name character varying(75) > name of the mentor men_address text > address of the menor men_phone character varying(25) > phone number of the menor men_ character varying(50) > id of the mentor men_orgname character varying(50) > organization name of the mentor men_orgaddr text > organization address of the mentor men_desig character varying(50) > designationof the mentor Foreign key constraints: "fk_menloginid" FOREIGN KEY (men_login_id) REFERENCES login(login_id) ON UPDATE CASCADE ON DELETE CASCADE

12 Table name > sponsor This table is for storing the sponsor details. Sponsor can enter their details in the sponsor page + sp_id integer > id for each sponsor sp_name character varying(50) > name of sponsor sp_ character varying(50) > id of the sponsor Table name > suggested_links This table is for storing the links suggested. + sl_id integer ( not null ) > unique is for each suggested link sl_person_name character varying(100) > name of the person who suggested the link sl_person_ character varying(100) > id of the person who suggested the link sl_category text[] > array for storing 3 categories of the 3 link suggested sl_links text[] > array for storing the 3 links suggested sl_link_texts text[] > array for storing the 3 link textsfor the 3 links suggested sl_status character varying(50) > status of the suggested links Indexes: "suggested_links_pkey" primary key, btree (sl_id) Table name > suggested_simulations This table is for storing the simulation ideas suggested + sug_id integer ( not null ) > id of the simulation idea suggested sug_author character varying(100) > author of the idea sug_title character varying(100) > title fotr the idea sug_category character varying(50) > category for the idea sug_bgreading text > background reading for the idea sug_submittedby character varying(50) > the person who submits the idea sug_ character varying(50) > id of the person who suggests the idea. sug_links text[] > array for storing the 2 associated links for the idea sug_linktexts text[] > array for storing the 2 link texts for the 2 links sug_summary text > summary o the suggested idea sug_status character varying(25) > status of the idea suggested sug_suggested_time timestamp without time zone > time of suggestion

13 sug_by sug_taken_by character varying(75) > the person who suggests the idea character varying(20)[] > array for storing id's of the persons who selects the idea for developing or for mentoring sug_preference character varying(2)[] > preferences for development( the developer sets for ideas to develop) Indexes: "suggested_simulations_pkey" primary key, btree (sug_id) 3) Directory Structure Project OSCAR has the following directory structure. oscar AnimationAssociatedDocuments META INF WEB INF classes oscarbeans upload documents images inc onsitedocumentsdirectory pages AnimationAssociatedDocuments: This directory contains the submitted animations. There are sub directories in this directory which are the submitted animation ids. META INF: This directory contains all the library files needed for JAVA. WEB INF: This directory contains the structs configuration files and the tag library files. This also contains the classes directory where the class files and java files are stored which handles the backend process of OSCAR. documents: This directory contains the document files related to Project OSCAR and other pdf and doc files which are accessed through Project OSCAR.

14 images: All the images shown in the project OSCAr site are stored in this directory. onsitedocumentsdirectory: The animation accepted by the administrator are moved to this directory and is accessed from the Project OSCAR site. pages: This directory contains all the jsp files which forms the view part of project OSCAR.