| Subdirectory
| File
| Purpose
|
| Configuration Files
|
| /config/properties/
| runtime.properties
| Points the browser at an ndr instance. This is the config file that is used by the browser.
|
| /config/properties/
| runtime-nsdlib.properties
| Copy to runtime.properties to point the browser at test ndr instance. May need to be modified to adjust the location of the private key on the machine where the browser is running. Need something similar to point to production NDR.
|
| /config/properties/
| runtime-nsdl.properties
| Copy to runtime.properties to point the browser at production ndr instance. May need to be modified to adjust the location of the private key on the machine where the browser is running. DOESN'T ACTUALLY EXIST, but would be nice to have.
|
| /config/WEB-INF/
| struts-config.xml
| Sets up the acceptable URLs for the browser and passes them to the action classes for processing
|
| Java Source Files
|
| /java/org/nsdl/repository/browser/...
|
| location for the java source code
|
| .../api/action/byNsdlCollection
| *
| Nothing done here yet, but the intention is to start by showing all aggregators for NCS agent.
|
| .../api/action/byObjectType
| Browse<ObjectType>.java
| Struts action classes for processing browse by object requests.
|
| .../api/action/byRelationship
| Browse<ObjectType><Relationship>.java
| Struts action classes for processing browse by relationship requests.
|
| .../api/actionForm/
| Data.java
| Holds data that will be displayed in result jsp. There is data in this that isn't used because it was copied from the NDR api Data class. It could use some cleaning up.
|
| .../api/request/
| RequestUtils.java
| Utility methods that help pull apart the request url into the component parts.
|
| .../model/data/
| CommonAPIWrapper.java
| Suppport methods for <ObjectType>APIWrapper classes.
|
| .../model/data/
| <ObjectType>APIWrapper.java
| Access NDR data through java toolkit calls.
|
| .../util/
| APIutil.java
| Utility methods aiding in the setup and access of the java toolkit.
|
| XML Query Files
|
| /xml/
| Find<ObjectTypeBeingFound><Relationship><ObjectTypeKnown>.xml
| Canned inputXML for Find queries where the <ObjectTypeKnown> object's handle is substituted for a REPLACEMENT_STRING. Used by CommonAPIWrapper.callFind() method. Supports multiple replacement strings.
|
| /xml/
| FindAll<ObjectType>.xml
| Canned inputXML for finding all objects of a particular type. These ARE NOT USED, but I left them in anyway. Instead, the java toolkit method CommonCalls.findByType(), which doesn't require inputXML, is used to do the find by type.
|
| UI Files
|
| /css/
| style.css
| Controlls the look-and-feel of the browser
|
| /jsp/
| header.jsp
| Writes the header for the UI.
|
| /jsp/
| breadcrumbs.jsp
| Writes the breadcrumb section of the header for the UI.
|
| /jsp/
| index.jsp
| Starting point page of the UI.
|
| /jsp/
| type.jsp
| UI page for Browse by Type.
|
| /jsp/
| list<ObjectType>.jsp
| Prints the appropriate table of results based on the object type.
|
| /jsp/
| type.jsp
| Writes the breadcrumb section of the header for the UI.
|
| /jsp/
| error.jsp and original_error.jsp
| ???
|
