com.exalead.mercury.mami.fetch.v21

Class FetchConfig

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.fetch.v21.FetchConfig

All Implemented Interfaces:

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

public class FetchConfig
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable

Data model //

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FetchConfig.Mimes

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	crawlCacheProxyAddress
java.lang.String	crawlCacheProxyPassword
java.lang.String	crawlCacheProxyUsername
long	crawlCacheRequestTimeoutMS
static long	DEFAULT_CRAWL_CACHE_REQUEST_TIMEOUT_M_S
static boolean	DEFAULT_DEFAULT_TRUNCATE
static int	DEFAULT_FULL_DOCUMENT_MAX_SIZE_K_B
static int	DEFAULT_SESSION_LIFETIME
java.lang.String	defaultFetcher
int	defaultMaxSizeKB
boolean	defaultTruncate
java.lang.String	dnsServer
java.util.List<Fetcher>	fetcher
int	fullDocumentMaxSizeKB
java.lang.String	globalProxyDomain
java.lang.String	globalProxyHost
java.lang.String	globalProxyPassword
int	globalProxyPort
java.lang.String	globalProxyUsername
protected FetchConfig.Mimes	mimes
java.lang.String	nonProxyHosts
int	sessionLifetime

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FetchConfig.
static FetchConfig	fromString(java.lang.String s) String representation of this FetchConfig.
java.lang.String	getCrawlCacheProxyAddress() Crawl through multibox (WebExperiencePlatform mode).
java.lang.String	getCrawlCacheProxyPassword()
java.lang.String	getCrawlCacheProxyUsername()
long	getCrawlCacheRequestTimeoutMS()
java.lang.String	getDefaultFetcher()
int	getDefaultMaxSizeKB()
java.lang.String	getDnsServer()
java.util.List<Fetcher>	getFetcher()
java.util.Map<java.lang.String,Fetcher>	getFetcherAsMap() Get the map of Fetcher, indexed by name
Fetcher	getFetcherByName(java.lang.String _lookup) Get the Fetcher for which the name matches _lookup
int	getFullDocumentMaxSizeKB()
java.lang.String	getGlobalProxyDomain()
java.lang.String	getGlobalProxyHost()
java.lang.String	getGlobalProxyPassword()
int	getGlobalProxyPort()
java.lang.String	getGlobalProxyUsername()
FetchConfig.Mimes	getMimes()
java.lang.String	getNonProxyHosts()
int	getSessionLifetime() Cookie session lifetime in seconds
boolean	isDefaultTruncate()
FetchConfig	makeCopy() Creates and returns a deep copy of this FetchConfig.
static FetchConfig	readFrom(java.io.InputStream is) Read this FetchConfig from an XML fragment.
boolean	removeFetcherByName(java.lang.String _lookup) Removes the Fetcher for which the name matches _lookup
void	setCrawlCacheProxyAddress(java.lang.String crawlCacheProxyAddress) Crawl through multibox (WebExperiencePlatform mode).
void	setCrawlCacheProxyPassword(java.lang.String crawlCacheProxyPassword)
void	setCrawlCacheProxyUsername(java.lang.String crawlCacheProxyUsername)
void	setCrawlCacheRequestTimeoutMS(long crawlCacheRequestTimeoutMS)
void	setDefaultFetcher(java.lang.String defaultFetcher)
void	setDefaultMaxSizeKB(int defaultMaxSizeKB)
void	setDefaultTruncate(boolean defaultTruncate)
void	setDnsServer(java.lang.String dnsServer)
void	setFullDocumentMaxSizeKB(int fullDocumentMaxSizeKB)
void	setGlobalProxyDomain(java.lang.String globalProxyDomain)
void	setGlobalProxyHost(java.lang.String globalProxyHost)
void	setGlobalProxyPassword(java.lang.String globalProxyPassword)
void	setGlobalProxyPort(int globalProxyPort)
void	setGlobalProxyUsername(java.lang.String globalProxyUsername)
void	setMimes(FetchConfig.Mimes __value)
void	setNonProxyHosts(java.lang.String nonProxyHosts)
void	setSessionLifetime(int sessionLifetime) Cookie session lifetime in seconds
java.lang.String	toString() String representation of this FetchConfig.
FetchConfig	withCrawlCacheProxyAddress(java.lang.String crawlCacheProxyAddress)
FetchConfig	withCrawlCacheProxyPassword(java.lang.String crawlCacheProxyPassword)
FetchConfig	withCrawlCacheProxyUsername(java.lang.String crawlCacheProxyUsername)
FetchConfig	withCrawlCacheRequestTimeoutMS(long crawlCacheRequestTimeoutMS)
FetchConfig	withCrawlCacheRequestTimeoutMS(java.lang.Long crawlCacheRequestTimeoutMS)
FetchConfig	withDefaultFetcher(java.lang.String defaultFetcher)
FetchConfig	withDefaultMaxSizeKB(int defaultMaxSizeKB)
FetchConfig	withDefaultMaxSizeKB(java.lang.Integer defaultMaxSizeKB)
FetchConfig	withDefaultTruncate(boolean defaultTruncate)
FetchConfig	withDefaultTruncate(java.lang.Boolean defaultTruncate)
FetchConfig	withDnsServer(java.lang.String dnsServer)
FetchConfig	withFetcher(java.util.Collection<Fetcher> __values)
FetchConfig	withFetcher(Fetcher... __values)
FetchConfig	withFullDocumentMaxSizeKB(int fullDocumentMaxSizeKB)
FetchConfig	withFullDocumentMaxSizeKB(java.lang.Integer fullDocumentMaxSizeKB)
FetchConfig	withGlobalProxyDomain(java.lang.String globalProxyDomain)
FetchConfig	withGlobalProxyHost(java.lang.String globalProxyHost)
FetchConfig	withGlobalProxyPassword(java.lang.String globalProxyPassword)
FetchConfig	withGlobalProxyPort(int globalProxyPort)
FetchConfig	withGlobalProxyPort(java.lang.Integer globalProxyPort)
FetchConfig	withGlobalProxyUsername(java.lang.String globalProxyUsername)
FetchConfig	withMimes(java.util.Collection<MimeConfig> __values)
FetchConfig	withMimes(FetchConfig.Mimes __value)
FetchConfig	withMimes(MimeConfig... __values)
FetchConfig	withNonProxyHosts(java.lang.String nonProxyHosts)
FetchConfig	withSessionLifetime(int sessionLifetime)
FetchConfig	withSessionLifetime(java.lang.Integer sessionLifetime)
FetchConfig	withVersion(long version)
FetchConfig	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this FetchConfig as an XML fragment

Methods inherited from class exa.bee.config.Versioned

clone, getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

fetcher

public java.util.List<Fetcher> fetcher

defaultFetcher

public java.lang.String defaultFetcher

dnsServer

public java.lang.String dnsServer

defaultMaxSizeKB

public int defaultMaxSizeKB

defaultTruncate

public boolean defaultTruncate

DEFAULT_DEFAULT_TRUNCATE

public static final boolean DEFAULT_DEFAULT_TRUNCATE

See Also:

Constant Field Values

sessionLifetime

public int sessionLifetime

DEFAULT_SESSION_LIFETIME

public static final int DEFAULT_SESSION_LIFETIME

See Also:

Constant Field Values

fullDocumentMaxSizeKB

public int fullDocumentMaxSizeKB

DEFAULT_FULL_DOCUMENT_MAX_SIZE_K_B

public static final int DEFAULT_FULL_DOCUMENT_MAX_SIZE_K_B

See Also:

Constant Field Values

mimes

protected FetchConfig.Mimes mimes

crawlCacheProxyAddress

public java.lang.String crawlCacheProxyAddress

crawlCacheProxyUsername

public java.lang.String crawlCacheProxyUsername

crawlCacheProxyPassword

public java.lang.String crawlCacheProxyPassword

crawlCacheRequestTimeoutMS

public long crawlCacheRequestTimeoutMS

DEFAULT_CRAWL_CACHE_REQUEST_TIMEOUT_M_S

public static final long DEFAULT_CRAWL_CACHE_REQUEST_TIMEOUT_M_S

See Also:

Constant Field Values

globalProxyHost

public java.lang.String globalProxyHost

globalProxyPort

public int globalProxyPort

globalProxyUsername

public java.lang.String globalProxyUsername

globalProxyPassword

public java.lang.String globalProxyPassword

globalProxyDomain

public java.lang.String globalProxyDomain

nonProxyHosts

public java.lang.String nonProxyHosts

Constructor Detail

FetchConfig

public FetchConfig()

FetchConfig

public FetchConfig(FetchConfig o)

Copy constructor

Method Detail

withVersion

public FetchConfig withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public FetchConfig withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

getFetcher

public java.util.List<Fetcher> getFetcher()

getFetcherByName

public Fetcher getFetcherByName(java.lang.String _lookup)

Get the Fetcher for which the name matches _lookup

Returns:

null if no matching Fetcher is found

getFetcherAsMap

public java.util.Map<java.lang.String,Fetcher> getFetcherAsMap()

Get the map of Fetcher, indexed by name

removeFetcherByName

public boolean removeFetcherByName(java.lang.String _lookup)

Removes the Fetcher for which the name matches _lookup

Returns:

false if no matching Fetcher is found, true if one was found

withFetcher

public FetchConfig withFetcher(Fetcher... __values)

withFetcher

public FetchConfig withFetcher(java.util.Collection<Fetcher> __values)

setDefaultFetcher

public void setDefaultFetcher(java.lang.String defaultFetcher)

getDefaultFetcher

public java.lang.String getDefaultFetcher()

withDefaultFetcher

public FetchConfig withDefaultFetcher(java.lang.String defaultFetcher)

setDnsServer

public void setDnsServer(java.lang.String dnsServer)

getDnsServer

public java.lang.String getDnsServer()

withDnsServer

public FetchConfig withDnsServer(java.lang.String dnsServer)

setDefaultMaxSizeKB

public void setDefaultMaxSizeKB(int defaultMaxSizeKB)

getDefaultMaxSizeKB

public int getDefaultMaxSizeKB()

withDefaultMaxSizeKB

public FetchConfig withDefaultMaxSizeKB(int defaultMaxSizeKB)

withDefaultMaxSizeKB

public FetchConfig withDefaultMaxSizeKB(java.lang.Integer defaultMaxSizeKB)

setDefaultTruncate

public void setDefaultTruncate(boolean defaultTruncate)

isDefaultTruncate

public boolean isDefaultTruncate()

withDefaultTruncate

public FetchConfig withDefaultTruncate(boolean defaultTruncate)

withDefaultTruncate

public FetchConfig withDefaultTruncate(java.lang.Boolean defaultTruncate)

setSessionLifetime

public void setSessionLifetime(int sessionLifetime)

Cookie session lifetime in seconds

getSessionLifetime

public int getSessionLifetime()

Cookie session lifetime in seconds

withSessionLifetime

public FetchConfig withSessionLifetime(int sessionLifetime)

withSessionLifetime

public FetchConfig withSessionLifetime(java.lang.Integer sessionLifetime)

setFullDocumentMaxSizeKB

public void setFullDocumentMaxSizeKB(int fullDocumentMaxSizeKB)

getFullDocumentMaxSizeKB

public int getFullDocumentMaxSizeKB()

withFullDocumentMaxSizeKB

public FetchConfig withFullDocumentMaxSizeKB(int fullDocumentMaxSizeKB)

withFullDocumentMaxSizeKB

public FetchConfig withFullDocumentMaxSizeKB(java.lang.Integer fullDocumentMaxSizeKB)

getMimes

public FetchConfig.Mimes getMimes()

setMimes

public void setMimes(FetchConfig.Mimes __value)

withMimes

public FetchConfig withMimes(MimeConfig... __values)

withMimes

public FetchConfig withMimes(java.util.Collection<MimeConfig> __values)

withMimes

public FetchConfig withMimes(FetchConfig.Mimes __value)

setCrawlCacheProxyAddress

public void setCrawlCacheProxyAddress(java.lang.String crawlCacheProxyAddress)

Crawl through multibox (WebExperiencePlatform mode).

getCrawlCacheProxyAddress

public java.lang.String getCrawlCacheProxyAddress()

Crawl through multibox (WebExperiencePlatform mode).

withCrawlCacheProxyAddress

public FetchConfig withCrawlCacheProxyAddress(java.lang.String crawlCacheProxyAddress)

setCrawlCacheProxyUsername

public void setCrawlCacheProxyUsername(java.lang.String crawlCacheProxyUsername)

getCrawlCacheProxyUsername

public java.lang.String getCrawlCacheProxyUsername()

withCrawlCacheProxyUsername

public FetchConfig withCrawlCacheProxyUsername(java.lang.String crawlCacheProxyUsername)

setCrawlCacheProxyPassword

public void setCrawlCacheProxyPassword(java.lang.String crawlCacheProxyPassword)

getCrawlCacheProxyPassword

public java.lang.String getCrawlCacheProxyPassword()

withCrawlCacheProxyPassword

public FetchConfig withCrawlCacheProxyPassword(java.lang.String crawlCacheProxyPassword)

setCrawlCacheRequestTimeoutMS

public void setCrawlCacheRequestTimeoutMS(long crawlCacheRequestTimeoutMS)

getCrawlCacheRequestTimeoutMS

public long getCrawlCacheRequestTimeoutMS()

withCrawlCacheRequestTimeoutMS

public FetchConfig withCrawlCacheRequestTimeoutMS(long crawlCacheRequestTimeoutMS)

withCrawlCacheRequestTimeoutMS

public FetchConfig withCrawlCacheRequestTimeoutMS(java.lang.Long crawlCacheRequestTimeoutMS)

setGlobalProxyHost

public void setGlobalProxyHost(java.lang.String globalProxyHost)

getGlobalProxyHost

public java.lang.String getGlobalProxyHost()

withGlobalProxyHost

public FetchConfig withGlobalProxyHost(java.lang.String globalProxyHost)

setGlobalProxyPort

public void setGlobalProxyPort(int globalProxyPort)

getGlobalProxyPort

public int getGlobalProxyPort()

withGlobalProxyPort

public FetchConfig withGlobalProxyPort(int globalProxyPort)

withGlobalProxyPort

public FetchConfig withGlobalProxyPort(java.lang.Integer globalProxyPort)

setGlobalProxyUsername

public void setGlobalProxyUsername(java.lang.String globalProxyUsername)

getGlobalProxyUsername

public java.lang.String getGlobalProxyUsername()

withGlobalProxyUsername

public FetchConfig withGlobalProxyUsername(java.lang.String globalProxyUsername)

setGlobalProxyPassword

public void setGlobalProxyPassword(java.lang.String globalProxyPassword)

getGlobalProxyPassword

public java.lang.String getGlobalProxyPassword()

withGlobalProxyPassword

public FetchConfig withGlobalProxyPassword(java.lang.String globalProxyPassword)

setGlobalProxyDomain

public void setGlobalProxyDomain(java.lang.String globalProxyDomain)

getGlobalProxyDomain

public java.lang.String getGlobalProxyDomain()

withGlobalProxyDomain

public FetchConfig withGlobalProxyDomain(java.lang.String globalProxyDomain)

setNonProxyHosts

public void setNonProxyHosts(java.lang.String nonProxyHosts)

getNonProxyHosts

public java.lang.String getNonProxyHosts()

withNonProxyHosts

public FetchConfig withNonProxyHosts(java.lang.String nonProxyHosts)

makeCopy

public FetchConfig makeCopy()

Creates and returns a deep copy of this FetchConfig.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

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

Read this FetchConfig 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 FetchConfig as an XML fragment

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FetchConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FetchConfig.

Overrides:

toString in class exa.bee.config.Versioned

check

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

Checks this FetchConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException