public interface IThrottledConnection
Modifier and Type | Field and Description |
---|---|
static String |
_rcsid |
static int |
FETCH_BAD_URI |
static int |
FETCH_CIRCULAR_REDIRECT |
static int |
FETCH_INTERRUPTED |
static int |
FETCH_IO_ERROR |
static int |
FETCH_NOT_TRIED |
static int |
FETCH_SEQUENCE_ERROR |
static int |
FETCH_UNKNOWN_ERROR |
Modifier and Type | Method and Description |
---|---|
void |
beginFetch(String fetchType)
Begin the fetch process.
|
void |
close()
Close the connection.
|
void |
destroy()
Destroy the connection.
|
void |
doneFetch(IVersionActivity activities)
Done with the fetch.
|
void |
executeFetch(String urlPath,
String userAgent,
String from,
boolean redirectOK,
String host,
FormData formData,
LoginCookies loginCookies)
Execute the fetch and get the return code.
|
LoginCookies |
getLastFetchCookies()
Get the last fetch cookies.
|
String |
getLimitedResponseBody(int maxSize,
String encoding)
Get limited response as a string.
|
InputStream |
getResponseBodyStream()
Get the response input stream.
|
int |
getResponseCode()
Get the http response code.
|
String |
getResponseHeader(String headerName)
Get a specified response header, if it exists.
|
Map<String,List<String>> |
getResponseHeaders()
Get response headers
|
boolean |
hasExpired(long currentTime)
Check whether the connection has expired.
|
void |
noteInterrupted(Throwable e)
Note that the connection fetch was interrupted by something.
|
void |
setAbortChecker(AbortChecker abortCheck)
Set the abort checker.
|
static final String _rcsid
static final int FETCH_NOT_TRIED
static final int FETCH_CIRCULAR_REDIRECT
static final int FETCH_BAD_URI
static final int FETCH_SEQUENCE_ERROR
static final int FETCH_IO_ERROR
static final int FETCH_INTERRUPTED
static final int FETCH_UNKNOWN_ERROR
void setAbortChecker(AbortChecker abortCheck)
boolean hasExpired(long currentTime)
currentTime
- is the current time to use to judge if a connection has expired.void beginFetch(String fetchType) throws ManifoldCFException, ServiceInterruption
fetchType
- is a short descriptive string describing the kind of fetch being requested. This
is used solely for logging purposes.ManifoldCFException
ServiceInterruption
void executeFetch(String urlPath, String userAgent, String from, boolean redirectOK, String host, FormData formData, LoginCookies loginCookies) throws ManifoldCFException, ServiceInterruption
urlPath
- is the path part of the url, e.g. "/robots.txt"userAgent
- is the value of the userAgent header to use.from
- is the value of the from header to use.redirectOK
- should be set to true if you want redirects to be automatically followed.host
- is the value to use as the "Host" header, or null to use the default.formData
- describes additional form arguments and how to fetch the page.loginCookies
- describes the cookies that should be in effect for this page fetch.ManifoldCFException
ServiceInterruption
int getResponseCode() throws ManifoldCFException, ServiceInterruption
ManifoldCFException
ServiceInterruption
LoginCookies getLastFetchCookies() throws ManifoldCFException, ServiceInterruption
ManifoldCFException
ServiceInterruption
Map<String,List<String>> getResponseHeaders() throws ManifoldCFException, ServiceInterruption
ManifoldCFException
ServiceInterruption
String getResponseHeader(String headerName) throws ManifoldCFException, ServiceInterruption
headerName
- is the name of the header.ManifoldCFException
ServiceInterruption
InputStream getResponseBodyStream() throws ManifoldCFException, ServiceInterruption
String getLimitedResponseBody(int maxSize, String encoding) throws ManifoldCFException, ServiceInterruption
void noteInterrupted(Throwable e)
void doneFetch(IVersionActivity activities) throws ManifoldCFException
ManifoldCFException
void close()
void destroy()