de.sekmi.li2b2.client

Class CellClient

java.lang.Object

de.sekmi.li2b2.client.CellClient

Direct Known Subclasses:

OntologyClient, PMClient, QueryClient

public abstract class CellClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Li2b2Client	client
protected URL	serviceUrl

Constructor Summary

Constructors

Constructor and Description
CellClient(Li2b2Client client, URL serviceUrl)

Method Summary

Modifier and Type	Method and Description
protected Element	appendOptionalElement(Element parent, String name, String value) Convenience method to append a text element to another element if and only if the supplied value is not null.
protected Element	appendTextElement(Element parent, String name, String value) Convenience method to append a text element to another element
protected HttpURLConnection	createConnection(HiveRequest HiveRequest, URL requestUrl) Create the HTTP connection.
protected URL	createRequest(String path)
protected HiveRequest	createRequestMessage()
protected HiveRequest	createRequestMessage(DocumentBuilder builder) Create a new HiveRequest message.
protected HiveRequest	createRequestMessage(String bodyXML)
protected String	getOutputCharset()
URL	getServiceURL()
protected DocumentBuilder	newBuilder()
protected HiveResponse	submitRequest(DocumentBuilder b, HiveRequest request, URL requestUrl)
protected HiveResponse	submitRequest(HiveRequest HiveRequest, String method)
protected Element	submitRequestWithResponseContent(HiveRequest HiveRequest, String restMethod, String responseNS, String responseElement) Submit a HiveRequest and expect the HiveResponse body to contain the specified XML element.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected Li2b2Client client

serviceUrl

protected URL serviceUrl

Constructor Detail

CellClient

public CellClient(Li2b2Client client,
                  URL serviceUrl)

Method Detail

getServiceURL

public URL getServiceURL()

getOutputCharset

protected String getOutputCharset()

createRequest

protected URL createRequest(String path)
                     throws MalformedURLException

Throws:

MalformedURLException

newBuilder

protected DocumentBuilder newBuilder()

createRequestMessage

protected HiveRequest createRequestMessage(DocumentBuilder builder)

Create a new HiveRequest message. Will also set the security credentials.

Parameters:

builder - document builder

Returns:

HiveRequest message

createRequestMessage

protected HiveRequest createRequestMessage()

createRequestMessage

protected HiveRequest createRequestMessage(String bodyXML)
                                    throws SAXException,
                                           IOException

Throws:

SAXException

IOException

createConnection

protected HttpURLConnection createConnection(HiveRequest HiveRequest,
                                             URL requestUrl)
                                      throws IOException

Create the HTTP connection. Will use the proxy specified by the client and fill the redirect URL in the message header.

This method will also prepare the returned connection for the URLConnection.connect() call. Specifically, the HiveRequest method will be set to POST, and the Content-Type header will be set to application/xml with output charset.

Parameters:

HiveRequest - HiveRequest

requestUrl - URL

Returns:

connection

Throws:

IOException - io error

submitRequest

protected HiveResponse submitRequest(HiveRequest HiveRequest,
                                     String method)
                              throws HiveException

Throws:

HiveException

submitRequest

protected HiveResponse submitRequest(DocumentBuilder b,
                                     HiveRequest request,
                                     URL requestUrl)
                              throws HiveException

Throws:

HiveException

submitRequestWithResponseContent

protected Element submitRequestWithResponseContent(HiveRequest HiveRequest,
                                                   String restMethod,
                                                   String responseNS,
                                                   String responseElement)
                                            throws HiveException

Submit a HiveRequest and expect the HiveResponse body to contain the specified XML element.

Parameters:

HiveRequest - HiveRequest

restMethod - RESTful method

responseNS - HiveResponse body namespace

responseElement - HiveResponse body element

Returns:

HiveResponse element specified in the argument list. if the element is not found, a HiveException will be thrown.

Throws:

HiveException - server HiveRequest or HiveResponse error

appendTextElement

protected Element appendTextElement(Element parent,
                                    String name,
                                    String value)

Convenience method to append a text element to another element

Parameters:

parent - parent to which the new element will be added as a child

name - element name

value - element value

Returns:

the created element

appendOptionalElement

protected Element appendOptionalElement(Element parent,
                                        String name,
                                        String value)

Convenience method to append a text element to another element if and only if the supplied value is not null.

Parameters:

parent - parent to which the new element will be added as a child

name - element name

value - element value. If the value is null, the element is not created/appended

Returns:

the created element or null if the value was null