com.exalead.mercury.mami.fetch.v21

Class Fetcher

java.lang.Object

com.exalead.mercury.mami.fetch.v21.Fetcher

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class Fetcher
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Fetcher.ConfigRules
static class	Fetcher.Headers
static class	Fetcher.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classId
protected Fetcher.ConfigRules	configRules
int	connectTimeoutS
boolean	cookies
static int	DEFAULT_CONNECT_TIMEOUT_S
static boolean	DEFAULT_COOKIES
static long	DEFAULT_MAX_AGE_S
static int	DEFAULT_MAX_DOWNLOAD_TIME_S
static int	DEFAULT_READ_TIMEOUT_S
static boolean	DEFAULT_USE_CONNECT_FOR_HTTPS_OVER_PROXY
static boolean	DEFAULT_USE_CRAWL_CACHE
static int	DEFAULT_WRITE_TIMEOUT_S
java.lang.String	from
protected Fetcher.Headers	headers
long	maxAgeS
int	maxDownloadTimeS
java.lang.String	name
protected Fetcher.Parameters	parameters
java.lang.String	proxyAddr
java.lang.String	proxyDomain
java.lang.String	proxyPassword
java.lang.String	proxyUsername
int	readTimeoutS
java.lang.String	type
boolean	useConnectForHttpsOverProxy
boolean	useCrawlCache
java.lang.String	userAgent
int	writeTimeoutS

Constructor Summary

Constructors

Constructor and Description
Fetcher()
Fetcher(Fetcher o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Fetcher.
static Fetcher	fromString(java.lang.String s) String representation of this Fetcher.
java.lang.String	getClassId()
Fetcher.ConfigRules	getConfigRules()
int	getConnectTimeoutS()
java.lang.String	getFrom()
Fetcher.Headers	getHeaders()
long	getMaxAgeS() Max allowed age of docs fetched in cache.
int	getMaxDownloadTimeS()
java.lang.String	getName()
Fetcher.Parameters	getParameters()
java.lang.String	getProxyAddr()
java.lang.String	getProxyDomain()
java.lang.String	getProxyPassword()
java.lang.String	getProxyUsername()
int	getReadTimeoutS()
java.lang.String	getType()
java.lang.String	getUserAgent()
int	getWriteTimeoutS()
boolean	isCookies()
boolean	isUseConnectForHttpsOverProxy()
boolean	isUseCrawlCache() Crawl through crawl cache proxy.
Fetcher	makeCopy() Creates and returns a deep copy of this Fetcher.
static Fetcher	readFrom(java.io.InputStream is) Read this Fetcher from an XML fragment.
void	setClassId(java.lang.String classId)
void	setConfigRules(Fetcher.ConfigRules __value)
void	setConnectTimeoutS(int connectTimeoutS)
void	setCookies(boolean cookies)
void	setFrom(java.lang.String from)
void	setHeaders(Fetcher.Headers __value)
void	setMaxAgeS(long maxAgeS) Max allowed age of docs fetched in cache.
void	setMaxDownloadTimeS(int maxDownloadTimeS)
void	setName(java.lang.String name)
void	setParameters(Fetcher.Parameters __value)
void	setProxyAddr(java.lang.String proxyAddr)
void	setProxyDomain(java.lang.String proxyDomain)
void	setProxyPassword(java.lang.String proxyPassword)
void	setProxyUsername(java.lang.String proxyUsername)
void	setReadTimeoutS(int readTimeoutS)
void	setType(java.lang.String type)
void	setUseConnectForHttpsOverProxy(boolean useConnectForHttpsOverProxy)
void	setUseCrawlCache(boolean useCrawlCache) Crawl through crawl cache proxy.
void	setUserAgent(java.lang.String userAgent)
void	setWriteTimeoutS(int writeTimeoutS)
java.lang.String	toString() String representation of this Fetcher.
Fetcher	withClassId(java.lang.String classId)
Fetcher	withConfigRules(java.util.Collection<Config> __values)
Fetcher	withConfigRules(Config... __values)
Fetcher	withConfigRules(Fetcher.ConfigRules __value)
Fetcher	withConnectTimeoutS(int connectTimeoutS)
Fetcher	withConnectTimeoutS(java.lang.Integer connectTimeoutS)
Fetcher	withCookies(boolean cookies)
Fetcher	withCookies(java.lang.Boolean cookies)
Fetcher	withFrom(java.lang.String from)
Fetcher	withHeaders(java.util.Collection<Header> __values)
Fetcher	withHeaders(Fetcher.Headers __value)
Fetcher	withHeaders(Header... __values)
Fetcher	withMaxAgeS(long maxAgeS)
Fetcher	withMaxAgeS(java.lang.Long maxAgeS)
Fetcher	withMaxDownloadTimeS(int maxDownloadTimeS)
Fetcher	withMaxDownloadTimeS(java.lang.Integer maxDownloadTimeS)
Fetcher	withName(java.lang.String name)
Fetcher	withParameters(java.util.Collection<KeyValue> __values)
Fetcher	withParameters(Fetcher.Parameters __value)
Fetcher	withParameters(KeyValue... __values)
Fetcher	withProxyAddr(java.lang.String proxyAddr)
Fetcher	withProxyDomain(java.lang.String proxyDomain)
Fetcher	withProxyPassword(java.lang.String proxyPassword)
Fetcher	withProxyUsername(java.lang.String proxyUsername)
Fetcher	withReadTimeoutS(int readTimeoutS)
Fetcher	withReadTimeoutS(java.lang.Integer readTimeoutS)
Fetcher	withType(java.lang.String type)
Fetcher	withUseConnectForHttpsOverProxy(boolean useConnectForHttpsOverProxy)
Fetcher	withUseConnectForHttpsOverProxy(java.lang.Boolean useConnectForHttpsOverProxy)
Fetcher	withUseCrawlCache(boolean useCrawlCache)
Fetcher	withUseCrawlCache(java.lang.Boolean useCrawlCache)
Fetcher	withUserAgent(java.lang.String userAgent)
Fetcher	withWriteTimeoutS(int writeTimeoutS)
Fetcher	withWriteTimeoutS(java.lang.Integer writeTimeoutS)
void	writeTo(java.io.OutputStream os) Write this Fetcher as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

type

public java.lang.String type

classId

public java.lang.String classId

readTimeoutS

public int readTimeoutS

DEFAULT_READ_TIMEOUT_S

public static final int DEFAULT_READ_TIMEOUT_S

See Also:

Constant Field Values

writeTimeoutS

public int writeTimeoutS

DEFAULT_WRITE_TIMEOUT_S

public static final int DEFAULT_WRITE_TIMEOUT_S

See Also:

Constant Field Values

connectTimeoutS

public int connectTimeoutS

DEFAULT_CONNECT_TIMEOUT_S

public static final int DEFAULT_CONNECT_TIMEOUT_S

See Also:

Constant Field Values

maxDownloadTimeS

public int maxDownloadTimeS

DEFAULT_MAX_DOWNLOAD_TIME_S

public static final int DEFAULT_MAX_DOWNLOAD_TIME_S

See Also:

Constant Field Values

userAgent

public java.lang.String userAgent

from

public java.lang.String from

cookies

public boolean cookies

DEFAULT_COOKIES

public static final boolean DEFAULT_COOKIES

See Also:

Constant Field Values

proxyAddr

public java.lang.String proxyAddr

proxyUsername

public java.lang.String proxyUsername

proxyPassword

public java.lang.String proxyPassword

proxyDomain

public java.lang.String proxyDomain

useConnectForHttpsOverProxy

public boolean useConnectForHttpsOverProxy

DEFAULT_USE_CONNECT_FOR_HTTPS_OVER_PROXY

public static final boolean DEFAULT_USE_CONNECT_FOR_HTTPS_OVER_PROXY

See Also:

Constant Field Values

useCrawlCache

public boolean useCrawlCache

DEFAULT_USE_CRAWL_CACHE

public static final boolean DEFAULT_USE_CRAWL_CACHE

See Also:

Constant Field Values

maxAgeS

public long maxAgeS

DEFAULT_MAX_AGE_S

public static final long DEFAULT_MAX_AGE_S

See Also:

Constant Field Values

headers

protected Fetcher.Headers headers

parameters

protected Fetcher.Parameters parameters

configRules

protected Fetcher.ConfigRules configRules

Constructor Detail

Fetcher

public Fetcher()

Fetcher

public Fetcher(Fetcher o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public Fetcher withName(java.lang.String name)

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

withType

public Fetcher withType(java.lang.String type)

setClassId

public void setClassId(java.lang.String classId)

getClassId

public java.lang.String getClassId()

withClassId

public Fetcher withClassId(java.lang.String classId)

setReadTimeoutS

public void setReadTimeoutS(int readTimeoutS)

getReadTimeoutS

public int getReadTimeoutS()

withReadTimeoutS

public Fetcher withReadTimeoutS(int readTimeoutS)

withReadTimeoutS

public Fetcher withReadTimeoutS(java.lang.Integer readTimeoutS)

setWriteTimeoutS

public void setWriteTimeoutS(int writeTimeoutS)

getWriteTimeoutS

public int getWriteTimeoutS()

withWriteTimeoutS

public Fetcher withWriteTimeoutS(int writeTimeoutS)

withWriteTimeoutS

public Fetcher withWriteTimeoutS(java.lang.Integer writeTimeoutS)

setConnectTimeoutS

public void setConnectTimeoutS(int connectTimeoutS)

getConnectTimeoutS

public int getConnectTimeoutS()

withConnectTimeoutS

public Fetcher withConnectTimeoutS(int connectTimeoutS)

withConnectTimeoutS

public Fetcher withConnectTimeoutS(java.lang.Integer connectTimeoutS)

setMaxDownloadTimeS

public void setMaxDownloadTimeS(int maxDownloadTimeS)

getMaxDownloadTimeS

public int getMaxDownloadTimeS()

withMaxDownloadTimeS

public Fetcher withMaxDownloadTimeS(int maxDownloadTimeS)

withMaxDownloadTimeS

public Fetcher withMaxDownloadTimeS(java.lang.Integer maxDownloadTimeS)

setUserAgent

public void setUserAgent(java.lang.String userAgent)

getUserAgent

public java.lang.String getUserAgent()

withUserAgent

public Fetcher withUserAgent(java.lang.String userAgent)

setFrom

public void setFrom(java.lang.String from)

getFrom

public java.lang.String getFrom()

withFrom

public Fetcher withFrom(java.lang.String from)

setCookies

public void setCookies(boolean cookies)

isCookies

public boolean isCookies()

withCookies

public Fetcher withCookies(boolean cookies)

withCookies

public Fetcher withCookies(java.lang.Boolean cookies)

setProxyAddr

public void setProxyAddr(java.lang.String proxyAddr)

getProxyAddr

public java.lang.String getProxyAddr()

withProxyAddr

public Fetcher withProxyAddr(java.lang.String proxyAddr)

setProxyUsername

public void setProxyUsername(java.lang.String proxyUsername)

getProxyUsername

public java.lang.String getProxyUsername()

withProxyUsername

public Fetcher withProxyUsername(java.lang.String proxyUsername)

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

getProxyPassword

public java.lang.String getProxyPassword()

withProxyPassword

public Fetcher withProxyPassword(java.lang.String proxyPassword)

setProxyDomain

public void setProxyDomain(java.lang.String proxyDomain)

getProxyDomain

public java.lang.String getProxyDomain()

withProxyDomain

public Fetcher withProxyDomain(java.lang.String proxyDomain)

setUseConnectForHttpsOverProxy

public void setUseConnectForHttpsOverProxy(boolean useConnectForHttpsOverProxy)

isUseConnectForHttpsOverProxy

public boolean isUseConnectForHttpsOverProxy()

withUseConnectForHttpsOverProxy

public Fetcher withUseConnectForHttpsOverProxy(boolean useConnectForHttpsOverProxy)

withUseConnectForHttpsOverProxy

public Fetcher withUseConnectForHttpsOverProxy(java.lang.Boolean useConnectForHttpsOverProxy)

setUseCrawlCache

public void setUseCrawlCache(boolean useCrawlCache)

Crawl through crawl cache proxy. (WebExperiencePlatform mode).

isUseCrawlCache

public boolean isUseCrawlCache()

Crawl through crawl cache proxy. (WebExperiencePlatform mode).

withUseCrawlCache

public Fetcher withUseCrawlCache(boolean useCrawlCache)

withUseCrawlCache

public Fetcher withUseCrawlCache(java.lang.Boolean useCrawlCache)

setMaxAgeS

public void setMaxAgeS(long maxAgeS)

Max allowed age of docs fetched in cache. Older docs are recrawled. Default is 1 month

getMaxAgeS

public long getMaxAgeS()

Max allowed age of docs fetched in cache. Older docs are recrawled. Default is 1 month

withMaxAgeS

public Fetcher withMaxAgeS(long maxAgeS)

withMaxAgeS

public Fetcher withMaxAgeS(java.lang.Long maxAgeS)

getHeaders

public Fetcher.Headers getHeaders()

setHeaders

public void setHeaders(Fetcher.Headers __value)

withHeaders

public Fetcher withHeaders(Header... __values)

withHeaders

public Fetcher withHeaders(java.util.Collection<Header> __values)

withHeaders

public Fetcher withHeaders(Fetcher.Headers __value)

getParameters

public Fetcher.Parameters getParameters()

setParameters

public void setParameters(Fetcher.Parameters __value)

withParameters

public Fetcher withParameters(KeyValue... __values)

withParameters

public Fetcher withParameters(java.util.Collection<KeyValue> __values)

withParameters

public Fetcher withParameters(Fetcher.Parameters __value)

getConfigRules

public Fetcher.ConfigRules getConfigRules()

setConfigRules

public void setConfigRules(Fetcher.ConfigRules __value)

withConfigRules

public Fetcher withConfigRules(Config... __values)

withConfigRules

public Fetcher withConfigRules(java.util.Collection<Config> __values)

withConfigRules

public Fetcher withConfigRules(Fetcher.ConfigRules __value)

makeCopy

public Fetcher makeCopy()

Creates and returns a deep copy of this Fetcher.

readFrom

public static Fetcher readFrom(java.io.InputStream is)
                        throws javax.xml.bind.JAXBException

Read this Fetcher from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this Fetcher as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static Fetcher fromString(java.lang.String s)
                          throws javax.xml.bind.JAXBException,
                                 java.io.UnsupportedEncodingException

String representation of this Fetcher.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Fetcher.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this Fetcher.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException