public abstract class AbstractCollectorConfig extends Object implements ICollectorConfig
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_LOGS_DIR
Default relative directory where logs from Log4j are stored.
|
static String |
DEFAULT_PROGRESS_DIR
Default relative directory where progress files are stored.
|
Constructor and Description |
---|
AbstractCollectorConfig() |
AbstractCollectorConfig(Class<? extends ICrawlerConfig> crawlerConfigClass) |
AbstractCollectorConfig(Class<? extends ICrawlerConfig> crawlerConfigClass,
String xmlConfigRootTag) |
AbstractCollectorConfig(String xmlConfigRootTag) |
Modifier and Type | Method and Description |
---|---|
protected <T> T[] |
defaultIfEmpty(T[] array,
T[] defaultArray) |
boolean |
equals(Object other) |
ICollectorLifeCycleListener[] |
getCollectorListeners()
Gets collector life cycle listeners.
|
ICrawlerConfig[] |
getCrawlerConfigs()
Gets all crawler configurations.
|
String |
getId()
Gets this collector unique identifier.
|
IJobErrorListener[] |
getJobErrorListeners()
Gets JEF error listeners.
|
IJobLifeCycleListener[] |
getJobLifeCycleListeners()
Gets JEF job life cycle listeners.
|
String |
getLogsDir()
Gets the directory location of generated log files.
|
int |
getMaxParallelCrawlers()
Gets the maximum number of crawlers that can be executed in parallel at
any given time.
|
String |
getProgressDir()
Gets the directory location where progress files (from JEF API)
are stored.
|
ISuiteLifeCycleListener[] |
getSuiteLifeCycleListeners()
Gets JEF job suite life cycle listeners.
|
int |
hashCode() |
boolean |
isLogsUnmanaged()
Gets whether written logs are managed by the collector.
|
protected abstract void |
loadCollectorConfigFromXML(XMLConfiguration xml) |
void |
loadFromXML(Reader in) |
protected abstract void |
saveCollectorConfigToXML(Writer out) |
void |
saveToXML(Writer out) |
void |
setCollectorListeners(ICollectorLifeCycleListener... collectorListeners)
Sets collector life cycle listeners.
|
void |
setCrawlerConfigs(ICrawlerConfig... crawlerConfigs)
Sets crawler configurations.
|
void |
setId(String id)
Sets this collector unique identifier.
|
void |
setJobErrorListeners(IJobErrorListener... errorListeners)
Sets JEF error listeners.
|
void |
setJobLifeCycleListeners(IJobLifeCycleListener... jobLifeCycleListeners)
Sets JEF job life cycle listeners.
|
void |
setLogsDir(String logsDir)
Sets the directory location of generated log files.
|
void |
setLogsUnmanaged(boolean logsUnmanaged)
Sets whether written logs are managed by the collector.
|
void |
setMaxParallelCrawlers(int maxParallelCrawlers)
Sets the maximum number of crawlers that can be executed in parallel at
any given time.
|
void |
setProgressDir(String progressDir)
Sets the directory location where progress files (from JEF API)
are stored.
|
void |
setSuiteLifeCycleListeners(ISuiteLifeCycleListener... suiteLifeCycleListeners)
Sets JEF job suite life cycle listeners.
|
String |
toString() |
protected void |
writeArray(Writer out,
String listTagName,
String objectTagName,
Object[] array) |
protected void |
writeObject(Writer out,
String tagName,
Object object) |
protected void |
writeObject(Writer out,
String tagName,
Object object,
boolean ignore) |
public static final String DEFAULT_LOGS_DIR
public static final String DEFAULT_PROGRESS_DIR
public AbstractCollectorConfig()
public AbstractCollectorConfig(Class<? extends ICrawlerConfig> crawlerConfigClass)
public AbstractCollectorConfig(String xmlConfigRootTag)
public AbstractCollectorConfig(Class<? extends ICrawlerConfig> crawlerConfigClass, String xmlConfigRootTag)
public String getId()
getId
in interface ICollectorConfig
public void setId(String id)
id
- unique identifierpublic ICrawlerConfig[] getCrawlerConfigs()
ICollectorConfig
getCrawlerConfigs
in interface ICollectorConfig
public void setCrawlerConfigs(ICrawlerConfig... crawlerConfigs)
crawlerConfigs
- crawler configurationspublic String getProgressDir()
getProgressDir
in interface ICollectorConfig
public void setProgressDir(String progressDir)
progressDir
- progress directory pathpublic String getLogsDir()
getLogsDir
in interface ICollectorConfig
public void setLogsDir(String logsDir)
logsDir
- logs directory pathpublic boolean isLogsUnmanaged()
isLogsUnmanaged
in interface ICollectorConfig
true
if unmanagedpublic void setLogsUnmanaged(boolean logsUnmanaged)
logsUnmanaged
- true
if unmanagedpublic int getMaxParallelCrawlers()
-1
, which means no maximum.getMaxParallelCrawlers
in interface ICollectorConfig
public void setMaxParallelCrawlers(int maxParallelCrawlers)
-1
for no maximum.maxParallelCrawlers
- number of maximum parallel crawlerspublic ICollectorLifeCycleListener[] getCollectorListeners()
ICollectorConfig
getCollectorListeners
in interface ICollectorConfig
public void setCollectorListeners(ICollectorLifeCycleListener... collectorListeners)
collectorListeners
- collector life cycle listeners.public IJobLifeCycleListener[] getJobLifeCycleListeners()
ICollectorConfig
null
.getJobLifeCycleListeners
in interface ICollectorConfig
public void setJobLifeCycleListeners(IJobLifeCycleListener... jobLifeCycleListeners)
jobLifeCycleListeners
- JEF job life cycle listeners.public IJobErrorListener[] getJobErrorListeners()
ICollectorConfig
null
.getJobErrorListeners
in interface ICollectorConfig
public void setJobErrorListeners(IJobErrorListener... errorListeners)
errorListeners
- JEF job error listenerspublic ISuiteLifeCycleListener[] getSuiteLifeCycleListeners()
ICollectorConfig
null
.getSuiteLifeCycleListeners
in interface ICollectorConfig
public void setSuiteLifeCycleListeners(ISuiteLifeCycleListener... suiteLifeCycleListeners)
suiteLifeCycleListeners
- JEF suite life cycle listenerspublic void saveToXML(Writer out) throws IOException
saveToXML
in interface IXMLConfigurable
IOException
protected abstract void saveCollectorConfigToXML(Writer out)
public final void loadFromXML(Reader in) throws IOException
loadFromXML
in interface IXMLConfigurable
IOException
protected abstract void loadCollectorConfigFromXML(XMLConfiguration xml)
protected void writeObject(Writer out, String tagName, Object object) throws IOException
IOException
protected void writeObject(Writer out, String tagName, Object object, boolean ignore) throws IOException
IOException
protected void writeArray(Writer out, String listTagName, String objectTagName, Object[] array) throws IOException
IOException
protected <T> T[] defaultIfEmpty(T[] array, T[] defaultArray)
Copyright © 2014–2021 Norconex Inc.. All rights reserved.