public interface IIndexService extends IService
To get an index service follow this example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
IResourceEventReceiver
IResourceEventReceiverBulk
IEventReceiver
IEventReceiverBulk
attachIndexFolderWithoutIndexing(IIndex, IIndexFolder)
createPropertyDistributionList()
createVirtualTaxonomy(String, IResourceContext)
detachIndexFolder(IIndex, IIndexFolder, boolean)
getConfigServiceUserUME()
getVirtualTaxImporter()
invalidateIndexesCache()
isVirtualTaxRid(RID)
startXIndexCrawler(IIndex, IResource, String[])
IIndex
,
IWcmIndexConst
Modifier and Type | Field and Description |
---|---|
static boolean |
ACTIVATE_SIEMENS |
static String |
CM_INDEXSERVICE_NS |
static boolean |
NEW_CRAWLER_FLAG |
static boolean |
NEW_CRAWLER_FLAG_TODO_1 |
static String |
SERVICE_CLASS
Class property of an index implementation.
|
static String |
SERVICE_NAME
Display name property of an index implementation.
|
static boolean |
TEST_NIRVANA_FLAG |
static boolean |
VIRTUAL_TAXONOMIES |
Modifier and Type | Method and Description |
---|---|
void |
attachIndexFolder(IIndex index,
IIndexFolder indexfolder)
Attaches an index folder to an index.
|
void |
attachIndexFolderWithoutIndexing(IIndex index,
IIndexFolder indexFolder)
Attaches an index folder to an index but does not start indexing the resources below.
|
void |
attachIndexToRepository(IIndex index,
IResource folder)
Attaches an index to a folder in a repository.
|
ICompareTaxonomies |
createCompareTaxonomies()
This method is only used by internal methods and should not be used programmers
using the index management API.
|
ISchedulerTask |
createDeltaIndexSchedulerTask()
Returns a task for a delta index schedule.
|
String |
createEmptySchedulerEntryId(String indexId)
Returns an identifier for a delta index schedule for the index.
|
IIndex |
createIndex(String indexId,
String indexName,
String indexGroup,
String serviceId)
Creates an index object.
|
String |
createIndexSchedulerEntryId(String indexId,
RID indexFolderRid)
Returns an identifier for a delta index schedule for an folder, which if defined
by the according schedule of the index.
|
IPropertyDistributionList |
createPropertyDistributionList()
Creates an empty IPropertyDistributionList
|
String |
createSchedulerEntryId(String indexId,
RID indexFolderRid)
Returns an identifier for a delta index schedule for an folder, which if not defined
by the according schedule of the index.
|
ITaxonomyTransport |
createTaxonomyTransport()
This method is only used by internal methods and should not be used programmers
using the index management API.
|
String |
createVirtualTaxonomy(String dataString,
IResourceContext context)
Create a virtual taxonomy according to the XML specification of the parameter dataString.
|
void |
deleteCrawlers(List crawlers)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
deleteIndex(IIndex index)
Deprecated.
as of NW04. Use deleteIndex(IIndex,IResourceContext)
ATTENTION: Using this signature instead of the one with a resource context for a classification index can lead to problems. If ACLs are used for the taxonomy repository, no folder can be deleted by this method because the service user context that is used only has read permission. |
void |
deleteIndex(IIndex index,
IResourceContext context)
Deletes an index.
|
void |
detachIndexFolder(IIndex index,
IIndexFolder indexFolder)
Detaches an index folder from an index.
|
void |
detachIndexFolder(IIndex index,
IIndexFolder indexFolder,
boolean removeDocuments)
Only for internal usage
|
void |
detachIndexFromRepository(IIndex index,
IResource folder)
Detaches an index from a folder in a repository.
|
List |
getActiveIndexes()
Returns all existing indexes in the system which are active.
|
List |
getActiveIndexmanagementCrawlers(IIndex index)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
List |
getAllIndexmanagementCrawlers(IIndex index) |
Class |
getClass(String className)
only for internal usage
|
IUser |
getConfigServiceUserUME()
This method is only used by internal methods and should not be used programmers
using the index management API.
|
List |
getFailedCrawlers(IIndex index) |
IIndex |
getIndex(String indexId)
Returns the specified index.
|
IPropertyMap |
getIndexedProperties()
Determines all properties indexed in at least one of the indexes maintained by
the index service.
|
IPropertyMap |
getIndexedProperties(IResourceContext resourceContext)
Determines all properties indexed in at least one of the indexes maintained by
the index service and for which read access for the resource context is allowed.
|
IPropertyMap |
getIndexedProperties(List indexes)
Determines all properties indexed in at least one of the indexes.
|
IPropertyMap |
getIndexedProperties(List indexes,
IResourceContext resourceContext)
Determines all properties indexed in at least one of the indexes
and for which read access for the resource context is allowed.
|
List |
getIndexes()
Returns all existing indexes in the system.
|
List |
getIndexes(IRepositoryManager repositoryManager)
Returns all indexes into which documents of a repository are indexed.
|
List |
getIndexes(RID topFolderRid)
Indexes that contain documents of the folder specified by
topFolderRid
or any sub-folder |
List |
getIndexes(URI topFolderURI)
Deprecated.
as of NW04. Use getIndexes(RID)
|
List |
getIndexesForResource(IResource resource)
TReturns the indexes into which a document is indexed.
|
List |
getIndexesForResource(RID rid)
Returns the indexes into which a document is indexed.
|
List |
getIndexesForResource(URI uri)
Deprecated.
as of NW04. Use getIndexesForResource(RID)
|
IIndex |
getIndexForResource(IResource resource,
String serviceType)
Returns the index in which the document is indexed depending on the specified service type.
|
IIndex |
getIndexForResource(RID rid,
String serviceType)
Returns the index into which the document is indexed depending on the specified service type.
|
IIndex |
getIndexForResource(URI uri,
String serviceType)
Deprecated.
as of NW04. Use getIndexForResource(RID,String)
|
List |
getIndexGroups()
Returns the index groups defined.
|
RID |
getIndexmanagementRepositoryPrefixRID()
Gets the resource ID of the root folder of the index management repository.
|
IResourceContext |
getIndexServiceUserContext() |
Set |
getLanguagesOfIndexedDocuments(List indexes)
The methods get as parameter a list of index IDs.
|
int |
getMaxTransferSize() |
Object |
getObjectInstance(String objectInstanceName)
Gets an instance of an object specified by an
IWcmIndexConst constant. |
Properties |
getProperties(IIndex index)
only for internal usage
|
ISchedulerTimeTable |
getSchedulerTimeTable(String indexId)
Returns the timetable of a schedule for delta index crawling for the index.
|
List |
getServiceIds()
Returns the available service IDs.
|
Properties |
getServiceProperties(String serviceId)
Gets the properties of an index implementation.
|
String |
getServiceUserId()
Returns the ID of the index management service user.
|
ITaskQueueHandler |
getTaskQueueHandler()
Returns the task queue handler of the index management service.
|
IVirtualTaxImporter |
getVirtualTaxImporter()
Only for internal usage.
|
Map |
groupIndexesByService(List indexes)
When given a list of index objects, it returns a map that contains the service IDs
as keys and a list of indexes for each service as values.
|
void |
internalSaveIndex(IIndex index)
Saves a newly created index object inside the index service.
|
void |
invalidateIndexesCache()
only for internal usage
|
boolean |
isDeleteAllowed(IResourceContext context,
IIndex index)
Checks the delete permission of a user for an index.
|
List |
isDeleteAllowed(IResourceContext context,
List indexes)
Checks the delete permission of a user for a list of indexes.
|
boolean |
isReadAllowed(IResourceContext context,
IIndex index)
Checks the read access permission of a user for an index.
|
List |
isReadAllowed(IResourceContext context,
List indexes)
Checks the read access permission of a user for a list of indexes.
|
boolean |
isReadAllowedFast(IResourceContext context,
IIndex index)
Checks the read access permission of a user for an index but does not if the index is currently deleted.
|
boolean |
isVirtualTaxRid(RID rid)
Checks if the rid start with the path for the dynamic taxonomies (/taxonomies/Virtual_Taxonomies)
|
boolean |
isWriteAllowed(IResourceContext context,
IIndex index)
Checks the write access permission of a user for an index.
|
List |
isWriteAllowed(IResourceContext context,
List indexes)
Checks the write access permission of a user for a list of indexes.
|
void |
queueDeltaIndexCrawler(IIndexFolder indexFolder)
Puts a delta index crawl into the index management crawler queue.
|
void |
queueIndexCrawler(IIndexFolder indexFolder)
Puts an index crawl into the index management crawler queue.
|
void |
resumeCrawlers(List crawlers)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
setMaxTransferSize(int i)
Sets the defined size in byte, up to which content is send directly to the
index server, when indexing documents.
|
void |
setProperties(IIndex index,
Properties indexProperties)
only for internal usage
|
void |
setSchedulerTimeTable(String indexId,
ISchedulerTimeTable schedulerTimeTable)
Registers a schedule for delta index crawling for the index with the
ISchedulerTimeTable . |
void |
startResourceIndexer(IResource document,
AbstractClassificationIndex index)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
startXIndexCrawler(IIndex index,
IResource startResource,
String[] parameter)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
startXTaxRetrainCrawler(IIndex index,
String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
stopCrawlers(List crawlers)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
suspendCrawlers(List crawlers)
This method is only used by internal methods and should not be used programmers
using the index management API.
|
void |
updateIndex(IIndex index)
Saves all changes that have been made to the index object.
|
getDescription, getDescription, getID
static final boolean ACTIVATE_SIEMENS
static final boolean VIRTUAL_TAXONOMIES
static final boolean TEST_NIRVANA_FLAG
static final boolean NEW_CRAWLER_FLAG
static final boolean NEW_CRAWLER_FLAG_TODO_1
static final String CM_INDEXSERVICE_NS
static final String SERVICE_CLASS
class
and the display name
can be requested by calling the getServiceProperties(String serviceId)
method
of this interface. It returns a property bag with the two properties.class
property of the
index implementation.
Example:
Properties properties = indexService.getServiceProperties("trexSearch"); String class = properties.getProperty(IIndexService.SERVICE_CLASS);
static final String SERVICE_NAME
class
and the display name
can be requested by calling the getServiceProperties(String serviceId)
method
of this interface. It returns a property bag with the two properties.display name
property of the index implementation.
Example:
Properties properties = indexService.getServiceProperties("trexSearch"); String class = properties.getProperty(IIndexService.SERVICE_NAME);
void deleteIndex(IIndex index) throws WcmException
index
- object of type IIndexWcmException
- exception raised in failure situationIIndex createIndex(String indexId, String indexName, String indexGroup, String serviceId) throws WcmException
generate(IResourceContext context)
must be performed on the index object.init
method of the IIndex
interface.
Example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.createIndex("abc","abc index","abc group","trexSearch"); Properties properties = new Properties(); properties.setProperty("fuzziness","0.8"); index.init(properties); index.generate(context);
indexId
- identifier/name of the indexindexName
- display name of the indexindexGroup
- group name to group indexes, examples: Internal Sources, Internet SourcesserviceId
- ID that has been specified for the index implementation in cm configurationIIndex
WcmException
- exception raised in failure situationvoid deleteIndex(IIndex index, IResourceContext context) throws WcmException
String indexId = "abc"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); indexService.deleteIndex(index,context);
index
- object of type IIndexcontext
- user contextWcmException
- exception raised in failure situationvoid attachIndexToRepository(IIndex index, IResource folder) throws WcmException
index
- index that has to be attachedfolder
- folder to which the index should be attachedWcmException
- exception raised in failure situationvoid attachIndexFolder(IIndex index, IIndexFolder indexfolder) throws WcmException
String indexId = "abc"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); IIndexFolder indexFolder = new IndexFolder(indexId,RID.getRID("/abcRm/subfolder")); indexService.attachIndexFolder(index,indexFolder);
index
- index to that the index folder has to be attachedindexfolder
- index folder to attach to the indexWcmException
- exception raised in failure situationvoid attachIndexFolderWithoutIndexing(IIndex index, IIndexFolder indexFolder) throws WcmException
String indexId = "abc"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); IIndexFolder indexFolder = new IndexFolder(indexId,RID.getRID("/abcRm/subfolder")); indexService.attachIndexFolderWithoutIndexing(index,indexFolder);
index
- index to that the index folder has to be attachedindexFolder
- index folder to attach to the indexWcmException
- exception raised in failure situationvoid detachIndexFromRepository(IIndex index, IResource folder) throws WcmException
index
- index that has to be detached from the folderfolder
- folder from which the index is to be detachedWcmException
- exception raised in failure situationvoid detachIndexFolder(IIndex index, IIndexFolder indexFolder) throws WcmException
String indexId = "abc"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); IIndexFolder indexFolder = index.getIndexFolders().get(RID.getRID("/abcRm/subfolder")); indexService.detachIndexFolder(index,indexFolder);
index
- index from which the index folder has to be detachedindexFolder
- index folder to detach from the indexWcmException
- exception raised in failure situationvoid detachIndexFolder(IIndex index, IIndexFolder indexFolder, boolean removeDocuments) throws WcmException
index
- indexindexFolder
- indexFolderremoveDocuments
- removeDocumentsWcmException
- WcmExceptionList getIndexes()
IIndex
)List getIndexes(IRepositoryManager repositoryManager)
repositoryManager
- repository for which the indexes have to be returnedIIndex
)
containing documents of the repositoryList getIndexes(URI topFolderURI)
topFolderURI
- URI of the top folder of a sub hierarchyIPropertyMap getIndexedProperties() throws WcmException
WcmException
- exception raised in failure situationIPropertyMap getIndexedProperties(IResourceContext resourceContext) throws WcmException
resourceContext
- resourceContextWcmException
- exception raised in failure situationIPropertyMap getIndexedProperties(List indexes) throws WcmException
indexes
- indexesWcmException
- exception raised in failure situationIPropertyMap getIndexedProperties(List indexes, IResourceContext resourceContext) throws WcmException
indexes
- indexesresourceContext
- resourceContextWcmException
- exception raised in failure situationList getIndexes(RID topFolderRid)
topFolderRid
or any sub-foldertopFolderRid
- resource ID of the top folder in a folder hierarchyIIndex
) to which the specified folder
or a sub-folder is attachedIIndex getIndex(String indexId) throws WcmException
IClassificationIndex
).
Example:
String indexId = "abcclassification"; IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex(indexId); IClassificationIndex classificationIndex = null; if (index instanceof IClassificationIndex) classificationIndex = (IClassificationIndex)index;
indexId
- ID of the indexWcmException
- exception raised in failure situationWcmException
is
thrown.IIndex getIndexForResource(IResource resource, String serviceType) throws ResourceException
IWcmIndexConst
contains constants for existing service types
Example:IResource resource = ResourceFactory.getInstance().getResource(RID.getRID("/documents/mydocs/a.txt"),context); IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndexForResource(resource,IWcmIndexConst.SERVICE_TYPE_SEARCH);
If no index of the specified service type contains the resource, null
is returned.
resource
- folder or document for which the index has to be determinedserviceType
- use com.sapportals.wcm.service.indexmanagement.IWcmIndexConst service typesResourceException
- exception raised in failure situationIIndex getIndexForResource(URI uri, String serviceType)
serviceType
- use com.sapportals.wcm.service.indexmanagement.IWcmIndexConst service typesuri
- URI of the resource for which the index has to be determinedIIndex getIndexForResource(RID rid, String serviceType)
IWcmIndexConst
contains constants for existing service types
Example:IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndexForResource(RID.getRID("/documents/mydocs/a.txt"),IWcmIndexConst.SERVICE_TYPE_SEARCH);
If no index of the specified service type contains the resource, null
is returned.
serviceType
- use com.sapportals.wcm.service.indexmanagement.IWcmIndexConst service typesrid
- resource ID of the resource for which the index has to be determinedList getIndexesForResource(IResource resource) throws ResourceException
IResource resource = ResourceFactory.getInstance().getResource(RID.getRID("/documents/mydocs/a.txt"),context); IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); List indexes = indexService.getIndexesForResource(resource);
If no index contains the resource, an empty List
is returned.
resource
- folder or the document for which the indexes have to be determinedIIndex
) into which the document is indexedResourceException
- exception raised in failure situationList getIndexesForResource(URI uri)
uri
- the URI of the folder or the document for which the indexes have to be determinedList getIndexesForResource(RID rid)
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); List indexes = indexService.getIndexesForResource(RID.getRID("/documents/mydocs/a.txt"));If no index contains the resource, an empty
List
is returned.rid
- resource ID of the folder or the document for which the indexes have to be determinedIIndex
) into which the document is indexedList getIndexGroups()
String
used in the existing indexesList getServiceIds()
serviceId
is an identifier.String
) of all index servicesProperties getServiceProperties(String serviceId) throws WcmException
display name
and the class
are returned for each
implementation. The constants
SERVICE_NAME
and SERVICE_CLASS
can be used as keys for getting a property from the returned property map.
Example:IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); Properties properties = indexService.getServiceProperties("trexSearch"); //returns "Trex Search" String displayName = properties.getProperty(IIndexService.SERVICE_NAME); //returns "com.sapportals.wcm.service.indexmanagement.retrieval.trex.TrexSearch" String class = properties.getProperty(IIndexService.SERVICE_CLASS);
serviceId
- ID of the index implementation, for example, "trexSearch"WcmException
- exception raised in failure situationSet getLanguagesOfIndexedDocuments(List indexes) throws WcmException
indexes
- List of indexesWcmException
- Exception raised in failure situationvoid updateIndex(IIndex index) throws ResourceException
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex("abc"); index.setIndexName("abc index"); indexService.updateIndex(index);
index
- index that has to be updated persistentlyResourceException
- exception raised in failure situationvoid internalSaveIndex(IIndex index) throws WcmException
.generate()
method.
In that way the configuration is only made persistent when the index could be created by the
index implementation successfully.
Don't use this method for other purposes.index
- index to saveWcmException
- WcmExceptionMap groupIndexesByService(List indexes)
indexes
- list of indexes (IIndex
) that have to be groupedMap
with serviceIds as keys (String
) and their
corresponding indexes in a list as values (IIndex
)Object getObjectInstance(String objectInstanceName) throws WcmException
IWcmIndexConst
constant. IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IFederatedSearch federatedSearch = (IFederatedSearch)indexService.getObjectInstance(IWcmIndexConst.FEDERATED_SEARCH_INSTANCE);
objectInstanceName
- ID for the kind of objectWcmException
- exception raised in failure situationString getServiceUserId()
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); String serviceUserId = indexService.getServiceUserId(); IResourceContext serviceContext = ResourceFactory.getInstance().getServiceContextUME(serviceUserId);Note: The user must be configured in user management as a service user.
IResourceContext getIndexServiceUserContext() throws WcmException
WcmException
- WcmExceptionvoid queueDeltaIndexCrawler(IIndexFolder indexFolder) throws WcmException
maxrunningcrawlers
.
Example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex("abc"); //"/documents" must be an index folder of the index "abc". IIndexFolder indexFolder = index.getIndexFolders().get(RID.getRID("/documents")); indexService.queueDeltaIndexCrawler(indexFolder); indexService.runQueuedCrawlers();
indexFolder
- index folder that has to be crawledWcmException
- exception raised in failure situationvoid queueIndexCrawler(IIndexFolder indexFolder) throws WcmException
maxrunningcrawlers
.
Example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IIndex index = indexService.getIndex("abc"); //"/documents" must be an index folder of the index "abc". IIndexFolder indexFolder = index.getIndexFolders().get(RID.getRID("/documents")); indexService.queueIndexCrawler(indexFolder); indexService.runQueuedCrawlers();
indexFolder
- index folder that has to be crawledWcmException
- exception raised in failure situationITaskQueueHandler getTaskQueueHandler() throws WcmException
WcmException
- WcmExceptionvoid setSchedulerTimeTable(String indexId, ISchedulerTimeTable schedulerTimeTable) throws WcmException
ISchedulerTimeTable
. Thereby it sets this schedule for all
data sources with no own schedule.indexId
- String
ID for index.schedulerTimeTable
- ISchedulerTimeTable
WcmException
- in case of an error.ISchedulerTimeTable getSchedulerTimeTable(String indexId) throws WcmException
indexId
- String
ID of the index.WcmException
- in case of an error.String createIndexSchedulerEntryId(String indexId, RID indexFolderRid) throws WcmException
indexId
- String
ID of the index.indexFolderRid
- RID
WcmException
- in case of an error.String createSchedulerEntryId(String indexId, RID indexFolderRid) throws WcmException
indexId
- String
ID of the index.indexFolderRid
- RID
WcmException
- in case of an error.String createEmptySchedulerEntryId(String indexId) throws WcmException
indexId
- String
ID of the index.WcmException
- in case of an error.ISchedulerTask createDeltaIndexSchedulerTask()
RID getIndexmanagementRepositoryPrefixRID() throws WcmException
WcmException
- in case of an errorList getActiveIndexes() throws WcmException
IIndex
)WcmException
- in case of an errorboolean isReadAllowed(IResourceContext context, IIndex index) throws WcmException
context
- user contextindex
- index that is checkedWcmException
- in case of an errorboolean isReadAllowedFast(IResourceContext context, IIndex index) throws WcmException
context
- user contextindex
- index that is checkedWcmException
- in case of an errorList isReadAllowed(IResourceContext context, List indexes) throws WcmException
context
- user contextindexes
- indexes that are checkedWcmException
- in case of an errorboolean isWriteAllowed(IResourceContext context, IIndex index) throws WcmException
context
- user contextindex
- index that is checkedWcmException
- in case of an errorList isWriteAllowed(IResourceContext context, List indexes) throws WcmException
context
- user contextindexes
- indexes that are checkedWcmException
- in case of an errorboolean isDeleteAllowed(IResourceContext context, IIndex index) throws WcmException
context
- user contextindex
- index that is checkedWcmException
- in case of an errorList isDeleteAllowed(IResourceContext context, List indexes) throws WcmException
context
- user contextindexes
- indexes that are checkedWcmException
- in case of an errorint getMaxTransferSize()
void setMaxTransferSize(int i)
i
- the max transfter sizevoid startXIndexCrawler(IIndex index, IResource startResource, String[] parameter) throws WcmException
index
- indexstartResource
- startResourceparameter
- parameterWcmException
- WcmExceptionvoid startXTaxRetrainCrawler(IIndex index, String taxonomyName, ICollection taxonomyCollection, boolean isSearchRelevant) throws ResourceException, WcmException
index
- indextaxonomyName
- taxonomyNametaxonomyCollection
- taxonomyCollectionisSearchRelevant
- isSearchRelevantResourceException
- ResourceExceptionWcmException
- WcmExceptionIUser getConfigServiceUserUME() throws Exception
Exception
- Exceptionvoid startResourceIndexer(IResource document, AbstractClassificationIndex index) throws WcmException
document
- documentindex
- indexWcmException
- WcmExceptionList getActiveIndexmanagementCrawlers(IIndex index) throws WcmException
index
- indexWcmException
- WcmExceptionvoid deleteCrawlers(List crawlers) throws WcmException
crawlers
- crawlersWcmException
- WcmExceptionvoid stopCrawlers(List crawlers) throws WcmException
crawlers
- crawlersWcmException
- WcmExceptionvoid suspendCrawlers(List crawlers) throws WcmException
crawlers
- crawlersWcmException
- WcmExceptionvoid resumeCrawlers(List crawlers) throws WcmException
crawlers
- crawlersWcmException
- WcmExceptionITaxonomyTransport createTaxonomyTransport() throws ResourceException, PropertyConfigurationServiceException
ResourceException
- ResourceExceptionPropertyConfigurationServiceException
- PropertyConfigurationServiceExceptionICompareTaxonomies createCompareTaxonomies()
List getAllIndexmanagementCrawlers(IIndex index) throws ResourceException, XCrawlerException
index
- the indexResourceException
- ResourceExceptionXCrawlerException
- XCrawlerExceptionList getFailedCrawlers(IIndex index) throws ResourceException, XCrawlerException
index
- indexResourceException
- ResourceExceptionXCrawlerException
- XCrawlerExceptionString createVirtualTaxonomy(String dataString, IResourceContext context) throws WcmException
dataString
- dataStringcontext
- contextWcmException
- WcmExceptionboolean isVirtualTaxRid(RID rid)
rid
- ridIPropertyDistributionList createPropertyDistributionList()
IVirtualTaxImporter getVirtualTaxImporter()
void setProperties(IIndex index, Properties indexProperties)
index
- indexindexProperties
- indexPropertiesProperties getProperties(IIndex index)
index
- indexClass getClass(String className)
className
- classNamevoid invalidateIndexesCache()
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice