|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.rmi.server.RemoteObject java.rmi.server.RemoteServer java.rmi.server.UnicastRemoteObject atg.nucleus.GenericRMIService atg.repository.search.indexing.IndexingOutputConfig
public class IndexingOutputConfig
Specifies output options, the most important of which is the XML files that define which properties are emitted for indexing. This class is the central configuration class for specifyhing the output that will be sent to the indexer.
The output from this class can be farther customized by
the use of PropertyFormatter
s, PropertyAccessor
s and
VariantProducer
s.
Created: February 16 2005
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.ThreadLocal |
mDocumentSubmitterTL
|
protected int |
mJobId
the jobId of our scheduled task |
static java.lang.String[] |
REQUIRED_DOCUMENT_OUTPUT_PROPERTIES
The list of output properties required for documents. |
static java.lang.String[] |
REQUIRED_EVERY_ITEM_OUTPUT_PROPERTIES
The list of output properties required for every repository item. |
Fields inherited from class atg.nucleus.GenericRMIService |
---|
SERVICE_INFO_KEY |
Fields inherited from class java.rmi.server.RemoteObject |
---|
ref |
Fields inherited from interface atg.repository.search.indexing.IndexingConstants |
---|
BASE_URL_OUTPUT_PROPERTY_NAME, CONTEXT_OUTPUT_PROPERTY_NAME, DEFAULT_FORMATTER_KEY, PROP_TYPE_BOOLEAN, PROP_TYPE_DATE, PROP_TYPE_ENUM, PROP_TYPE_FLOAT, PROP_TYPE_INTEGER, PROP_TYPE_STRING, PROP_TYPE_TEXT, PROP_TYPE_UNKNOWN, URL_OUTPUT_PROPERTY_NAME |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
IndexingOutputConfig()
constructor |
Method Summary | |
---|---|
protected void |
addBasicFilters()
Add in the basic filter to the filterMap . |
protected void |
addBasicFormatters()
Add in the basic formatters to the formatterMap . |
protected void |
addBasicPropertyAccessors()
Add in the basic property accessors to the propertyAccessorMap . |
protected void |
addDocumentLevelSpecifiers(OutputItemSpecifier pSpecifier,
java.util.List pListFound)
Add the the document-level specifier(s) to pListFound. |
void |
afterSessionStart(Context pContext)
This method is invoked immediately after a DocumentSubmitter session is closed. |
boolean |
allowPeriodicIndexing()
Whether to allow scheduled indexing. |
void |
beforeSessionEnd(Context pContext)
This method is invoked immediately before a DocumentSubmitter session is closed. |
java.lang.String |
buildUriForRepositoryItem(Context pContext,
Repository pRepository,
ConfigRepositoryItemChanged pItemChanged)
|
boolean |
bulkLoad()
Perform a bulk load (full index). |
boolean |
bulkLoad(DocumentSubmitterSession pSession)
Perform a bulk load (full index). |
boolean |
bulkLoad(java.lang.String pSubmitterId,
java.lang.String pSessionId,
java.lang.String pCallbackUrl)
bulk load |
boolean |
bulkLoadWithRetry()
BulkLoad and keep retrying if someone else has currently claimed the configuration. |
boolean |
bulkLoadWithRetry(DocumentSubmitterSession pDocSubSession)
BulkLoad and keep retrying if someone else has currently claimed the configuration. |
protected void |
calculateOutputPropertyNames()
Calculate the various output properties. |
protected java.lang.String[] |
calculateOutputPropertyNames(java.lang.Boolean pIsMeta)
Calculate the output property names. |
boolean |
cancelBulkLoad()
cancel bulk load |
boolean |
cancelIncrementalUpdate()
cancel incremental update |
void |
clearIterationState(Context pContext)
|
protected boolean |
containsString(java.lang.String pString,
java.lang.String[] pStrings)
Whether the string array pStrings
contains the specified string pString . |
protected void |
correctRepositoryPath(ItemType pType)
correct the repository path to reflect the path of the unversioned repository |
void |
doStartService()
Start up the service, parsing the definition file, etc. |
void |
doStopService()
The default implementation is to just stop our scheduled job. |
boolean |
executeSynchronizationsOnly()
Do an incremental update, but only run the synchronizations, do NOT process any queued updates. |
protected void |
exportAsRemoteService()
export this IndexingOutputConfig as a remote service that can be accessed via the RmiServer |
static void |
getAllOutputItemSpecifiers(java.util.List pResults,
OutputItemSpecifier pSpecifier)
Recursively build list of all OutputItemSpecifier objects |
java.lang.String[] |
getAllOutputPropertyNames()
Get both the text and meta output property names. |
BulkLoader |
getBulkLoader()
Get the bulk loader used to bulk (full) index. |
int |
getBulkLoadWithRetryMinutes()
Get the number of minutes to keep trying bulkLoadWithRetry. |
Schedule |
getBulkSchedule()
Get property bulkschedule . |
int |
getBulkScheduleConsiderIndexedMinutes()
Get the number of minutes to consider content already indexed for a scheduled bulk load. |
Scheduler |
getBulkScheduler()
Get property bulkscheduler . |
PropertyFormatter |
getDefaultFormatter()
Get the default formatter used to format property values. |
PropertyAccessor |
getDefaultPropertyAccessor()
Get the default property accessor. |
atg.xml.XMLFile |
getDefinitionFile()
The indexing output definition file. |
java.lang.String[] |
getDocumentLevelOutputProperties()
Get the list of output properties that will be added to the document-level item. |
OutputItemSpecifier[] |
getDocumentLevelSpecifiers()
Return the document-level specifiers. |
DocumentSubmitter |
getDocumentSubmitter()
Get the document submitter, used to submit documents to the indexing engine. |
java.lang.String[] |
getEveryItemOutputProperties()
Get the list of output properties that will be added to every repository item. |
ServiceMap |
getFilterMap()
Get the filter map. |
ServiceMap |
getFormatterMap()
Get the formatter map. |
IncrementalLoader |
getIncrementalLoader()
Whether to enable to incremental loader at startup. |
int |
getIncrementalUpdateMinutes()
The number of minutes between incremental updates. |
IndexingSynchronization[] |
getIndexingSynchronizations()
Get the array of indexing synchronizations. |
java.util.Set |
getItemDescriptors()
Get the set of all configured item descriptors |
IterationProducer |
getIterationProducer()
Get the iteration producer. |
java.lang.String |
getJobDescription()
Get property jobDescription |
java.lang.String |
getJobName()
Get property jobName |
int |
getMaxFailuresAllowedForCommitting()
The maximum number of failures allowed when committing a document submitter session. |
int |
getMaxIncrementalChangesPerGeneration()
The maximum number of repository item changes to queue up in a single generation. |
java.lang.String[] |
getMetaOutputPropertyNames()
Get both the meta output property names. |
OutputItemSpecifier |
getOutputItemSpecifier()
The output item specifier created from the specified definitionFile . |
protected java.util.List |
getOutputProperties(java.lang.Boolean pIsMeta)
Get the specified output properties from all the elements of the hierarchy. |
ServiceMap |
getPropertyAccessorMap()
Get propertyAccessorMap... |
Repository |
getRepository()
Optional override of definition file repository specification. |
RepositoryItemGroup |
getRepositoryItemGroup()
Optional override for definition file repository-item-group component setting. |
java.lang.String[] |
getRequiredEveryItemOutputProperties()
Get an array of required output properties for every indexed item. |
atg.server.rmi.RmiServer |
getRmiServer()
get RmiServer |
Schedule |
getSchedule()
Get property schedule |
Scheduler |
getScheduler()
Get property scheduler |
java.lang.String |
getTargetName()
get TargetName |
java.lang.String |
getTextActiveZones()
Get the text active zones. |
java.lang.String[] |
getTextOutputPropertyNames()
Get both the text output property names. |
int |
getThreadMethod()
Get property threadMethod |
Repository |
getTopLevelItemRepository()
Return the repository that corresponds to the top-level "item" element in the definition file. |
java.lang.String |
getUnversionedRepositoryPath()
get UnversionedRepositoryPath |
java.lang.String |
getUriForRepositoryItem(Context pContext,
RepositoryItem pItem)
Get a URI for the specified item |
VariantProducer[] |
getVariantProducers()
Get the array of variant producers. |
java.lang.String |
getVersionedRepositoryPath()
get VersionedRepositoryPath |
void |
incrementallyLoad()
Start the incremental loading functionality. |
void |
indexedItem(Context pContext,
RepositoryItem pItem)
Notification that specific item has been used to build an indexed document. |
boolean |
isEnableIncrementalLoading()
Whether to enabled incremental loading. |
boolean |
isEnableScheduledBulkLoading()
Whether scheduled bulk loading is enabled. |
boolean |
isFilterOutDollarOutputPropertyNames()
Whether to filter out properties containing "$" from the various "outputPropertyName" properties. |
boolean |
isOnPubServer()
get OnPubServer |
boolean |
isTransactional()
Returns property Transactional |
protected ItemType |
jaxbParseFile()
Parse the definition and return the jaxb generated item type. |
void |
performAction()
Implements the PostStartupAction interface. |
void |
performScheduledTask(Scheduler pScheduler,
ScheduledJob pJob)
Called by the scheduler when it is time for this service to perform its function. |
boolean |
processQueuedIncrementalUpdates()
Process any queued incremental updates |
boolean |
processQueuedIncrementalUpdates(java.lang.String pSubmitterId,
java.lang.String pSessionId,
java.lang.String pCallbackUrl)
process queued incremental updates |
void |
setBulkLoader(BulkLoader pBulkLoader)
Set the bulk loader used to bulk (full) index. |
void |
setBulkLoadWithRetryMinutes(int pBulkLoadWithRetryMinutes)
Set the number of minutes to keep trying bulkLoadWithRetry. |
void |
setBulkSchedule(Schedule pBulkSchedule)
Set property bulkSchedule . |
void |
setBulkScheduleConsiderIndexedMinutes(int pBulkScheduleConsiderIndexedMinutes)
Set the number of minutes to consider content already indexed for a bulk load. |
void |
setBulkScheduler(Scheduler pBulkScheduler)
Set property bulkScheduler . |
void |
setDefaultFormatter(PropertyFormatter pDefaultFormatter)
Set the default formatter used to format property values. |
void |
setDefaultPropertyAccessor(PropertyAccessor pDefaultPropertyAccessor)
Get the default property accessor. |
void |
setDefinitionFile(atg.xml.XMLFile pDefinitionFile)
Sets the property definitionFile. |
void |
setDocumentLevelOutputProperties(java.lang.String[] pDocumentLevelOutputProperties)
Set the list of output properties that will be added to the document-level item. |
void |
setDocumentSubmitter(DocumentSubmitter pDocumentSubmitter)
Set the document submitter, used to submit documents to the indexing engine. |
void |
setEnableIncrementalLoading(boolean pEnableIncrementalLoading)
Whether to enabled incremental loading. |
void |
setEnableScheduledBulkLoading(boolean pEnableScheduledBulkLoading)
Whether scheduled bulk loading is enabled. |
void |
setEveryItemOutputProperties(java.lang.String[] pEveryItemOutputProperties)
Set the list of output properties that will be added to every repository item. |
void |
setFilterMap(ServiceMap pFilterMap)
Set the filter map. |
void |
setFilterOutDollarOutputPropertyNames(boolean pFilterOutDollarOutputPropertyNames)
Whether to filter out properties containing "$" from the various "outputPropertyName" properties. |
void |
setFormatterMap(ServiceMap pFormatterMap)
Set the formatter map. |
void |
setIncrementalLoader(IncrementalLoader pIncrementalLoader)
Whether to enable to incremental loader at startup. |
void |
setIncrementalUpdateMinutes(int pIncrementalUpdateMinutes)
The number of minutes between incremental updates. |
void |
setIndexingSynchronizations(IndexingSynchronization[] pIndexingSynchronizations)
Set the array of indexing synchronizations. |
void |
setIterationProducer(IterationProducer pIterationProducer)
Set the iteration producer. |
void |
setJobDescription(java.lang.String pJobDescription)
Set property jobDescription |
void |
setJobName(java.lang.String pJobName)
Set property jobName |
void |
setMaxFailuresAllowedForCommitting(int pMaxFailuresAllowedForCommitting)
The maximum number of failures allowed when committing a document submitter session. |
void |
setMaxIncrementalChangesPerGeneration(int pMaxIncrementalChangesPerGeneration)
The maximum number of repository item changes to queue up in a single generation. |
void |
setOnPubServer(boolean pOnPubServer)
set OnPubServer |
void |
setPropertyAccessorMap(ServiceMap pPropertyAccessorMap)
Set propertyAccessorMap... |
void |
setRepository(Repository pRepository)
Optional override of definition file repository specification. |
void |
setRepositoryItemGroup(RepositoryItemGroup pRepositoryItemGroup)
Optional override for definition file repository-item-group component setting. |
void |
setRmiServer(atg.server.rmi.RmiServer pRmiServer)
set RmiServer |
void |
setSchedule(Schedule pSchedule)
Set property schedule |
void |
setScheduler(Scheduler pScheduler)
Set property scheduler . |
void |
setTargetName(java.lang.String pTargetName)
set TargetName |
void |
setThreadMethod(int pThreadMethod)
Set property threadMethod |
void |
setTransactional(boolean pTransactional)
Sets property Transactional |
void |
setUnversionedRepositoryPath(java.lang.String pUnversionedRepositoryPath)
set UnversionedRepositoryPath |
void |
setVariantProducers(VariantProducer[] pVariantProducers)
Set the array of variant producers. |
void |
setVersionedRepositoryPath(java.lang.String pVersionedRepositoryPath)
set VersionedRepositoryPath |
boolean |
shouldCommitSession(Context pContext,
boolean pAtEnd)
Whether the current session should be committed or continued. |
boolean |
shouldIncludeItem(Context pContext,
OutputItemSpecifier pSpecifier,
RepositoryItem pItem)
Whether the specific repository item should be included in the index. |
boolean |
shouldOutputDocument(Context pContext)
Return true to output document, false to discard it. |
protected void |
startScheduledJob()
Just block the startScheduledJob if the bulk scheduler isn't set. |
protected void |
stopScheduledJob()
If we have a job running, stop it. |
protected void |
superStartScheduledJob()
If we have a scheduler and a schedule and we are not already running start our scheduled job. |
void |
updateActivity()
|
void |
warnIfMisconfiguredForSearchAdmin()
Warn if this configuration is misconfigured for SearchAdmin. |
Methods inherited from class java.rmi.server.UnicastRemoteObject |
---|
clone, exportObject, exportObject, exportObject, unexportObject |
Methods inherited from class java.rmi.server.RemoteServer |
---|
getClientHost, getLog, setLog |
Methods inherited from class java.rmi.server.RemoteObject |
---|
equals, hashCode, toString, toStub |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_VERSION
public static java.lang.String[] REQUIRED_DOCUMENT_OUTPUT_PROPERTIES
public static java.lang.String[] REQUIRED_EVERY_ITEM_OUTPUT_PROPERTIES
public static java.lang.ThreadLocal mDocumentSubmitterTL
protected int mJobId
Constructor Detail |
---|
public IndexingOutputConfig() throws java.rmi.RemoteException
java.rmi.RemoteException
Method Detail |
---|
public void setIndexingSynchronizations(IndexingSynchronization[] pIndexingSynchronizations)
public IndexingSynchronization[] getIndexingSynchronizations()
public void setDefinitionFile(atg.xml.XMLFile pDefinitionFile)
pDefinitionFile
- new value to setpublic atg.xml.XMLFile getDefinitionFile()
public Repository getRepository()
getRepositoryItemGroup()
public void setRepository(Repository pRepository)
setRepositoryItemGroup(atg.repository.RepositoryItemGroup)
public void setRepositoryItemGroup(RepositoryItemGroup pRepositoryItemGroup)
setRepository(atg.repository.Repository)
public RepositoryItemGroup getRepositoryItemGroup()
#getRepositoryPathOverride
public void setDefaultPropertyAccessor(PropertyAccessor pDefaultPropertyAccessor)
public PropertyAccessor getDefaultPropertyAccessor()
public void setPropertyAccessorMap(ServiceMap pPropertyAccessorMap)
public ServiceMap getPropertyAccessorMap()
public OutputItemSpecifier getOutputItemSpecifier()
definitionFile
.
public void setBulkLoader(BulkLoader pBulkLoader)
public BulkLoader getBulkLoader()
public void setIncrementalLoader(IncrementalLoader pIncrementalLoader)
public IncrementalLoader getIncrementalLoader()
public void setEnableIncrementalLoading(boolean pEnableIncrementalLoading)
incrementalLoader
should be set.
public boolean isEnableIncrementalLoading()
incrementalLoader
should be set.
public void setDocumentSubmitter(DocumentSubmitter pDocumentSubmitter)
public DocumentSubmitter getDocumentSubmitter()
public void setDocumentLevelOutputProperties(java.lang.String[] pDocumentLevelOutputProperties)
public java.lang.String[] getDocumentLevelOutputProperties()
public void setEveryItemOutputProperties(java.lang.String[] pEveryItemOutputProperties)
public java.lang.String[] getEveryItemOutputProperties()
public java.lang.String[] getRequiredEveryItemOutputProperties()
public void setIncrementalUpdateMinutes(int pIncrementalUpdateMinutes)
public int getIncrementalUpdateMinutes()
public void setBulkLoadWithRetryMinutes(int pBulkLoadWithRetryMinutes)
public int getBulkLoadWithRetryMinutes()
public void setMaxIncrementalChangesPerGeneration(int pMaxIncrementalChangesPerGeneration)
public int getMaxIncrementalChangesPerGeneration()
public void setFormatterMap(ServiceMap pFormatterMap)
PropertyValueFormatter
instance. The name keys
here can be used in the "formatter" attribute of the "property"
in the definition file.
public ServiceMap getFormatterMap()
PropertyValueFormatter
instance. The name keys
here can be used in the "formatter" attribute of the "property"
in the definition file.
public void setFilterMap(ServiceMap pFilterMap)
PropertyValuesFilter
instance. The name keys
here can be used in the "filter" attribute of the "property"
in the definition file.
public ServiceMap getFilterMap()
PropertyValuesFilter
instance. The name keys
here can be used in the "filter" attribute of the "property"
in the definition file.
public void setDefaultFormatter(PropertyFormatter pDefaultFormatter)
public PropertyFormatter getDefaultFormatter()
public void setIterationProducer(IterationProducer pIterationProducer)
public IterationProducer getIterationProducer()
public void setVariantProducers(VariantProducer[] pVariantProducers)
public VariantProducer[] getVariantProducers()
public Repository getTopLevelItemRepository()
public java.lang.String[] getAllOutputPropertyNames()
public java.lang.String[] getTextOutputPropertyNames()
public java.lang.String[] getMetaOutputPropertyNames()
public void setFilterOutDollarOutputPropertyNames(boolean pFilterOutDollarOutputPropertyNames)
public boolean isFilterOutDollarOutputPropertyNames()
public java.lang.String getTextActiveZones()
public void setTargetName(java.lang.String pTargetName)
pTargetName
- the TargetNamepublic java.lang.String getTargetName()
public void setUnversionedRepositoryPath(java.lang.String pUnversionedRepositoryPath)
pUnversionedRepositoryPath
- the UnversionedRepositoryPathpublic java.lang.String getUnversionedRepositoryPath()
public void setVersionedRepositoryPath(java.lang.String pVersionedRepositoryPath)
pVersionedRepositoryPath
- the VersionedRepositoryPathpublic java.lang.String getVersionedRepositoryPath()
public void setOnPubServer(boolean pOnPubServer)
pOnPubServer
- the OnPubServerpublic boolean isOnPubServer()
public void setRmiServer(atg.server.rmi.RmiServer pRmiServer)
pRmiServer
- the RmiServerpublic atg.server.rmi.RmiServer getRmiServer()
public java.lang.String buildUriForRepositoryItem(Context pContext, Repository pRepository, ConfigRepositoryItemChanged pItemChanged) throws IndexingException
IndexingException
public java.lang.String getUriForRepositoryItem(Context pContext, RepositoryItem pItem) throws IndexingException
pItem
- the item
IndexingException
public boolean shouldOutputDocument(Context pContext)
pContext
- the context
public void indexedItem(Context pContext, RepositoryItem pItem)
pContext
- the contextpItem
- the repository itempublic void clearIterationState(Context pContext)
public boolean bulkLoad() throws IndexingException
IndexingException
public boolean bulkLoad(DocumentSubmitterSession pSession) throws IndexingException
IndexingException
public static void getAllOutputItemSpecifiers(java.util.List pResults, OutputItemSpecifier pSpecifier)
pSpecifier
- a specifierpResults
- public java.util.Set getItemDescriptors()
protected void calculateOutputPropertyNames()
protected java.util.List getOutputProperties(java.lang.Boolean pIsMeta)
pIsMeta
- true for meta, false for text, null
for both.protected java.lang.String[] calculateOutputPropertyNames(java.lang.Boolean pIsMeta)
pIsMeta
- true for meta, false for text, null
for both.public void incrementallyLoad()
public boolean processQueuedIncrementalUpdates() throws IndexingException
IndexingException
protected boolean containsString(java.lang.String pString, java.lang.String[] pStrings)
pStrings
contains the specified string pString
.
pString
was found in
the specified string array.public void doStartService() throws ServiceException
doStartService
in class GenericRMIService
ServiceException
- if the Service had a problem starting upprotected void correctRepositoryPath(ItemType pType)
protected void exportAsRemoteService()
protected void addBasicPropertyAccessors()
propertyAccessorMap
. For now, just adds the
firstWithLocale propertya ccessor.
protected void addBasicFormatters()
formatterMap
.
For now, just adds the defaultFormatter
.
protected void addBasicFilters()
filterMap
.
For now, just adds the
UniqueFilter
and
ConcatFilter
filters as "unique" and "concat" respectively.
protected ItemType jaxbParseFile() throws java.io.IOException, atg.xml.XMLFileException, javax.xml.bind.JAXBException
java.io.IOException
atg.xml.XMLFileException
javax.xml.bind.JAXBException
public OutputItemSpecifier[] getDocumentLevelSpecifiers()
protected void addDocumentLevelSpecifiers(OutputItemSpecifier pSpecifier, java.util.List pListFound)
pSpecifier
- the current specifierpListFound
- list of found specifierspublic void performScheduledTask(Scheduler pScheduler, ScheduledJob pJob)
performScheduledTask
in interface Schedulable
pScheduler
- the scheduler managing this jobpJob
- the scheduled job associated with this servicepublic void setScheduler(Scheduler pScheduler)
scheduler
. Use setBulkScheduler
instead of this method.
pScheduler
- new value to setpublic Scheduler getBulkScheduler()
bulkscheduler
. This is the
scheduler used for bulk indexing.
public void setBulkScheduler(Scheduler pBulkScheduler)
bulkScheduler
. This is the
scheduler used for bulk indexing.
pBulkScheduler
- new value to setpublic Schedule getBulkSchedule()
bulkschedule
. This is the
schedule used for bulk indexing.
public void setBulkSchedule(Schedule pBulkSchedule)
bulkSchedule
. This is the
schedule used for bulk indexing.
pBulkSchedule
- new value to setpublic void setBulkScheduleConsiderIndexedMinutes(int pBulkScheduleConsiderIndexedMinutes)
public int getBulkScheduleConsiderIndexedMinutes()
public void setEnableScheduledBulkLoading(boolean pEnableScheduledBulkLoading)
public boolean isEnableScheduledBulkLoading()
public void setMaxFailuresAllowedForCommitting(int pMaxFailuresAllowedForCommitting)
public int getMaxFailuresAllowedForCommitting()
protected void startScheduledJob()
public boolean bulkLoadWithRetry() throws IndexingException
pDocSubSession
- the existing document submitter session.
if null, will create a new document submitter session.
IndexingException
public boolean bulkLoadWithRetry(DocumentSubmitterSession pDocSubSession) throws IndexingException
pDocSubSession
- the existing document submitter session.
if null, will create a new document submitter session.
IndexingException
public void updateActivity() throws IndexingException
IndexingException
public boolean shouldIncludeItem(Context pContext, OutputItemSpecifier pSpecifier, RepositoryItem pItem)
pContext
- the indexing context object.pRepositoryItem
- the repository item that corresponds to this item.pSpecifier
- the specifier for this item.public void afterSessionStart(Context pContext) throws IndexingException
pContext
- the Context for the current indexing operation. The
DocumentSubmitterSession
is available as a property, as is
the IndexingOutputConfig
and other state information.
IndexingException
public void beforeSessionEnd(Context pContext) throws IndexingException
pContext
- the Context for the current indexing operation. The
DocumentSubmitterSession
is available as a property, as is
the IndexingOutputConfig
and other state information.
IndexingException
public boolean allowPeriodicIndexing()
Returns false, if indexing jobs are started externally (as for search admin).
public boolean shouldCommitSession(Context pContext, boolean pAtEnd)
pContext
- the context for the indexing sessionpAtEnd
- whether we are just at end.public boolean bulkLoad(java.lang.String pSubmitterId, java.lang.String pSessionId, java.lang.String pCallbackUrl) throws java.rmi.RemoteException, IndexingException
java.rmi.RemoteException
IndexingException
public boolean processQueuedIncrementalUpdates(java.lang.String pSubmitterId, java.lang.String pSessionId, java.lang.String pCallbackUrl) throws java.rmi.RemoteException, IndexingException
java.rmi.RemoteException
IndexingException
public boolean cancelBulkLoad() throws java.rmi.RemoteException
java.rmi.RemoteException
public boolean cancelIncrementalUpdate() throws java.rmi.RemoteException
java.rmi.RemoteException
public Scheduler getScheduler()
scheduler
scheduler
public void setSchedule(Schedule pSchedule)
schedule
pSchedule
- new value to setpublic Schedule getSchedule()
schedule
schedule
public void setJobName(java.lang.String pJobName)
jobName
pJobName
- new value to setpublic java.lang.String getJobName()
jobName
jobName
public void setJobDescription(java.lang.String pJobDescription)
jobDescription
pJobDescription
- new value to setpublic java.lang.String getJobDescription()
jobDescription
jobDescription
public void setThreadMethod(int pThreadMethod)
threadMethod
pThreadMethod
- new value to setpublic int getThreadMethod()
threadMethod
threadMethod
public void setTransactional(boolean pTransactional)
public boolean isTransactional()
public void doStopService() throws ServiceException
doStopService
in class GenericRMIService
ServiceException
- if an error occurred during the operationprotected void superStartScheduledJob()
protected void stopScheduledJob()
public void warnIfMisconfiguredForSearchAdmin()
public void performAction()
performAction
in interface atg.nucleus.PostStartupAction
public boolean executeSynchronizationsOnly() throws IndexingException
pIndexingOutputConfig
- the output config whose synchronizations
should be executed.
IndexingException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |