net.degreedays.api.processing

Interface ResponseParser

public interface ResponseParser

Parses the API response stream.

Thread safety: any general-purpose implementation of this interface must be safe for use by multiple concurrent threads. However, thread safety is not necessary if you're making your own implementation and can be sure that any code that uses it (including any code that uses a RequestProcessor that uses it) will only be called from a single thread.

Method Summary

Modifier and Type	Method and Description
Response	parseResponse(java.io.InputStream responseStream, Request request) Note that it is not the responsibility of this parser to close the responseStream.

Method Detail

parseResponse

Response parseResponse(java.io.InputStream responseStream,
                       Request request)
                throws java.io.IOException

Note that it is not the responsibility of this parser to close the responseStream.

Parameters:

request - this can be null or the Request object that led to the response. An implementation should be able to function without access to the request, but the request might make some extra functionality available in the response. If, for whatever reason, you're creating your XML requests outside of this framework, just pass null for this parameter. You might find that some functionality of the response object model won't work, but you should be able to work around that.

Throws:

java.io.IOException