Package org.dlese.dpc.schemedit.ndr.util

Class NCSWebServiceClient

java.lang.Object
org.dlese.dpc.serviceclients.webclient.WebServiceClient
org.dlese.dpc.schemedit.ndr.util.NCSWebServiceClient
public class NCSWebServiceClient extends WebServiceClient
Class to extract information from the NCS via webServices.
Author:
Jonathan Ostwald

  • Constructor Details

    • NCSWebServiceClient

      public NCSWebServiceClient()
      Constructor for the NCSWebServiceClient object

    • NCSWebServiceClient

      public NCSWebServiceClient(String baseWebServiceUrl)
      Constructor for the NCSWebServiceClient object
      Parameters:
      baseWebServiceUrl - NOT YET DOCUMENTED

  • Method Details

    • getNCSRecord

      public NCSCollectReader getNCSRecord(URL resourceUrl)
      Gets an NCSCollectReader instance for a given resourceUrl.

      Uses web service to find a metadata record for the resourceUrl and then creates a reader object from the response.

      Parameters:
      resourceUrl - Description of the Parameter
      Returns:
      The nCSRecord value

    • getNCSRecord

      public NCSCollectReader getNCSRecord(String recId) throws Exception
      Returns NCSCollectReader instance for NCS Collect record having provided id.
      Parameters:
      recId - Description of the Parameter
      Returns:
      The nCSRecord value
      Throws:
      Exception - Description of the Exception

    • getNCSRecordByTitle

      public NCSCollectReader getNCSRecordByTitle(String title) throws Exception
      Gets the nCSRecordByTitle attribute of the NCSWebServiceClient object
      Parameters:
      title - NOT YET DOCUMENTED
      Returns:
      The nCSRecordByTitle value
      Throws:
      Exception - NOT YET DOCUMENTED

    • getNCSCollectionID

      public String getNCSCollectionID(String resourceUrl)
      Finds the collection id for the provided collection resource url.

      Parameters:
      resourceUrl - Description of the Parameter
      Returns:
      The nCSCollectionID value

    • getNCSCollectionRecordIDs

      public List getNCSCollectionRecordIDs() throws Exception
      Gets a list of record ids from the NCSL Collections collection.
      Returns:
      The nCSCollectionIDs value
      Throws:
      Exception - Description of the Exception

    • getRecordIDs

      public List getRecordIDs(String collectionKey) throws Exception
      Gets a list of record ids from the specified collection.
      Returns:
      The nCSCollectionIDs value
      Throws:
      Exception - Description of the Exception

    • getNCSCollectionIDs

      public List getNCSCollectionIDs() throws Exception
      Gets the IDS of the Collections of the NCS http://ncs.nsdl.org/mgr/services/ddsws1-1?verb=ListCollections
      Returns:
      The nCSCollectionIDs value
      Throws:
      Exception - NOT YET DOCUMENTED

    • main

      public static void main(String[] args)
      The main program for the NCSWebServiceClient class
      Parameters:
      args - The command line arguments