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 Summary

Constructors

Constructor and Description
NCSWebServiceClient() Constructor for the NCSWebServiceClient object
NCSWebServiceClient(java.lang.String baseWebServiceUrl) Constructor for the NCSWebServiceClient object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNCSCollectionID(java.lang.String resourceUrl) Finds the collection id for the provided collection resource url.
java.util.List	getNCSCollectionIDs() Gets the IDS of the Collections of the NCS http://ncs.nsdl.org/mgr/services/ddsws1-1?verb=ListCollections
java.util.List	getNCSCollectionRecordIDs() Gets a list of record ids from the NCSL Collections collection.
NCSCollectReader	getNCSRecord(java.lang.String recId) Returns NCSCollectReader instance for NCS Collect record having provided id.
NCSCollectReader	getNCSRecord(java.net.URL resourceUrl) Gets an NCSCollectReader instance for a given resourceUrl.
NCSCollectReader	getNCSRecordByTitle(java.lang.String title) Gets the nCSRecordByTitle attribute of the NCSWebServiceClient object
java.util.List	getRecordIDs(java.lang.String collectionKey) Gets a list of record ids from the specified collection.
static void	main(java.lang.String[] args) The main program for the NCSWebServiceClient class

Methods inherited from class org.dlese.dpc.serviceclients.webclient.WebServiceClient

doGetId, doPutRecord, doPutRecord, doPutRecord, doSearch, getBaseUrl, getRecord, getRequestUrl, getResponseDoc, getResponseDoc, getResponseError, getResponseError, getResponseStr, getTimedURL, getTimedXmlDocument, getTimeOutSecs, setDebug, setRequestUrl, setRequestUrl, setTimeOutSecs, stuffId, urlCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NCSWebServiceClient

public NCSWebServiceClient()

Constructor for the NCSWebServiceClient object

NCSWebServiceClient

public NCSWebServiceClient(java.lang.String baseWebServiceUrl)

Constructor for the NCSWebServiceClient object

Parameters:

baseWebServiceUrl - NOT YET DOCUMENTED

Method Detail

getNCSRecord

public NCSCollectReader getNCSRecord(java.net.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(java.lang.String recId)
                              throws java.lang.Exception

Returns NCSCollectReader instance for NCS Collect record having provided id.

Parameters:

recId - Description of the Parameter

Returns:

The nCSRecord value

Throws:

java.lang.Exception - Description of the Exception

getNCSRecordByTitle

public NCSCollectReader getNCSRecordByTitle(java.lang.String title)
                                     throws java.lang.Exception

Gets the nCSRecordByTitle attribute of the NCSWebServiceClient object

Parameters:

title - NOT YET DOCUMENTED

Returns:

The nCSRecordByTitle value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getNCSCollectionID

public java.lang.String getNCSCollectionID(java.lang.String resourceUrl)

Finds the collection id for the provided collection resource url.

Parameters:

resourceUrl - Description of the Parameter

Returns:

The nCSCollectionID value

getNCSCollectionRecordIDs

public java.util.List getNCSCollectionRecordIDs()
                                         throws java.lang.Exception

Gets a list of record ids from the NCSL Collections collection.

Returns:

The nCSCollectionIDs value

Throws:

java.lang.Exception - Description of the Exception

getRecordIDs

public java.util.List getRecordIDs(java.lang.String collectionKey)
                            throws java.lang.Exception

Gets a list of record ids from the specified collection.

Returns:

The nCSCollectionIDs value

Throws:

java.lang.Exception - Description of the Exception

getNCSCollectionIDs

public java.util.List getNCSCollectionIDs()
                                   throws java.lang.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:

java.lang.Exception - NOT YET DOCUMENTED

main

public static void main(java.lang.String[] args)

The main program for the NCSWebServiceClient class

Parameters:

args - The command line arguments