org.dlese.dpc.serviceclients.cat

Class CATWebService

java.lang.Object

org.dlese.dpc.serviceclients.cat.CATWebService

Direct Known Subclasses:

GetAllStandardsDocuments, GetStandard, SuggestStandards

public abstract class CATWebService
extends java.lang.Object

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUrl
protected java.lang.String	password
protected java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
CATWebService()
CATWebService(java.lang.String username, java.lang.String password, java.lang.String baseUrl) Constructor for the CATWebService object

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getErrorMsg(org.dom4j.Element errorElement) Gets the errorMsg attribute of the CATWebService object
protected abstract java.lang.String	getMethod() Gets the method attribute of the CATWebService object
org.dom4j.Document	getResponse(CATRequestConstraints constraints) Submit a request to the CAT service and return the response as a Document
org.dom4j.Document	getResponse(java.util.Map argMap) Gets the response attribute of the CATWebService object
protected static void	pp(org.dom4j.Node node) Description of the Method

Methods inherited from class java.lang.Object

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

Field Detail

baseUrl

protected java.lang.String baseUrl

username

protected java.lang.String username

password

protected java.lang.String password

Constructor Detail

CATWebService

public CATWebService()

CATWebService

public CATWebService(java.lang.String username,
                     java.lang.String password,
                     java.lang.String baseUrl)

Constructor for the CATWebService object

Parameters:

username - username for authenticating to the CAT Web Service

password - password for authenticating to the CAT Web Service

Method Detail

getMethod

protected abstract java.lang.String getMethod()

Gets the method attribute of the CATWebService object

Returns:

The method value

getResponse

public org.dom4j.Document getResponse(CATRequestConstraints constraints)
                               throws java.lang.Exception

Submit a request to the CAT service and return the response as a Document

Parameters:

constraints - constraints submitted to CAT Web Service

Returns:

The response value

Throws:

java.lang.Exception - if a response could not be obtained, or if the response contains an error from the server.

getResponse

public org.dom4j.Document getResponse(java.util.Map argMap)
                               throws java.lang.Exception

Gets the response attribute of the CATWebService object

Parameters:

argMap - query parameters as key/value pairs

Returns:

The response value

Throws:

java.lang.Exception - if a response could not be obtained, or if the response contains an error from the server.

getErrorMsg

protected java.lang.String getErrorMsg(org.dom4j.Element errorElement)

Gets the errorMsg attribute of the CATWebService object

Parameters:

errorElement - error element from a CAT Service response

Returns:

The errorMsg value

pp

protected static void pp(org.dom4j.Node node)

Description of the Method

Parameters:

node - Description of the Parameter