File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes What the final jar file structure should loook like? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of EJB 3 in Action this week in the EJB and other Java EE Technologies forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "What the final jar file structure should loook like?" Watch "What the final jar file structure should loook like?" New topic

What the final jar file structure should loook like?

Eric Kim
Ranch Hand

Joined: Feb 21, 2004
Posts: 37
Just signed up for assignment yesterday and am reading various document about possible assignments. I am somewhat confused about the final jar file structure required.
Here is what I think it should be:
|--- client
|--- server
|--- Database
|--- README.txt
|--- database.bin
Within each directory it contains java source code for that module, plus .class file and .html javadoc.

But the Trottier's book is talking about another structure, check out here:
It basically is somewhat like this:
|--- mypackage
| |
| |--- client
| |--- server
| |--- database
|--- source
| |
| |--- client
| |--- server
| |--- database
|--- doc
Worst of this confusion is that in the sample application this book provided: superbowl, it actually uses the first one mentioned above.
Can someone please clarify this?
Thanks in advanced!
George Marinkovich
Ranch Hand

Joined: Apr 15, 2003
Posts: 619
Hi Eric,
The assignment instructions you download from Sun will have a section on how to package the submission, and it will be quite specific. It's one of the least ambiguous parts of the project. Here is an example, your assignment instructions will be similar (but may not be identical):

Packaging of Submissions
All elements of your submission must be packaged in a single JAR file. The JAR file must have the following layout and contents in its root:
The executable JAR containing the programs. This must be called runme.jar.
The original, unchanged database file that was supplied to you. Note that you must keep a copy of the original database file supplied to you, and this must be the file you submit. The marking process will expect the exact same data without any changes.
A directory called code, containing all the source code and related parts of your project. You must create subdirectories within this to reflect your package structure and distribute your source files within those directories.
A file called version.txt. This must contain pure ASCII (not a word processor format) indicating the exact version of JDK you used, and the host platform you worked on.
A directory called docs, containing the following items at the top level:
This html file.
A subdirectory called javadoc, containing HTML/Javadoc documentation for all classes and interfaces you are submitting.
A file called choices.txt that containing pure ASCII (not a word processor format) text describing the significant design choices you made. Detail the problems you perceived, the issues surrounding them, your value judgments, and the decisions that you made. This document should also describe any uncertainties you had regarding the project, and the decisions you made when resolving them.
User documentation for the database server and the gui client. If your user documentation is online then you may omit this file. However, if the documentation is not online, you must provide either a single plain ASCII (not word processor format) text document, which must be called userguide.txt, or multiple HTML files which must all be accessible from a starting point document that must be called userguide.html.

Regards, George
Eric Kim
Ranch Hand

Joined: Feb 21, 2004
Posts: 37
Thanks George again!
subject: What the final jar file structure should loook like?
Similar Threads
E-Book required
Essay exam
Kris, on your book
How to redirect in a jsf?
Java Stored Procedure