Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Right click on the project, and select "Debug". This should re-build the project, start-up Tomcat in debug-mode, and open up your application in your default web browser. You should see a "Debugger Console" appear.
  • You can now add breakpoints to areas of your code. The debugger should automatically stop at those points and let you step through your code line-by-line.
  • Note: Occasionally, the first time you perform debugging, the debugger doesn't connect properly with your Tomcat Server. If you find it's not stopping at your breakpoints, you may wish to "Attach" the debugger manually:
    • From the "Debug" menu, select "Attach Debugger.."
      • For the "Connector", specify "SharedMemoryAttach".
      • For the "Name", specify "tomcat_shared_memory_id" (without the quotes).
      • Click "OK" to save these settings
    • Finally, verify that Tomcat is specifying this "tomcat_shared_memory_id" field.
      • Go to the "Tools" menu and select "Servers"
      • Click on your Tomcat Server, and visit the "Startup" tab.
      • Make sure the "Shared Memory Name" setting is selected, and that the value is also "tomcat_shared_memory_id".

Integrate DSpace Javadoc within Netbeans

This section provides instructions for generating the DSpace javadoc and its integration within Netbeans. Its aim is to allow developers to refer to the current DSpace Library API calls, and understanding its uses from within the IDE. 

  • Open pom.xml in DSpace Assembly and Configuration
  • Copy the following code within the plugins tags

           <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-javadoc-plugin</artifactId>
                  <version>2.8</version>
                  <configuration>
                  </configuration>
           </plugin>

  • After copying, the entire section should look a little something like this.

           <plugins>
                 <!-- overall project assembly -->
                 <plugin>
                            <artifactId>maven-assembly-plugin</artifactId>
                           <version>2.2-beta-1</version>
                           <configuration>
                           <descriptors>
                              <descriptor>src/assemble/assembly.xml</descriptor>
                           </descriptors>
                           </configuration>
                           <executions>
                           <execution>
                           <phase>package</phase>
                           <goals>
                           <goal>directory-single</goal>
                           </goals>
                           </execution>
                           </executions>
                 </plugin>

                 <plugin>
                           <groupId>org.apache.maven.plugins</groupId>
                           <artifactId>maven-javadoc-plugin</artifactId>
                           <version>2.8</version>
                           <configuration>
                           </configuration>
                 </plugin>

           </plugins>

  • Right click on the "DSpace Parent Project" (root project) - If it isn't opened, you may need to open it first.
  • Select "Generate Javadoc"
  • Right click on DSpace Assembly and Configuration and select Generate Javadoc
  • After build is successful, right click dependencies folder within DSpace Assembly and Configuration and select download Javadoc
  • Javadoc for DSpace should be available within Netbeans. (It will appear during auto-complete functionality – if you hover over a method, the Javadocs will be displayed if any exists)