Module org.cruk.clarity.api

Package org.cruk.clarity.api.impl

Class SavedQueryRunner

java.lang.Object

org.cruk.clarity.api.impl.SavedQueryRunner

@Component
public class SavedQueryRunner
extends Object

Extraction of code to run a saved query to simplify ClarityAPIImpl. This class needs to handle an error response and convert the XML returned as an exception when there is an error to a ClarityException.

Since:

2.34

Field Summary

Fields

Modifier and Type	Field	Description
protected ResponseErrorHandler	errorHandler	The error handler.
protected ClientHttpRequestFactory	httpRequestFactory	Client request factory.
protected Logger	logger	Logger.

Constructor Summary

Constructors

Constructor	Description
SavedQueryRunner()	Constructor.

Method Summary

Modifier and Type	Method	Description
SavedQuerySummary	runSavedQuery(Linkable<SavedQuery> query, OutputStream out, long maximumResults)	Run a saved query and write the result to the given output stream.
void	setErrorHandler(ResponseErrorHandler handler)	Set the error handler.
void	setHttpRequestFactory(ClientHttpRequestFactory factory)	Set the request factory.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected Logger logger

Logger.

httpRequestFactory

protected ClientHttpRequestFactory httpRequestFactory

Client request factory.

errorHandler

protected ResponseErrorHandler errorHandler

The error handler.

Constructor Details

SavedQueryRunner

public SavedQueryRunner()

Constructor.

Method Details

setHttpRequestFactory

@Autowired
@Qualifier("clarityClientHttpRequestFactory")
public void setHttpRequestFactory(ClientHttpRequestFactory factory)

Set the request factory.

Parameters:

factory - The HTTP request factory.

setErrorHandler

@Autowired
@Qualifier("clarityExceptionErrorHandler")
public void setErrorHandler(ResponseErrorHandler handler)

Set the error handler.

Parameters:

handler - The error handler.

runSavedQuery

public SavedQuerySummary runSavedQuery(Linkable<SavedQuery> query,
 OutputStream out,
 long maximumResults)
                                throws IOException

Run a saved query and write the result to the given output stream.

Parameters:

query - The saved query to run.

out - The stream to write to. Must be open.

maximumResults - The maximum number of results to return. If negative, don't set a limit.

Returns:

A summary of the report returned.

Throws:

IOException - if there is a problem writing to the output stream.

ClarityException - if there is an error reported back from Clarity.

InvalidURIException - in the near impossible case of the query URI being invalid.

See Also:

• ClarityAPI.runSavedQuery(Linkable, OutputStream, long)