Access Keys:
Skip to content (Access Key - 0)

Identifiers


Naming Authority Grid Service


Contents

While the web application provides a read (HTTP resolution) interface to the naming authority, the grid service provides a write interface. Grid clients can leverage this interface to create and maintain identifiers. The Identifiers security framework requires secure web application container.

Before deploying the grid service, complete the following steps from the previous section:

  • Install caGrid 1.5.
  • Configure a secure globus-enabled Tomcat container (port 8443). This can be done with the caGrid installer or manually.

Assumed here is that the grid service is being deployed in its own Tomcat container running on port 8443 in host identifiers-na.nci.nih.gov. However, it is not necessary that the grid service be co-located with the web application. At a minimum, a separate container is recommended.

After these steps have been completed, proceed to the next step.

Configure the Grid Service


Customize $CAGRID_HOME/identifiers-namingauthority-gridsvc/etc/na.properties**

NOTE: cagrid.na.prefix MUST include a trailing slash .

Edit Service Metadata


The grid service provides service metadata to clients and other services that describes information about the service, operations supported by the service, and information on the organization hosting the service.

Edit the service metadata to reflect your organization as follows:

  1. Open the Naming Authority Grid Service metadata file, $CAGRID_HOME/identifiers-namingauthority-gridsvc/etc/serviceMetadata.xml.
  2. In the hostingResearchCenter element near the bottom of the file, do the following:
    1. Supply the ResearchCenter information.
    2. Supply the Address. This is the address that is used when mapping your service on the caGrid Portal.
    3. Supply the PointOfContact. This is the person responsible for maintaining the service.
      A completed example:
      <ns1:hostingResearchCenter>
        <ns53:ResearchCenter displayName="Ohio State University" shortName="OSU" xmlns:ns53="gme://caGrid.caBIG/1.0/gov.nih.nci.cagrid.metadata.common">
         <ns53:Address country="US" locality="Columbus" postalCode="43210" stateProvince="OH" street1="3190 Graves Hall" street2="333 W. 10th Ave."/>
         <ns53:pointOfContactCollection>
          <ns53:PointOfContact affiliation="OSU" email="John.Doe@osumc.edu" firstName="John" lastName="Doe" phoneNumber="(555) 555-5555" role="Maintainer"/>
         </ns53:pointOfContactCollection>
        </ns53:ResearchCenter>
       </ns1:hostingResearchCenter>
      

Deploy to Tomcat


At this point we have completed configuring the grid service and the Tomcat container in which it will run. We are now ready to deploy the grid service to the secure Tomcat container. This can be done as follows from a command prompt:

cd $CAGRID_HOME/projects/identifiers-namingauthority
ant deployTomcat

Ensure MySQL is running and that the database configured above (cagrid.na.db.name) has been created.

$> mysql -u root
mysql> create database nadb
mysql> exit

  • cd $CAGRID_HOME/projects/identifiers-namingauthority-gridsvc
  • ant deployTomcat

Verify the Installation


Once you have deployed the grid service, you have completed the installation and configuration of the naming authority with the ability to create and maintain identifiers. Next we will verify that the installation was successful, however, before doing so we must start the Naming Authority. This is done by starting the container to which the Naming Authority was deployed. To start a secure Tomcat container, run the startup script (startup.sh or startup.bat) located in CATALINA_HOME/bin:

cd $CATALINA_HOME/bin
startup.bat

(You may also want to configure Tomcat to start automatically).

Confirm the service is running by browsing https://identifiers-na.nci.nih.gov:8443/wsrf/services/cagrid/IdentifiersNAService.

For further verification, the ant target, runClient, can be run to try the creation of a simple identifier. Prior to this, ensure that the correct grid service URL is set in run-tools.xml.

Now paste the created identifier URI into a web browser, resulting in the identifier metadata being displayed. This validates the correct operation of the prefix authority (PURL server) and the naming authority web application.

Last edited by
Joe George (398 days ago) , ...
Adaptavist Theme Builder Powered by Atlassian Confluence