Page tree
Skip to end of metadata
Go to start of metadata

Eclipse Configuration

Here is how the Shibboleth developers set up their Eclipse environment. These instructions were last updated for 2012's Eclipse Juno, but apply in large part to later releases. We recommend the Eclipse IDE for Java Developers distributions.

Max Memory

By default, Eclipse will use up to 512MB of memory. This is probably too low if you have a lot of large projects open at once. To adjust this, edit your eclipse.ini file and adjust the -Xmx###m setting appropriately (768 or 1024 is good). On Windows and on most Linux distributions the eclipse.ini file is located in the same directory as the eclipse executable. On OS X control-click on the executable and select Show Package Contents and then go to Contents/MacOS/eclipse.ini.

On a Mac, it's also a good idea to add "-Djava.awt.headless=true" to the eclipse.ini file to avoid a known bug.  If you don't do this, Eclipse can hang on startup if you shut it down while in the synchronisation perspective.

In the Eclipse Neon release (2016), the default heap size is already set to 1024MB.

Plugins

You must install the following plugins. The easiest way is to use the Marketplace (Help -> Eclipse Marketplace):

  • TestNG for Eclipse
  • Checkstyle Plug-in

Required Configuration

The following configuration, set via the Preferences window, is required when working with Shibboleth.

  • General -> Editors -> Text Editors -> Insert spaces for tabs -> check
  • XML -> XML Files -> Editor -> Line Width -> 120
  • XML -> XML Files -> Editor -> Indent Using Spaces -> selected
  • XML -> XML Files -> Editor -> Indentation Size -> 4

The follow configuration is default in the 'Mars' release of eclipse (4.5) but should be checked.

  • General -> Editors -> Text Editors -> Show line numbers -> check 
  • Java -> Code Style -> Add '@Override' annotation for new overriding methods -> check (Note: requirement reversed at developers meeting 2013-12-20) 

Recommend Configuration

It is recommended that you set the following Eclipse Preferences to the given value. This is not required but the following options are all there for various reasons: help in debugging, code formatting/style, better IDE performance, etc.

  • General -> Show heap status -> check
  • General -> Startup and Shutdown -> Confirm exit when closing last window -> uncheck
  • General -> Startup and Shutdown -> Plug-ins activated on startup -> Mylyn .* -> uncheck
  • Java -> Editor -> Folding -> Comments -> check
  • Java -> Editor -> Folding -> Inner Types -> check
  • Maven -> Download Artifact Sources -> check
  • Maven -> Download Artifact JavaDoc -> check
  • Maven -> User Interface -> Open XML page in the POM editor by default -> check

The follow configuration is default in the 'Mars' release of eclipse (4.5) but can be checked.

  • General -> Appearance -> Enabled animations -> uncheck
  • General -> Editors -> Structured Text Editors -> Enable Folding -> check
  • Install/Update -> Automatic Updates -> Automatically find new updates and notify me -> check
  • Maven -> Download repository index updates on startup -> uncheck

For development with the V3 code, it is also recommended to add this XML Catalog into the Eclipse configuration.  Do this after you have added and imported the V3 projects.

  • File -> Import ->  XML -> XML Catalog.
  • Select the file java-parent-project/resources/eclipse/user_catalog.xml

Importing Projects

In order to work with a project in Eclipse you need to get it from Source Control System and get it in to Eclipse. Here's the general steps.

  1. Check out the project trunk/branch from the Git repository.
    Note: you should perform this checkout from the command line
  2. In Eclipse, select File -> Import then Maven -> Existing Maven Projects
    1. If the project is a monolithic project, select the directory created in step 1 as the Root Directory
    2. If the project is a multi-module project, select the *-parent directory, located as a child directory of the project directory created in step 1, as the Root Directory
  3. Press the Okay button and wait while Eclipse builds everything, updates its caches, has a cup of tea and whatever else takes it so long.

Note: this configuration includes the Shibboleth project's standard Apache 2 license header. Code contributed to the Shibboleth project must contain this header. However, if you are not planning to contribute the code you'll probably want to change this. To do so, go to your project's properties and in Java Code Style -> Code Templates adjust Comments -> File to whatever you want it to be.

  • No labels