Project: | PROJECT-NAME |
---|---|
Release(s) | X.Y.Z |
Related Documents: |
Type of system: |
Desktop GUI application
Unix-style command
Server-side web application
Web service
Client-side applet
Embedded application
Reusable library
Reusable class framework
Browser Plug-in
|
---|---|
Programming Language(s): |
Java
Perl, Unix shell scripts
|
Data Storage: |
Flat files using XML
Flat files using Java properties file format
Flat files using Java object serialization format
SQL database: MySQL
|
UI Technologies: |
Java Swing
XHTML, CSS, JavaScript
|
Security Technologies: |
Authentication: None needed
Authentication: Local username and password file
Authentication: LDAP
Authorization: Operating system file ownership and
read-write-execute flags
Authorization: Access control lists
Encryption: None needed
Encryption: SSL
|
Processes: |
Main application process
Client and server processes
Cron tasks
Operating system services or drivers
|
---|---|
Configuration Files: |
PRODUCT-NAME.conf: stores application configuration in Java
properties file format.
Section of httpd.conf: configures components of the Apache
webserver.
|
Database Tables: |
TABLE_ONE: Each row represents a BUSINESS-OBJECT.
TABLE_TWO: Each row represents a BUSINESS-OBJECT.
TABLE_THREE: Each row represents a BUSINESS-OBJECT.
For more information, see the persistence design document.
|
Data files: |
*.XYZ: Data files saved by the user on their local hard disk.
/var/PRODUCT-NAME/upload-XXXX.dat: Files uploaded to the
server.
|
Temporary files: |
/tmp/PRODUCT-NAME.pid: Process ID of the currently running
server process.
/tmp/upload-XXXX.dat: Files uploaded to the server before
being processed.
|
Log files: |
error.log: Serious errors are put in the normal Apache error
log. Must be writable by Unix user httpd.
PRODUCT-NAME.log: Messages indicating the progress of normal
operations and some errors. Must be writable by Unix user
httpd.
Log files are rotated nightly. Old logs are archived in
ANOTHER-LOCATION.
|
Install: | See the installation guide |
---|---|
Upgrade: | See the installation guide |
Start Server: |
|
Stop Server: |
|
Reload Conf. Files: |
|
Monitor Activity: | Watch the PRODUCT-NAME.log and error.log. |
Periodic Cleanup: | On rare occasion, /tmp/upload-XXXX.dat files can be left behind. Any such files that are more than a day old may safely be removed. |
We take the following precautions to make the system secure:
The security of the system depends on the following external factors:
NOTES ON PERFORMANCE.
NOTES ON SCALABILITY.