OpenSSO

Getting Started FAQ

  1. How do I browse the source code?
  2. How do I checkout the source code?
  3. How do I download OpenSSO?
  4. Where do I find information about setting up the environment, getting the right tools, and actually building the source?
  5. Now that I've built the code, what can I do?
  6. How do I report a bug?
  7. How do I make changes to files in the source?
  8. What is a patch and how do I submit one?

Q: How do I browse the source code?

You can browse the source code without a java.net account by going to the Source - CVS page.

Q: How do I checkout the source code?

To checkout the project source as a registered java.net user, see https://opensso.dev.java.net/servlets/ProjectSource. As a registered user, you will be able to commit changes back to the tree if you have been approved as an OpenSSO Committer. (See the governance for more details on OpenSSO project roles).

You can also checkout the source code with a CVS client as a guest. Use guest as a username and password with the following command:

cvs -d :pserver:guest:guest@cvs.dev.java.net:/cvs checkout opensso

Note: You cannot commit changes back to CVS as guest!

Q: How do I download OpenSSO?

You can download built binaries from the Downloads page.

Q: Where do I find information about setting up the environment, getting the right tools, and actually building the source?

On the Source - CVS page, change into the products/amserver directory. The README in this directory contains information on requirements and dependencies. This information is reproduced in the FAQ Build Requirements and Dependencies.

Q: Now that I've built the code, what can I do?

To particpate in the OpenSSO project, you must register with java.net and join OpenSSO. After this, you can:

  • Participate in discussions on mailing lists and in community forums.
  • Find and report bugs.
  • Write documentation or source code.
  • Give feedback on how to make the project more successful.

Q: How do I report a bug?

See the Reporting Bugs and Security Bugs FAQ for information.

Q: How do I make changes to files in the OpenSSO source?

An OpenSSO contributor may resolve an issue by applying new code to files in the source tree. This is the process for making changes to files in the OpenSSO source:

  1. Check out the latest copy of the source files.
  2. Make modifications to the appropriate files.
  3. Write comments to explain the changes you have made.
  4. Modify the comments that will be generated using the JavadocTM tool and any other appropriate documentation.
  5. Build the software and verify your fix.
  6. Run the relevant sanity and regression tests to make sure that the fix has not broken anything.

Q: What is a patch and how do I submit one?

Running 

cvs diff
reports the differences between two versions of the same file. A patch captures these exact changes. The receiver of a patch applies it to their workspace to merge the changes and bring their version up-to-date with your version. All patches must be reviewed before adding them back to the source tree.

This is the process for submitting a patch file for review:

  1. Create a patch file:
    1. % cd checkedout_source
    2. % cvs diff -u > patch_report_name

  2. Enter an issue in Issue Tracker that corresponds to the patch, if none exists.

    3. Submit only one patch per issue. Do not submit a patch to fix more than one issue unless they are closely related.

  3. Submit your patch along with the issue number to code-review@opensso.dev.java.net.

  4. If approved, attach the patch file to the issue in Issue Tracker. This can be attached as a file or copied directly into the Suggested Fix field.

  5. Send the approved patch to committers@opensso.dev.java.net to have it applied to the source tree.

  6. Once the patch is applied, the committer will update the issue in Issue Tracker as fixed.

If you have found a critical security issue, please follow the guidelines for filing critical security issues.

If your patch is big or you intend to develop a product enhancement, you must follow the architecture review guidelines before submitting the patch. For more information, send an email to code-review@opensso.dev.java.net.