Home >> All >> com >> further >> jaudit >> [ http Javadoc ]

• com.further.jaudit.http: Javadoc index of package com.further.jaudit.http.


Package Samples:

• com.further.jaudit.http

Classes:

• ConfigurationServlet: The configuration servlet is responsible for loading the configuration for the system based on the servlet init param com.further.jaudit.config . The index.jsp checks the directory bean to see if the system configuration has been loaded, and if it has not, redirects to the configuration servlet. If the configuration servlet is able to load the configuration, then it sets the appropriate parameters in the directory bean and redirects back to the index.jsp. Otherwise, the configuration servlet sends the user to the error page. This servlet must be configured as /configServlet in the system.
• DirectoryBean: The directory bean is the primary bean used by the jsps to access the underlying system resources. This bean holds the current working directory (cwd) of the system for the logged in user, and is maintained open for the lifetime of the session. The bean itself provides methods to change directories, list the files and directories contained in a given directory, and to access the contents of a given source file as a string for screen rendering. The heart and soul purpose of this bean is to provide a simple facade to the rest of the system for easy access from jsps.
• ColorPreferencesBean: The color preferences bean holds the user specified foreground, background, keyword and comment color preferences. This bean can then generate the BODY tag for an HTML page, or allow access to the color values themselves. It is worthy of mention that the color values are stored in the form: XXXXXX , which is the hex RGB web format without the leading # . The bean delegates almost all of its functions to the SystemConfiguration object, presenting it in a jsp-friendly fashion.
• FormGeneratorBean: The form generator bean is responsible for generating the html input forms for a given source file to audit. This is done by making an appropriate tag for each source metric to be collected, then allowing the client code to have a simple Iterator over the metric abbreviations for the applicable source metrics. For each metric, the client code can obtain the full metric name and the corresponding form tag. The rendering of the form is left to the corresponding jsp.
• StatisticsBean: The statistics bean is responsible for iterating the entire source base and compiling summary statistics about the source files. These stats include: Number of files Percent of files that have been audited Percent of files that are compliant (passing audit) Minimum audit age Maximum audit age For each metric, what percent of files have each value.
• AuditViewerBean: This bean handles the work of viewing the audit history for a sourcefile. The source file is set on the bean and the source audit history is made available via an Iterator over the dates. For each date, the user can obtain an iterator over the metrics, the user that entered the audit record and the comment.
• SourceFormatter: This is a freely available source formatter that does a simple (java/c) to html conversion, and, at the same time, adds color and syntax highlighting to the output html file. The code for this is a little long and procedural, but it does the job and is just treated as a black box in the system.
• AuditFormServlet: The audit form servlet processes the results of a user entering an audit record in a web form for a given source file. After processing and entering the audit record, the source directory is persisted out to disk, and then the user is redirected back to the directory listing.
• FormInputVisitor: The form input visitor produces an HTML form widget that can be used to collect a user's input for a given metric. This does not include the display goop around the form widget, just the correctly formatted tag, with the NAME set to the abbreviation of the metric.
• ChangeDirectoryServlet: The change directory servlet handles the backend work of changing the working directory of the application, then redirecting to the directory listing page. This servlet must be configured with the uri /changeDirectory in the webapp.
• SetCurrentFileServlet: This servlet is responsible for setting the currently selected user file in the directory bean. This servlet uses the parameter fileName to set the filename, then redirects the user back to /index.jsp.
• RequestMetricVisitor: The request metric visitor takes an uninitialized set of source metrics and the raw HttpServletRequest and walks over each metric, using the visitor methods to set the input value for the metric.

Home | Contact Us | Privacy Policy | Terms of Service